Package dev.aurelium.auraskills.api.skill

Enum Class Skills

java.lang.Object
java.lang.Enum<Skills>
dev.aurelium.auraskills.api.skill.Skills
All Implemented Interfaces:
Optioned, NamespaceIdentified, Skill, Serializable, Comparable<Skills>, Constable
public enum Skills extends Enum<Skills> implements Skill

  • Enum Constant Details

    • FARMING

      public static final Skills FARMING

    • FORAGING

      public static final Skills FORAGING

    • MINING

      public static final Skills MINING

    • FISHING

      public static final Skills FISHING

    • EXCAVATION

      public static final Skills EXCAVATION

    • ARCHERY

      public static final Skills ARCHERY

    • FIGHTING

      public static final Skills FIGHTING

    • DEFENSE

      public static final Skills DEFENSE

    • AGILITY

      public static final Skills AGILITY

    • ENDURANCE

      public static final Skills ENDURANCE

    • ALCHEMY

      public static final Skills ALCHEMY

    • ENCHANTING

      public static final Skills ENCHANTING

    • SORCERY

      public static final Skills SORCERY

    • HEALING

      public static final Skills HEALING

    • FORGING

      public static final Skills FORGING

  • Method Details

    • values

      public static Skills[] 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 Skills 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()
      Description copied from interface: Skill
      Returns the result of NamespacedId.toString() for the skill's NamespacedId.
      Specified by:
      toString in interface Skill
      Overrides:
      toString in class Enum<Skills>
      Returns:
      the String representation of the NamespacedId

    • isEnabled

      public boolean isEnabled()
      Description copied from interface: Skill
      Gets whether the skill is enabled in the configuration. The skill's XP gain, rewards, abilities, and mana abilities are also disabled for disabled skills.
      Specified by:
      isEnabled in interface Skill
      Returns:
      whether the skill is enabled

    • getAbilities

      @NotNull public @NotNull List<Ability> getAbilities()
      Description copied from interface: Skill
      Gets the list of Ability instances associated with the skill. All loaded abilities are returned, some of which might be disabled.
      Specified by:
      getAbilities in interface Skill
      Returns:
      the abilities of the skill

    • getXpMultiplierAbility

      public Ability getXpMultiplierAbility()
      Description copied from interface: Skill
      Gets the ability that specifically increases XP gain for the skill when leveled up.
      Specified by:
      getXpMultiplierAbility in interface Skill
      Returns:
      the XP multiplier ability, or null if there is none

    • getManaAbility

      @Nullable public @Nullable ManaAbility getManaAbility()
      Description copied from interface: Skill
      Gets the mana ability associated with the skill.
      Specified by:
      getManaAbility in interface Skill
      Returns:
      the ManaAbility, or null if there is none

    • getSources

      @NotNull public @NotNull List<XpSource> getSources()
      Description copied from interface: Skill
      Gets the list of XpSource instances for the skill. Each XP source is a different way to gain XP in a skill.
      Specified by:
      getSources in interface Skill
      Returns:
      the list of XP sources

    • getMaxLevel

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

    • getDisplayName

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

    • getDisplayName

      public String getDisplayName(Locale locale, boolean formatted)
      Description copied from interface: Skill
      Gets the skill display name as defined in the locale's messages file.
      Specified by:
      getDisplayName in interface Skill
      Parameters:
      locale - the locale to get the display name in
      formatted - if false, formatting will not be applied and will return a raw string
      Returns:
      the display name in the specified locale or in a fallback language

    • getDescription

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

    • getDescription

      public String getDescription(Locale locale, boolean formatted)
      Description copied from interface: Skill
      Gets the skill description as defined in the locale's messages file.
      Specified by:
      getDescription in interface Skill
      Parameters:
      locale - the locale to get the description in
      formatted - if false, formatting will not be applied and will return a raw string
      Returns:
      the description in the specified locale or in a fallback language

    • 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