Enum Class SpellCastResult

java.lang.Object
java.lang.Enum<SpellCastResult>
com.github.minecraftschurlimods.arsmagicalegacy.api.spell.SpellCastResult
All Implemented Interfaces:
Serializable, Comparable<SpellCastResult>, Constable

public enum SpellCastResult extends Enum<SpellCastResult>
The result of a spell cast.
  • Enum Constant Details

  • Method Details

    • values

      public static SpellCastResult[] 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 SpellCastResult 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
    • isFail

      public boolean isFail()
      Returns:
      True if this spell cast result represents a failed cast, false otherwise.
    • isSuccess

      public boolean isSuccess()
      Returns:
      True if this spell cast result represents a successful cast, false otherwise.
    • isConsume

      public boolean isConsume()
      Returns:
      True if this spell cast result means that mana should be consumed, burnout should be given and reagents should be consumed, false otherwise.