Package com.pixelmonmod.pixelmon.api.enums

Enum Class BattleEndTaskType

java.lang.Object

java.lang.Enum<BattleEndTaskType>

com.pixelmonmod.pixelmon.api.enums.BattleEndTaskType

All Implemented Interfaces:

Serializable, Comparable<BattleEndTaskType>, Constable

public enum BattleEndTaskType
extends Enum<BattleEndTaskType>

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
ALWAYS_QUEUE	Queue the consumer for execution at the end of the player's next battle, even if they aren't currently in one.
QUEUE_IF_BATTLE_OTHERWISE_RUN	If the target player is in a battle, queue the consumer for execution at the end.
QUEUE_IF_BATTLE_OTHERWISE_SKIP	If the target player is in a battle, queue the consumer for execution at the end.

Method Summary

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

QUEUE_IF_BATTLE_OTHERWISE_RUN

public static final BattleEndTaskType QUEUE_IF_BATTLE_OTHERWISE_RUN

If the target player is in a battle, queue the consumer for execution at the end. Otherwise, execute it now.

QUEUE_IF_BATTLE_OTHERWISE_SKIP

public static final BattleEndTaskType QUEUE_IF_BATTLE_OTHERWISE_SKIP

If the target player is in a battle, queue the consumer for execution at the end. Otherwise, throw it away.

ALWAYS_QUEUE

public static final BattleEndTaskType ALWAYS_QUEUE

Queue the consumer for execution at the end of the player's next battle, even if they aren't currently in one.

Method Details

values

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