Package de.marcely.bedwars.api.cosmetics.animation

Enum AnimationLocation

java.lang.Object

java.lang.Enum<AnimationLocation>

de.marcely.bedwars.api.cosmetics.animation.AnimationLocation

All Implemented Interfaces:

Serializable, Comparable<AnimationLocation>, java.lang.constant.Constable

public enum AnimationLocation
extends Enum<AnimationLocation>

Represents the location at which an animation shall be played.

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
MAIN	The main subject related to the animation being initiated.
MAIN_STATIC	Similar to MAIN, only that it is constant (never changes).
RELATED	The related object related to the animation being initiated.
RELATED_STATIC	Similar to RELATED, only that it is constant (never changes).

Method Summary

Modifier and Type	Method	Description
static AnimationLocation	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AnimationLocation[]	values()	Returns an array containing the constants of this enum type, 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

MAIN

public static final AnimationLocation MAIN

The main subject related to the animation being initiated.

E.g. for projectiles it would be the shooter (of the projectile i.a. arrow)

MAIN_STATIC

public static final AnimationLocation MAIN_STATIC

Similar to MAIN, only that it is constant (never changes).

More precisely, the location of the main subject is used when the animation had started.

RELATED

public static final AnimationLocation RELATED

The related object related to the animation being initiated.

E.g. for projectiles it would be the projectile itself

RELATED_STATIC

public static final AnimationLocation RELATED_STATIC

Similar to RELATED, only that it is constant (never changes).

More precisely, the location of the related object is used when the animation had started.

Method Details

values

public static AnimationLocation[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AnimationLocation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null