Package studio.magemonkey.fabled.api.enums

Enum Class ManaCost

java.lang.Object

java.lang.Enum<ManaCost>

studio.magemonkey.fabled.api.enums.ManaCost

All Implemented Interfaces:

Serializable, Comparable<ManaCost>, Constable

public enum ManaCost
extends Enum<ManaCost>

A collection of possible reasons mana was deducted from a player.

This is used when deducting mana from a player to allow effects to react differently depending on why it is being deducted.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
SKILL_CAST	The player cast a skill that used some mana
SKILL_EFFECT	The player was affected by a skill effect that reduced their mana
SPECIAL	The player lost mana for some unspecified reason

Method Summary

Modifier and Type	Method	Description
static ManaCost	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ManaCost[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SKILL_CAST

public static final ManaCost SKILL_CAST

The player cast a skill that used some mana

SKILL_EFFECT

public static final ManaCost SKILL_EFFECT

The player was affected by a skill effect that reduced their mana

SPECIAL

public static final ManaCost SPECIAL

The player lost mana for some unspecified reason

Method Details

values

public static ManaCost[] 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 ManaCost 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