Record Class BackgroundMusic

java.lang.Object

java.lang.Record

net.minestom.server.world.attribute.BackgroundMusic

public record BackgroundMusic(@Nullable Music music, @Nullable Music creativeMusic, @Nullable Music underwaterMusic)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final Codec<BackgroundMusic>	CODEC
static final BackgroundMusic	EMPTY
static final BackgroundMusic	OVERWORLD

Constructor Summary

Constructors

Constructor	Description
BackgroundMusic(@Nullable Music music, @Nullable Music creativeMusic, @Nullable Music underwaterMusic)	Creates an instance of a BackgroundMusic record class.

Method Summary

Modifier and Type	Method	Description
@Nullable Music	creativeMusic()	Returns the value of the creativeMusic record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable Music	music()	Returns the value of the music record component.
final String	toString()	Returns a string representation of this record class.
@Nullable Music	underwaterMusic()	Returns the value of the underwaterMusic record component.

Methods inherited from class Object

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

Field Details

EMPTY

public static final BackgroundMusic EMPTY

OVERWORLD

public static final BackgroundMusic OVERWORLD

CODEC

public static final Codec<BackgroundMusic> CODEC

Constructor Details

BackgroundMusic

public BackgroundMusic(@Nullable
 @Nullable Music music,
 @Nullable
 @Nullable Music creativeMusic,
 @Nullable
 @Nullable Music underwaterMusic)

Creates an instance of a BackgroundMusic record class.

Parameters:

music - the value for the music record component

creativeMusic - the value for the creativeMusic record component

underwaterMusic - the value for the underwaterMusic 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. All components in this record class are compared with Objects::equals(Object,Object).

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.

music

@Nullable
public @Nullable Music music()

Returns the value of the music record component.

Returns:

the value of the music record component

creativeMusic

@Nullable
public @Nullable Music creativeMusic()

Returns the value of the creativeMusic record component.

Returns:

the value of the creativeMusic record component

underwaterMusic

@Nullable
public @Nullable Music underwaterMusic()

Returns the value of the underwaterMusic record component.

Returns:

the value of the underwaterMusic record component