Enum Class AbilityEnum

java.lang.Object
java.lang.Enum<AbilityEnum>
wizardquest.abilities.AbilityEnum
All Implemented Interfaces:
Serializable, Comparable<AbilityEnum>, Constable

public enum AbilityEnum extends Enum<AbilityEnum>
  • Enum Constant Details

  • Method Details

    • values

      public static AbilityEnum[] 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 AbilityEnum 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
    • getDescription

      public String getDescription()
      Gets the description of the ability.
      Returns:
      a human-readable description of the ability.
    • getBaseDamage

      public int getBaseDamage()
      Gets the base damage for the ability, before any passive abilities (upgrades) modify it.
      Returns:
      the base damage for the ability.
    • getMagicCost

      public int getMagicCost()
      Get the amount of magic this ability consumes when used.
      Returns:
      the amount of magic the ability uses.
    • getDamageType

      public DamageEnum getDamageType()
      Get the type of damage the ability deals.
      Returns:
      the ability's damage type.
    • getDisplayName

      public String getDisplayName()
      Gets the human readable display name for the ability.
      Returns:
      the ability's display name.
    • execute

      public void execute(EntityInterface source, EntityInterface target) throws LackingResourceException
      Executes the ability on a target.
      Parameters:
      source - the entity using the ability.
      target - the entity the ability is attacking.
      Throws:
      LackingResourceException - if the source doesn't have enough magic to use the ability.