+ * Access via IPlayerData.getAbilityData() + */ +public interface IPlayerAbilityData { + + /** + * Get all unlocked ability keys. + */ + String[] getUnlockedAbilities(); + + /** + * Unlock an ability for this player. + * + * @param key The ability key (built-in name or custom UUID) + */ + void unlockAbility(String key); + + /** + * Lock (remove) an ability from this player. + */ + void lockAbility(String key); + + /** + * Check if the player has unlocked a specific ability. + */ + boolean hasUnlockedAbility(String key); + + /** + * Get the currently selected ability index. + */ + int getSelectedIndex(); + + /** + * Set the selected ability index. + */ + void setSelectedIndex(int index); + + /** + * Get the key of the currently selected ability. + */ + String getSelectedAbilityKey(); + + /** + * Select the next ability in the list. + */ + void selectNext(); + + /** + * Select the previous ability in the list. + */ + void selectPrevious(); + + /** + * Check if the player is currently executing an ability. + */ + boolean isExecutingAbility(); + + /** + * Get the currently executing ability. + */ + IAbility getCurrentAbility(); + + /** + * Interrupt the currently executing ability. + */ + void interruptCurrentAbility(); + + /** + * Check if the player is on universal cooldown. + */ + boolean isOnCooldown(); + + /** + * Check if a specific ability is on cooldown. + * + * @param key The ability key + * @return true if on cooldown + */ + boolean isOnCooldown(String key); + + /** + * Reset the universal cooldown. + */ + void resetCooldown(); + + /** + * Reset cooldown for a specific ability key. + * + * @param key The ability key + */ + void resetCooldown(String key); + + /** + * Reset all cooldowns. + */ + void resetAllCooldowns(); + + /** + * Activate the currently selected ability. + */ + boolean activateAbility(); + + /** + * Activate a specific ability by key. + */ + boolean activateAbility(String key); +} diff --git a/java/noppes/npcs/api/event/IPlayerAbilityEvent.java b/java/noppes/npcs/api/event/IPlayerAbilityEvent.java new file mode 100644 index 0000000..621e217 --- /dev/null +++ b/java/noppes/npcs/api/event/IPlayerAbilityEvent.java @@ -0,0 +1,64 @@ +package noppes.npcs.api.event; + +import cpw.mods.fml.common.eventhandler.Cancelable; +import noppes.npcs.api.ability.IAbility; +import noppes.npcs.api.entity.IEntityLivingBase; + +/** + * Events related to player ability execution. + * These events are fired during the ability lifecycle when a player uses an ability. + */ +public interface IPlayerAbilityEvent extends IPlayerEvent { + + /** + * Get the ability involved in this event. + */ + IAbility getAbility(); + + /** + * Get the target of the ability, or null if no target. + */ + IEntityLivingBase getTarget(); + + /** + * Fired when a player's ability hits an entity with damage. + * Canceling this event prevents the damage from being applied. + */ + @Cancelable + interface HitEvent extends IPlayerAbilityEvent { + /** + * Get the entity that was hit by the ability. + */ + IEntityLivingBase getHitEntity(); + + /** + * Get the damage amount. + */ + float getDamage(); + + /** + * Set the damage amount. Allows scripts to modify damage. + */ + void setDamage(float damage); + + /** + * Get the horizontal knockback amount. + */ + float getKnockback(); + + /** + * Set the horizontal knockback amount. + */ + void setKnockback(float knockback); + + /** + * Get the vertical knockback (upward force) amount. + */ + float getKnockbackUp(); + + /** + * Set the vertical knockback (upward force) amount. + */ + void setKnockbackUp(float knockbackUp); + } +} diff --git a/java/noppes/npcs/api/handler/IAbilityHandler.java b/java/noppes/npcs/api/handler/IAbilityHandler.java index f6e8670..5700b2b 100644 --- a/java/noppes/npcs/api/handler/IAbilityHandler.java +++ b/java/noppes/npcs/api/handler/IAbilityHandler.java @@ -1,8 +1,8 @@ package noppes.npcs.api.handler; /** - * Handler for ability presets. Allows scripts to save, load, and manage - * reusable ability templates. + * Handler for ability management. Allows scripts to query ability types, + * built-in abilities, and custom ability presets. *
* Access via API.getAbilities() */ @@ -10,40 +10,38 @@ public interface IAbilityHandler { /** * Get all registered ability type IDs. - * These are the types that can be used to create new abilities. - * - * @return Array of type IDs (e.g., "cnpc:slam", "cnpc:charge") */ String[] getTypes(); /** * Check if an ability type is registered. - * - * @param typeId The type ID to check - * @return true if the type exists */ boolean hasType(String typeId); /** - * Get all saved ability preset names. - * - * @return Array of saved ability names + * Get all built-in ability names. */ - String[] getSavedNames(); + String[] getAbilityNameArray(); /** - * Check if a saved ability preset exists. - * - * @param name The name of the ability - * @return true if the preset exists + * Check if a built-in ability exists by name. */ - boolean has(String name); + boolean hasAbilityName(String name); /** - * Delete a saved ability preset. + * Get all custom ability preset UUIDs. + */ + String[] getCustomAbilityIdArray(); + + /** + * Check if a custom ability preset exists by UUID. + */ + boolean hasCustomAbilityId(String uuid); + + /** + * Delete a custom ability preset by UUID. * - * @param name The name of the ability to delete * @return true if deleted successfully */ - boolean delete(String name); + boolean deleteCustomAbilityById(String uuid); } diff --git a/java/noppes/npcs/api/handler/IPlayerData.java b/java/noppes/npcs/api/handler/IPlayerData.java index 5118815..8927fef 100644 --- a/java/noppes/npcs/api/handler/IPlayerData.java +++ b/java/noppes/npcs/api/handler/IPlayerData.java @@ -1,5 +1,6 @@ package noppes.npcs.api.handler; +import noppes.npcs.api.ability.IPlayerAbilityData; import noppes.npcs.api.entity.ICustomNpc; public interface IPlayerData { @@ -28,5 +29,7 @@ public interface IPlayerData { IPlayerTradeData getTradeData(); + IPlayerAbilityData getAbilityData(); + void save(); }