Enhance Elytra Essentials: Custom Events & Speed Control

by SLV Team 57 views
Enhance Elytra Essentials: Custom Events & Speed Control

Hey there, fellow Minecraft enthusiasts! Ever wanted to supercharge your Elytra experience? Let's dive into some awesome enhancements, including custom events for forging, splitting, equipping, and unequipping armored Elytra, along with a cool feature for adjustable speed and drag. I'm going to walk you through the specifics, providing insights and potential solutions. Get ready to level up your Elytra game!

Custom Events for Enhanced Control

Firstly, let's talk about those custom events. The goal is to provide more flexibility and control over how players interact with armored Elytra. Think of it like this: every time a player forges (combines), splits, equips, or unequips an armored Elytra, a custom event is triggered. This allows you, the server owner or developer, to tap into these actions and modify them.

Here’s a breakdown:

  • ArmoredElytraEquipEvent: This event is triggered when a player equips an armored Elytra. This event provides the player, the armored Elytra item, the standard Elytra, and the chestplate involved. The event gives access to the old and new item slots. Perfect for any modifications before or after equipping.
  • ArmoredElytraForgedEvent: This event is triggered when a player forges or splits an armored Elytra. Similar to the equip event, it gives you the player, the armored Elytra, the standard Elytra, and the chestplate involved. It also includes a boolean to identify if the event is for forging or splitting. Great for adding custom features upon the forge or split.

Benefits of Custom Events

These custom events provide some serious benefits:

  • Modify Items: You can change item attributes, add enchantments, or modify item data before the action is complete.
  • Custom Effects: Trigger particles, sounds, or other effects when an event occurs.
  • Data Tracking: Log actions, track item usage, or create custom statistics.
  • Enhanced Gameplay: Tailor the Elytra experience to your server's needs.

Potential Implementation

Here's how you might implement these events:

  1. Event Creation: Create the custom events as shown in the provided code snippets: ArmoredElytraEquipEvent and ArmoredElytraForgedEvent. These are crucial for handling player actions.
  2. Event Handling: Register event listeners in your plugin to listen for these events. The listener would then perform actions based on the event (e.g., modifying item data).
  3. Event Triggering: Within your existing Elytra logic, trigger these events at the appropriate times.
// Example of triggering the event when equipping
ArmoredElytraEquipEvent equipEvent = new ArmoredElytraEquipEvent(player, armoredElytra, elytra, chestplate, armoredElytraSlot, armoredElytraSlotPrev);
Bukkit.getPluginManager().callEvent(equipEvent);

if (!equipEvent.isCancelled()) {
    // Equip the item if the event isn't cancelled
    player.getInventory().setChestplate(armoredElytra);
}

// Example of triggering the event when forging
ArmoredElytraForgedEvent forgeEvent = new ArmoredElytraForgedEvent(player, armoredElytra, elytra, chestplate, isForging);
Bukkit.getPluginManager().callEvent(forgeEvent);

if (!forgeEvent.isCancelled()) {
    // Proceed with the forge/split if the event isn't cancelled
    // ... your forging/splitting logic here ...
}

Adjustable Speed Cap/Drag with Shift

Now, let's add an option to adjust the speed cap and add drag, but only when the player is holding shift. This gives the player more control over their gliding experience.

How it Works

This feature works using a combination of events and data manipulation. The primary interaction is with the scroll wheel on the mouse when the player is gliding and holding shift. The scroll wheel will then control speed. It will also calculate drag based on the horizontal and vertical multipliers.

Key Components

  1. Velocity Multiplier Manager: This class (VelocityMultiplierManager) is responsible for managing the speed multipliers for each player. It stores horizontal and vertical multipliers using Persistent Data Containers (PDC) on the player's data. This enables the server to store player-specific glide multipliers.
  2. GlideScrollMultiplierHandler: This is the heart of the speed adjustment feature. The GlideScrollMultiplierHandler listens for PlayerItemHeldEvent and checks if the player is gliding, holding shift, and has an armored Elytra equipped. It uses the scroll wheel to adjust the horizontal and vertical multipliers. The handler is where the speed control magic happens. It listens for the PlayerItemHeldEvent when the player scrolls their mouse wheel. It checks if the player is gliding and holding shift. Based on the scroll direction (up or down), it increases or decreases the horizontal and vertical multipliers. It also provides visual feedback through an action bar message showing the current multipliers.
  3. ArmoredElytraHelper: The ArmoredElytraHelper class contains helper methods to check if an item is an armored Elytra.
  4. MessagesHelper: The MessagesHelper class is used to send action bar messages to the player, which is the feedback mechanism.

