Interface AmbientSounds

All Superinterfaces:

Wrapper

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

Wraps a Minecraft AmbientSounds.

Since:

2.4.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AmbientSounds.Builder	A builder for ambient sounds.

Field Summary

Fields

Modifier and Type	Field	Description
static final AmbientSounds	EMPTY

Method Summary

Modifier and Type	Method	Description
List<AmbientAdditionsSettings>	additions()	Gets the ambient additions settings.
static AmbientSounds.Builder	builder()	Creates a new ambient sounds record builder.
static AmbientSounds	decode(Object minecraftAmbientSounds)	Reads Minecraft ambient sounds into a wrapper.
Optional<SoundEvent>	loop()	Gets the loop sound event.
Optional<AmbientMoodSettings>	mood()	Gets the mood settings.
static AmbientSounds	of(@Nullable SoundEvent loop, @Nullable AmbientMoodSettings mood, List<AmbientAdditionsSettings> additions)	Creates a new ambient sounds record.
default AmbientSounds.Builder	toBuilder()	Creates a new builder with the same values as these ambient sounds.

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Field Details

EMPTY

static final AmbientSounds EMPTY

Method Details

loop

@AsOf("2.4.1")
Optional<SoundEvent> loop()

Gets the loop sound event.

Returns:

the loop sound event, if present

Since:

2.4.1

mood

@AsOf("2.4.1")
Optional<AmbientMoodSettings> mood()

Gets the mood settings.

Returns:

the mood settings, if present

Since:

2.4.1

additions

@AsOf("2.4.1")
List<AmbientAdditionsSettings> additions()

Gets the ambient additions settings.

Returns:

the ambient additions settings

Since:

2.4.1

toBuilder

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

Creates a new builder with the same values as these ambient sounds.

Returns:

a new builder with the same values

Since:

3.3.0

of

@AsOf("2.4.1")
static AmbientSounds of(@Nullable SoundEvent loop,
 @Nullable AmbientMoodSettings mood,
 List<AmbientAdditionsSettings> additions)

Creates a new ambient sounds record.

Parameters:

loop - the loop sound event

mood - the mood settings

additions - the ambient additions settings

Returns:

a new ambient sounds record

Since:

2.4.1

builder

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

Creates a new ambient sounds record builder.

Returns:

a new ambient sounds record builder

Since:

2.4.1

decode

@AsOf("3.3.0")
static AmbientSounds decode(Object minecraftAmbientSounds)

Reads Minecraft ambient sounds into a wrapper.

Parameters:

minecraftAmbientSounds - the ambient sounds to read

Returns:

the wrapper for them

Since:

3.3.0