Package com.pixelmonmod.pixelmon.api.battles.animation

Enum Class BattleAnimationSubject

java.lang.Object

java.lang.Enum<BattleAnimationSubject>

com.pixelmonmod.pixelmon.api.battles.animation.BattleAnimationSubject

All Implemented Interfaces:

Serializable, Comparable<BattleAnimationSubject>, Constable

public enum BattleAnimationSubject
extends Enum<BattleAnimationSubject>

Identifies the battle object an animation action should use as its subject.

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
BATTLE
TARGET
USER

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<BattleAnimationSubject>	CODEC

Method Summary

Modifier and Type	Method	Description
PixelmonWrapper	pokemon(ActiveBattleAnimation animation)	Resolves this subject to a Pokemon wrapper from an active animation.
String	serializedName()	Returns the lowercase serialized name used by codecs and datapacks.
static BattleAnimationSubject	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BattleAnimationSubject[]	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

USER

public static final BattleAnimationSubject USER

TARGET

public static final BattleAnimationSubject TARGET

BATTLE

public static final BattleAnimationSubject BATTLE

Field Details

CODEC

public static final com.mojang.serialization.Codec<BattleAnimationSubject> CODEC

Method Details

values

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

serializedName

public String serializedName()

Returns the lowercase serialized name used by codecs and datapacks.

Returns:

the serialized subject name

pokemon

@Nullable
public PixelmonWrapper pokemon(ActiveBattleAnimation animation)

Resolves this subject to a Pokemon wrapper from an active animation.

Parameters:

animation - the active animation

Returns:

the matching Pokemon wrapper, or null for battle-level subjects