Record Class FireworkExplosion

java.lang.Object

java.lang.Record

net.minestom.server.item.component.FireworkExplosion

public record FireworkExplosion(@NotNull FireworkExplosion.Shape shape, @NotNull List<RGBLike> colors, @NotNull List<RGBLike> fadeColors, boolean hasTrail, boolean hasTwinkle)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FireworkExplosion.Shape

Field Summary

Fields

Modifier and Type	Field	Description
static final Codec<FireworkExplosion>	CODEC
static final NetworkBuffer.Type<FireworkExplosion>	NETWORK_TYPE

Constructor Summary

Constructors

Constructor	Description
FireworkExplosion(@NotNull FireworkExplosion.Shape shape, @NotNull List<RGBLike> colors, @NotNull List<RGBLike> fadeColors, boolean hasTrail, boolean hasTwinkle)	Creates an instance of a FireworkExplosion record class.

Method Summary

Modifier and Type	Method	Description
@NotNull List<RGBLike>	colors()	Returns the value of the colors record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull List<RGBLike>	fadeColors()	Returns the value of the fadeColors record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	hasTrail()	Returns the value of the hasTrail record component.
boolean	hasTwinkle()	Returns the value of the hasTwinkle record component.
@NotNull FireworkExplosion.Shape	shape()	Returns the value of the shape record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NETWORK_TYPE

public static final NetworkBuffer.Type<FireworkExplosion> NETWORK_TYPE

CODEC

public static final Codec<FireworkExplosion> CODEC

Constructor Details

FireworkExplosion

public FireworkExplosion(@NotNull
 @NotNull FireworkExplosion.Shape shape,
 @NotNull
 @NotNull List<RGBLike> colors,
 @NotNull
 @NotNull List<RGBLike> fadeColors,
 boolean hasTrail,
 boolean hasTwinkle)

Creates an instance of a FireworkExplosion record class.

Parameters:

shape - the value for the shape record component

colors - the value for the colors record component

fadeColors - the value for the fadeColors record component

hasTrail - the value for the hasTrail record component

hasTwinkle - the value for the hasTwinkle record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

shape

@NotNull
public @NotNull FireworkExplosion.Shape shape()

Returns the value of the shape record component.

Returns:

the value of the shape record component

colors

@NotNull
public @NotNull List<RGBLike> colors()

Returns the value of the colors record component.

Returns:

the value of the colors record component

fadeColors

@NotNull
public @NotNull List<RGBLike> fadeColors()

Returns the value of the fadeColors record component.

Returns:

the value of the fadeColors record component

hasTrail

public boolean hasTrail()

Returns the value of the hasTrail record component.

Returns:

the value of the hasTrail record component

hasTwinkle

public boolean hasTwinkle()

Returns the value of the hasTwinkle record component.

Returns:

the value of the hasTwinkle record component