Package dev.aurelium.auraskills.api.mana

Interface ManaAbility

All Superinterfaces:
AbstractAbility, NamespaceIdentified, Optioned
All Known Implementing Classes:
CustomManaAbility, ManaAbilities
public interface ManaAbility extends AbstractAbility, Optioned

  • Method Details

    • getDisplayName

      String getDisplayName(Locale locale)
      Gets the mana ability display name as defined in the locale's messages file.
      Parameters:
      locale - the locale to get the display name in
      Returns:
      the display name in the specified locale or in a fallback language

    • getDescription

      String getDescription(Locale locale)
      Gets the mana ability description as defined in the locale's messages file.
      Parameters:
      locale - the locale to get the description in
      Returns:
      the description in the specified locale or in a fallback language

    • name

      String name()
      Gets a fully uppercase String of the mana ability name without the namespace
      Returns:
      the mana ability name in all upper case

    • isEnabled

      boolean isEnabled()
      Gets whether the mana ability is enabled in the configuration. Mana abilities that are not loaded in any skill will always return false. Disabled mana abilities should have no effect on gameplay.
      Returns:
      whether the mana ability is enabled

    • getBaseValue

      double getBaseValue()
      Gets the value of a mana ability at level 1 (just unlocked).
      Returns:
      the base value

    • getValuePerLevel

      double getValuePerLevel()
      Gets the amount that the mana ability value is increased by for every mana ability level. This value only starts being added from ability level 2. A negative value means the mana ability value is decreased when leveled up.
      Returns:
      the change in value per mana ability level

    • getValue

      double getValue(int level)
      Gets the value of the mana ability at a specific mana ability level.
      Parameters:
      level - the mana ability level
      Returns:
      the value at the level

    • getDisplayValue

      double getDisplayValue(int level)
      Gets the value of the mana ability displayed in menus at a specific mana ability level. This is usually the same as getValue(int), but can be different if the value has to be scaled to show an accurate value, such as multiplying by hp action bar scaling.
      Parameters:
      level - the mana ability level
      Returns:
      the displayed value at the level

    • getBaseCooldown

      double getBaseCooldown()
      Gets the base cooldown of the mana ability at level 1 (just unlocked).
      Returns:
      the base cooldown

    • getCooldownPerLevel

      double getCooldownPerLevel()
      Gets the change in cooldown per mana ability level. Negative values mean the cooldown decreases as the mana ability levels up.
      Returns:
      the change in cooldown per mana ability level

    • getCooldown

      double getCooldown(int level)
      Gets the cooldown at a specific mana ability level.
      Parameters:
      level - the mana ability level
      Returns:
      the cooldown at the level

    • getBaseManaCost

      double getBaseManaCost()
      Gets the base mana cost of the mana ability at level 1 (just unlocked).
      Returns:
      the base mana cost

    • getManaCostPerLevel

      double getManaCostPerLevel()
      Gets the change in mana cost per mana ability level. Negative values indicate a decrease in mana cost.
      Returns:
      the change in mana cost per mana ability level

    • getManaCost

      double getManaCost(int level)
      Gets the mana cost at a specific mana ability level.
      Parameters:
      level - the mana ability level
      Returns:
      the mana cost at the level