Record Class BackgroundMusic

java.lang.Object

java.lang.Record

net.minecraft.world.attribute.BackgroundMusic

public record BackgroundMusic(Optional<Music> defaultMusic, Optional<Music> creativeMusic, Optional<Music> underwaterMusic)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<BackgroundMusic>	CODEC
private final Optional<Music>	creativeMusic	The field for the creativeMusic record component.
private final Optional<Music>	defaultMusic	The field for the defaultMusic record component.
static final BackgroundMusic	EMPTY
static final BackgroundMusic	OVERWORLD
private final Optional<Music>	underwaterMusic	The field for the underwaterMusic record component.

Constructor Summary

Constructors

Constructor	Description
BackgroundMusic(Optional<Music> defaultMusic, Optional<Music> creativeMusic, Optional<Music> underwaterMusic)	Creates an instance of a BackgroundMusic record class.
BackgroundMusic(Holder<SoundEvent> sound)
BackgroundMusic(Music music)

Method Summary

Modifier and Type	Method	Description
Optional<Music>	creativeMusic()	Returns the value of the creativeMusic record component.
Optional<Music>	defaultMusic()	Returns the value of the defaultMusic 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.
Optional<Music>	select(boolean isCreative, boolean isUnderwater)
final String	toString()	Returns a string representation of this record class.
Optional<Music>	underwaterMusic()	Returns the value of the underwaterMusic record component.
BackgroundMusic	withUnderwater(Music underwaterMusic)

Methods inherited from class Object

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

Field Details

defaultMusic

private final Optional<Music> defaultMusic

The field for the defaultMusic record component.

creativeMusic

private final Optional<Music> creativeMusic

The field for the creativeMusic record component.

underwaterMusic

private final Optional<Music> underwaterMusic

The field for the underwaterMusic record component.

EMPTY

public static final BackgroundMusic EMPTY

OVERWORLD

public static final BackgroundMusic OVERWORLD

CODEC

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

Constructor Details

BackgroundMusic

public BackgroundMusic(Music music)

BackgroundMusic

public BackgroundMusic(Holder<SoundEvent> sound)

BackgroundMusic

public BackgroundMusic(Optional<Music> defaultMusic,
 Optional<Music> creativeMusic,
 Optional<Music> underwaterMusic)

Creates an instance of a BackgroundMusic record class.

Parameters:

defaultMusic - the value for the defaultMusic record component

creativeMusic - the value for the creativeMusic record component

underwaterMusic - the value for the underwaterMusic record component

Method Details

withUnderwater

public BackgroundMusic withUnderwater(Music underwaterMusic)

select

public Optional<Music> select(boolean isCreative,
 boolean isUnderwater)

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.

defaultMusic

public Optional<Music> defaultMusic()

Returns the value of the defaultMusic record component.

Returns:

the value of the defaultMusic record component

creativeMusic

public Optional<Music> creativeMusic()

Returns the value of the creativeMusic record component.

Returns:

the value of the creativeMusic record component

underwaterMusic

public Optional<Music> underwaterMusic()

Returns the value of the underwaterMusic record component.

Returns:

the value of the underwaterMusic record component