Package net.minestom.server.item.firework

Enum Class FireworkEffectType

java.lang.Object

java.lang.Enum<FireworkEffectType>

net.minestom.server.item.firework.FireworkEffectType

All Implemented Interfaces:

Serializable, Comparable<FireworkEffectType>, Constable

public enum FireworkEffectType
extends Enum<FireworkEffectType>

An enumeration that representing all available firework types.

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
BURST
CREEPER_SHAPED
LARGE_BALL
SMALL_BALL
STAR_SHAPED

Method Summary

Modifier and Type	Method	Description
static FireworkEffectType	byId(byte id)	Retrieves a FireworkEffectType by the given id.
byte	getType()	Retrieves the type of the firework effect.
static FireworkEffectType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FireworkEffectType[]	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

SMALL_BALL

public static final FireworkEffectType SMALL_BALL

LARGE_BALL

public static final FireworkEffectType LARGE_BALL

STAR_SHAPED

public static final FireworkEffectType STAR_SHAPED

CREEPER_SHAPED

public static final FireworkEffectType CREEPER_SHAPED

BURST

public static final FireworkEffectType BURST

Method Details

values

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

byId

public static FireworkEffectType byId(byte id)

Retrieves a FireworkEffectType by the given id.

Parameters:

id - The identifier of the firework effect type.

Returns:

A firework effect type or null.

getType

public byte getType()

Retrieves the type of the firework effect.

Returns:

The type of the firework effect as a byte.