Enum Class SpellCastResult
java.lang.Object
java.lang.Enum<SpellCastResult>
com.github.minecraftschurlimods.arsmagicalegacy.api.spell.SpellCastResult
- All Implemented Interfaces:
Serializable,Comparable<SpellCastResult>,Constable
The result of a spell cast.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescription -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanisFail()booleanstatic SpellCastResultReturns the enum constant of this class with the specified name.static SpellCastResult[]values()Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class java.lang.Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Enum Constant Details
-
SUCCESS
-
NOT_ENOUGH_MANA
-
BURNED_OUT
-
MISSING_REAGENTS
-
CANCELLED
-
EFFECT_FAILED
-
SILENCED
-
NO_PERMISSION
-
-
Method Details
-
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
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 nameNullPointerException- 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.
-