Interface BackgroundMusic

All Superinterfaces:

Wrapper

@NullMarked
@AsOf("2.4.1")
public interface BackgroundMusic
extends Wrapper

Wraps a Minecraft BackgroundMusic.

Since:

2.4.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BackgroundMusic.Builder	Builder for creating background music records.

Nested classes/interfaces inherited from interface Wrapper

Wrapper.Context<C>

Field Summary

Fields

Modifier and Type	Field	Description
static final ConstructWireProvider<BackgroundMusic>	WIRE

Method Summary

Modifier and Type	Method	Description
static BackgroundMusic.Builder	builder()	Creates a new background music record builder.
Optional<Music>	creativeMusic()	Gets the creative music.
Optional<Music>	defaultMusic()	Gets the default music.
static BackgroundMusic	of(Music defaultMusic, Music creativeMusic, Music underwaterMusic)	Creates a new background music record.
Optional<Music>	underwaterMusic()	Gets the underwater music.

Methods inherited from interface Wrapper

asHandle, toMinecraft

Field Details

WIRE

@Internal
static final ConstructWireProvider<BackgroundMusic> WIRE

Method Details

defaultMusic

@AsOf("2.4.1")
Optional<Music> defaultMusic()

Gets the default music.

Returns:

the default music, if present

Since:

2.4.1

creativeMusic

@AsOf("2.4.1")
Optional<Music> creativeMusic()

Gets the creative music.

Returns:

the creative music, if present

Since:

2.4.1

underwaterMusic

@AsOf("2.4.1")
Optional<Music> underwaterMusic()

Gets the underwater music.

Returns:

the underwater music, if present

Since:

2.4.1

of

@NullUnmarked
@AsOf("2.4.1")
static BackgroundMusic of(Music defaultMusic,
 Music creativeMusic,
 Music underwaterMusic)

Creates a new background music record.

Parameters:

defaultMusic - the default music

creativeMusic - the creative music

underwaterMusic - the underwater music

Returns:

a new background music record

Since:

2.4.1

builder

@AsOf("2.4.1")
static BackgroundMusic.Builder builder()

Creates a new background music record builder.

Returns:

a new background music record builder

Since:

2.4.1