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

Enum Class BattleAnimationChannelScope

java.lang.Object

java.lang.Enum<BattleAnimationChannelScope>

com.pixelmonmod.pixelmon.api.battles.animation.schedule.BattleAnimationChannelScope

All Implemented Interfaces:

Serializable, Comparable<BattleAnimationChannelScope>, Constable

public enum BattleAnimationChannelScope
extends Enum<BattleAnimationChannelScope>

Defines whether an animation channel is shared globally or scoped per lane.

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
GLOBAL
LANE

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
String	apply(String channel, BattleController controller)	Applies this scope to a channel for the supplied controller.
String	serializedName()	Returns the lowercase serialized name used by codecs and datapacks.
static BattleAnimationChannelScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BattleAnimationChannelScope[]	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

GLOBAL

public static final BattleAnimationChannelScope GLOBAL

LANE

public static final BattleAnimationChannelScope LANE

Field Details

CODEC

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

Method Details

values

public static BattleAnimationChannelScope[] 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 BattleAnimationChannelScope 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 scope name

apply

public String apply(String channel,
 BattleController controller)

Applies this scope to a channel for the supplied controller.

Parameters:

channel - the base channel

controller - the current battle controller

Returns:

the effective channel name