Package studio.magemonkey.fabled.api.enums

Enum Class ManaSource

java.lang.Object

java.lang.Enum<ManaSource>

studio.magemonkey.fabled.api.enums.ManaSource

All Implemented Interfaces:

Serializable, Comparable<ManaSource>, Constable

public enum ManaSource
extends Enum<ManaSource>

A collection of possible reasons mana was gained by a player.

This is used when giving mana to a player to allow effects to react differently depending on why it is being added.

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
COMMAND	A command restored some of their mana
REGEN	The player regenerated some mana back passively
SKILL	A skill effect replenished some of their mana
SPECIAL	The player gained mana for an unspecified reason

Method Summary

Modifier and Type	Method	Description
static ManaSource	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ManaSource[]	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

REGEN

public static final ManaSource REGEN

The player regenerated some mana back passively

SKILL

public static final ManaSource SKILL

A skill effect replenished some of their mana

COMMAND

public static final ManaSource COMMAND

A command restored some of their mana

SPECIAL

public static final ManaSource SPECIAL

The player gained mana for an unspecified reason

Method Details

values

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