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

Enum Class BetweenMode

java.lang.Object

java.lang.Enum<BetweenMode>

com.pixelmonmod.pixelmon.api.battles.attack.animation.transform.BetweenMode

All Implemented Interfaces:

Serializable, Comparable<BetweenMode>, Constable

public enum BetweenMode
extends Enum<BetweenMode>

Determines how the length of a "between" animation transform changes over time. This is used to control how the effect grows from the start position toward the end position.

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
FIXED_LENGTH	Effect always has a fixed length, aimed from start toward end.
FULL	Effect immediately fills the whole distance.
STRETCH	Effect grows from the start position toward the end position.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
float	resolveLength(float distance, float baseLength, float progress)
static BetweenMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BetweenMode[]	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

STRETCH

public static final BetweenMode STRETCH

Effect grows from the start position toward the end position. At full progress, it reaches the target.

FIXED_LENGTH

public static final BetweenMode FIXED_LENGTH

Effect always has a fixed length, aimed from start toward end. Useful for cones/flames/slashes that should not reach the target.

FULL

public static final BetweenMode FULL

Effect immediately fills the whole distance. Useful when you want the model to appear already connected.

Field Details

CODEC

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

Method Details

values

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

resolveLength

public float resolveLength(float distance,
 float baseLength,
 float progress)