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.

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.
static BackgroundMusic	decode(Object minecraftBackgroundMusic)	Reads Minecraft background music into a wrapper.
Optional<Music>	defaultMusic()	Gets the default music.
static BackgroundMusic	of(Music defaultMusic, Music creativeMusic, Music underwaterMusic)	Creates a new background music record.
default BackgroundMusic.Builder	toBuilder()	Creates a new builder with the same values as this background music.
Optional<Music>	underwaterMusic()	Gets the underwater music.

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

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

toBuilder

@AsOf("3.3.0")
default BackgroundMusic.Builder toBuilder()

Creates a new builder with the same values as this background music.

Returns:

a new builder with the same values

Since:

3.3.0

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

decode

@AsOf("3.3.0")
static BackgroundMusic decode(Object minecraftBackgroundMusic)

Reads Minecraft background music into a wrapper.

Parameters:

minecraftBackgroundMusic - the background music to read

Returns:

the wrapper for it

Since:

3.3.0