Implementation Details

  • Scrolling for Speed: When the player scrolls while gliding and holding shift, the handler will get the scroll direction (up or down) and increment or decrement the speed multipliers accordingly. The implementation uses the player's hotbar slot change to determine the scroll direction.
  • Persistent Data: The plugin uses Persistent Data Containers (PDC) to store the horizontal and vertical multipliers. This ensures that the multipliers are saved and loaded correctly for each player.
  • Speed Limits: The speed multipliers are capped to provide a smooth, enjoyable gliding experience.
  • Visual Feedback: The plugin uses action bar messages to show the current multipliers while scrolling.

Code Snippets & Examples

Here are some code snippets that bring this idea to life:

// In GlideScrollMultiplierHandler, determine scroll direction and adjust multipliers
boolean scrollUp = newSlot < oldSlot || (oldSlot == 8 && newSlot == 0);
boolean scrollDown = newSlot > oldSlot || (oldSlot == 0 && newSlot == 8);

// Get current multipliers
VelocityMultiplierManager.PlayerMultiplier multipliers = velocityMultiplierManager.getMultipliers(player);

// Increment/decrement based on scroll
if (scrollUp) {
    multipliers.horizontal += multiplierStep;
    multipliers.vertical += multiplierStep;
} else if (scrollDown) {
    multipliers.horizontal = Math.max(0, multipliers.horizontal - multiplierStep);
    multipliers.vertical = Math.max(0, multipliers.vertical - multiplierStep);
}

// Save updated multipliers in PDC
velocityMultiplierManager.setMultipliers(player, multipliers.horizontal, multipliers.vertical);

PDC Injection and Removal

Finally, let's explore the concept of injecting and removing Persistent Data Containers (PDC) on items. PDC allows you to store custom data directly on items, providing a powerful way to add custom features. With this functionality, you can seamlessly integrate custom data into your items. This includes adding new attributes or modifications to existing ones.

Key Methods

The provided API includes the following methods for managing PDC:

  • setCustomPdc(UUID playerUUID, String armorSlot, String key, String value): This method allows you to store a custom PDC value on either the armored Elytra or chestplate. It uses a plugin-specific namespace to avoid conflicts and stores the data as a string.
  • getCustomPdc(UUID playerUUID, String armorSlot, String key): This method retrieves the stored PDC value. It returns null if the key doesn’t exist.

How to Use PDC

  1. Storing Data: Use setCustomPdc to store your data. Specify the player's UUID, the armor slot (chestplate or elytra), a unique key, and the serialized value (as a string).
  2. Retrieving Data: Use getCustomPdc to retrieve the data. Specify the player's UUID, the armor slot, and the key.
  3. Data Serialization: Serialize your data to a string before storing it (e.g., using Gson). Deserialize it when retrieving it.

Example

// Storing custom data (e.g., item level)
String itemLevel = String.valueOf(item.getLevel());
elytraEssentialsAPI.setCustomPdc(player.getUniqueId(), "elytra", "item_level", itemLevel);

// Retrieving the data
String storedLevel = elytraEssentialsAPI.getCustomPdc(player.getUniqueId(), "elytra", "item_level");
if (storedLevel != null) {
    int level = Integer.parseInt(storedLevel);
    // Use the level value
}

Enhancements for Improved Player Experience

By adding custom events and the ability to control speed, you can create a more engaging and user-friendly experience for players. Here are some of the enhancements:

  • Custom Attributes: Adjust item attributes to create different tiers of armor and items. Add effects or attributes to the Elytra and chestplate.
  • Enhanced Forging: Make the forging and splitting process more interactive by adding custom items or animations.
  • User Control: Players can use shift and scroll to customize their gliding speed.
  • Personalized Experience: Players can set their preferred speed through settings, enhancing overall player satisfaction.

Conclusion

So, guys, that's the lowdown on adding custom events and adjustable speed controls to your Elytra experience. By integrating these features, you can take your server to the next level. Let me know what you think, and if you have any questions, hit me up! Happy coding!