Package dev.aurelium.auraskills.api.ability

Enum Class Abilities

java.lang.Object
java.lang.Enum<Abilities>
dev.aurelium.auraskills.api.ability.Abilities
All Implemented Interfaces:
Ability, AbstractAbility, Optioned, NamespaceIdentified, Serializable, Comparable<Abilities>, Constable
public enum Abilities extends Enum<Abilities> implements Ability

  • Enum Constant Details

    • BOUNTIFUL_HARVEST

      public static final Abilities BOUNTIFUL_HARVEST

    • FARMER

      public static final Abilities FARMER

    • SCYTHE_MASTER

      public static final Abilities SCYTHE_MASTER

    • GENETICIST

      public static final Abilities GENETICIST

    • GROWTH_AURA

      public static final Abilities GROWTH_AURA

    • LUMBERJACK

      public static final Abilities LUMBERJACK

    • FORAGER

      public static final Abilities FORAGER

    • AXE_MASTER

      public static final Abilities AXE_MASTER

    • VALOR

      public static final Abilities VALOR

    • SHREDDER

      public static final Abilities SHREDDER

    • LUCKY_MINER

      public static final Abilities LUCKY_MINER

    • MINER

      public static final Abilities MINER

    • PICK_MASTER

      public static final Abilities PICK_MASTER

    • STAMINA

      public static final Abilities STAMINA

    • HARDENED_ARMOR

      public static final Abilities HARDENED_ARMOR

    • LUCKY_CATCH

      public static final Abilities LUCKY_CATCH

    • FISHER

      public static final Abilities FISHER

    • TREASURE_HUNTER

      public static final Abilities TREASURE_HUNTER

    • GRAPPLER

      public static final Abilities GRAPPLER

    • EPIC_CATCH

      public static final Abilities EPIC_CATCH

    • METAL_DETECTOR

      public static final Abilities METAL_DETECTOR

    • EXCAVATOR

      public static final Abilities EXCAVATOR

    • SPADE_MASTER

      public static final Abilities SPADE_MASTER

    • BIGGER_SCOOP

      public static final Abilities BIGGER_SCOOP

    • LUCKY_SPADES

      public static final Abilities LUCKY_SPADES

    • RETRIEVAL

      public static final Abilities RETRIEVAL

    • ARCHER

      public static final Abilities ARCHER

    • BOW_MASTER

      public static final Abilities BOW_MASTER

    • PIERCING

      public static final Abilities PIERCING

    • STUN

      public static final Abilities STUN

    • SHIELDING

      public static final Abilities SHIELDING

    • DEFENDER

      public static final Abilities DEFENDER

    • MOB_MASTER

      public static final Abilities MOB_MASTER

    • IMMUNITY

      public static final Abilities IMMUNITY

    • NO_DEBUFF

      public static final Abilities NO_DEBUFF

    • PARRY

      public static final Abilities PARRY

    • FIGHTER

      public static final Abilities FIGHTER

    • SWORD_MASTER

      public static final Abilities SWORD_MASTER

    • FIRST_STRIKE

      public static final Abilities FIRST_STRIKE

    • BLEED

      public static final Abilities BLEED

    • ANTI_HUNGER

      public static final Abilities ANTI_HUNGER

    • RUNNER

      public static final Abilities RUNNER

    • GOLDEN_HEAL

      public static final Abilities GOLDEN_HEAL

    • RECOVERY

      public static final Abilities RECOVERY

    • MEAL_STEAL

      public static final Abilities MEAL_STEAL

    • LIGHT_FALL

      public static final Abilities LIGHT_FALL

    • JUMPER

      public static final Abilities JUMPER

    • SUGAR_RUSH

      public static final Abilities SUGAR_RUSH

    • FLEETING

      public static final Abilities FLEETING

    • THUNDER_FALL

      public static final Abilities THUNDER_FALL

    • ALCHEMIST

      public static final Abilities ALCHEMIST

    • BREWER

      public static final Abilities BREWER

    • SPLASHER

      public static final Abilities SPLASHER

    • LINGERING

      public static final Abilities LINGERING

    • WISE_EFFECT

      public static final Abilities WISE_EFFECT

    • XP_CONVERT

      public static final Abilities XP_CONVERT

    • ENCHANTER

      public static final Abilities ENCHANTER

    • XP_WARRIOR

      public static final Abilities XP_WARRIOR

    • ENCHANTED_STRENGTH

      public static final Abilities ENCHANTED_STRENGTH

    • LUCKY_TABLE

      public static final Abilities LUCKY_TABLE

    • SORCERER

      public static final Abilities SORCERER

    • LIFE_ESSENCE

      public static final Abilities LIFE_ESSENCE

    • HEALER

      public static final Abilities HEALER

    • LIFE_STEAL

      public static final Abilities LIFE_STEAL

    • GOLDEN_HEART

      public static final Abilities GOLDEN_HEART

    • REVIVAL

      public static final Abilities REVIVAL

    • DISENCHANTER

      public static final Abilities DISENCHANTER

    • FORGER

      public static final Abilities FORGER

    • REPAIRING

      public static final Abilities REPAIRING

    • ANVIL_MASTER

      public static final Abilities ANVIL_MASTER

    • SKILL_MENDER

      public static final Abilities SKILL_MENDER

  • Method Details

    • values

      public static Abilities[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Abilities valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getId

      public NamespacedId getId()
      Description copied from interface: NamespaceIdentified
      Gets the NamespacedId of the object
      Specified by:
      getId in interface NamespaceIdentified
      Returns:
      the NamespacedId

    • toString

      public String toString()
      Overrides:
      toString in class Enum<Abilities>

    • getSkill

      public Skill getSkill()
      Description copied from interface: AbstractAbility
      Gets the skill the ability is leveled up by based on the configuration in the skills.yml file.
      Specified by:
      getSkill in interface AbstractAbility
      Returns:
      the skill the ability belongs to

    • getLegacySkillName

      public String getLegacySkillName()

    • getDisplayName

      public String getDisplayName(Locale locale)
      Description copied from interface: Ability
      Gets the ability display name as defined in the locale's messages file.
      Specified by:
      getDisplayName in interface Ability
      Parameters:
      locale - the locale to get the display name in
      Returns:
      the display name in the specified locale or in a fallback language

    • getDescription

      public String getDescription(Locale locale)
      Description copied from interface: Ability
      Gets the ability description as defined in the locale's messages file.
      Specified by:
      getDescription in interface Ability
      Parameters:
      locale - the locale to get the description in
      Returns:
      the description in the specified locale or in a fallback language

    • getInfo

      public String getInfo(Locale locale)
      Description copied from interface: Ability
      Gets the ability info text as defined in the locale's messages file. The info text shows an ability's effects for a given level in a concise way and is shown in the main skills menu.
      Specified by:
      getInfo in interface Ability
      Parameters:
      locale - the locale to get the info in
      Returns:
      the info text in the specified locale or in a fallback language

    • hasSecondaryValue

      public boolean hasSecondaryValue()
      Description copied from interface: Ability
      Gets whether the ability has a secondary value that varies with the ability level
      Specified by:
      hasSecondaryValue in interface Ability
      Returns:
      whether the ability has a secondary value

    • isEnabled

      public boolean isEnabled()
      Description copied from interface: Ability
      Gets whether the ability is enabled in the configuration. Abilities that are not loaded in any skill will always return false. Disabled abilities should have no effect on gameplay.
      Specified by:
      isEnabled in interface Ability
      Returns:
      whether the ability is enabled

    • getBaseValue

      public double getBaseValue()
      Description copied from interface: Ability
      Gets the value of an ability when it is at level 1 (just unlocked).
      Specified by:
      getBaseValue in interface Ability
      Returns:
      the base value

    • getSecondaryBaseValue

      public double getSecondaryBaseValue()
      Description copied from interface: Ability
      Gets the secondary value of an ability when it is at level 1 (just unlocked). If Ability.hasSecondaryValue() returns false, this method will return 0.
      Specified by:
      getSecondaryBaseValue in interface Ability
      Returns:
      the secondary base value

    • getValue

      public double getValue(int level)
      Description copied from interface: Ability
      Gets the value of the ability at a specific ability level.
      Specified by:
      getValue in interface Ability
      Parameters:
      level - the ability level
      Returns:
      the value at the level

    • getValuePerLevel

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

    • getSecondaryValuePerLevel

      public double getSecondaryValuePerLevel()
      Description copied from interface: Ability
      Gets the amount that the secondary ability value is increased by for every ability level. This value only starts being added from ability level 2. A negative value means the ability value is decreased when leveled up. If Ability.hasSecondaryValue() returns false, this method will return 0.
      Specified by:
      getSecondaryValuePerLevel in interface Ability
      Returns:
      the change in secondary value per ability level

    • getSecondaryValue

      public double getSecondaryValue(int level)
      Description copied from interface: Ability
      Gets the secondary value of the ability at a specific ability level. If Ability.hasSecondaryValue() returns false, this method will return 0.
      Specified by:
      getSecondaryValue in interface Ability
      Parameters:
      level - the ability level
      Returns:
      the secondary value at the level

    • getUnlock

      public int getUnlock()
      Description copied from interface: AbstractAbility
      Gets the skill level the ability is unlocked at based on the configuration.
      Specified by:
      getUnlock in interface AbstractAbility
      Returns:
      the skill level the ability is unlocked at

    • getLevelUp

      public int getLevelUp()
      Description copied from interface: AbstractAbility
      Gets the interval of skill levels between ability level ups. A value of 5 means the ability levels up every 5 levels, starting at the value of AbstractAbility.getUnlock().
      Specified by:
      getLevelUp in interface AbstractAbility
      Returns:
      the level up interval

    • getMaxLevel

      public int getMaxLevel()
      Description copied from interface: AbstractAbility
      Gets the max level of the ability based on the configuration.
      Specified by:
      getMaxLevel in interface AbstractAbility
      Returns:
      the max level

    • optionBoolean

      public boolean optionBoolean(String key)
      Specified by:
      optionBoolean in interface Optioned

    • optionBoolean

      public boolean optionBoolean(String key, boolean def)
      Specified by:
      optionBoolean in interface Optioned

    • optionInt

      public int optionInt(String key)
      Specified by:
      optionInt in interface Optioned

    • optionInt

      public int optionInt(String key, int def)
      Specified by:
      optionInt in interface Optioned

    • optionDouble

      public double optionDouble(String key)
      Specified by:
      optionDouble in interface Optioned

    • optionDouble

      public double optionDouble(String key, double def)
      Specified by:
      optionDouble in interface Optioned

    • optionString

      public String optionString(String key)
      Specified by:
      optionString in interface Optioned

    • optionString

      public String optionString(String key, String def)
      Specified by:
      optionString in interface Optioned

    • optionStringList

      public List<String> optionStringList(String key)
      Specified by:
      optionStringList in interface Optioned

    • optionMap

      public Map<String,Object> optionMap(String key)
      Specified by:
      optionMap in interface Optioned