Package net.kyori.adventure.sound

Interface Sound

All Superinterfaces:

net.kyori.examination.Examinable

@NonExtendable
public interface Sound
extends net.kyori.examination.Examinable

Represents an in-game sound which can be played to the client.

A sound consists of:

key/type

the resource location of this sound (e.g minecraft:ambient.cave or my_plugin:custom_sound

source

a Sound.Source telling the game where the sound is coming from

volume

a number in the range [0,∞) representing how loud the sound should be played. Increasing volume does not actually play the sound louder, but increases the radius of where it can be heard

pitch

a number in the range [0,2] representing which pitch the sound should be played at

Since:

4.0.0

See Also:

SoundStop

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Sound.Emitter	An emitter of sounds.
static class	Sound.Source	The sound source.
static interface	Sound.Type	A sound type.

Method Summary

Modifier and Type	Method	Description
@NotNull SoundStop	asStop()	Gets the SoundStop that will stop this specific sound.
@NotNull Key	name()	Gets the name.
float	pitch()	Gets the pitch.
static @NotNull Sound	sound(@NotNull Supplier<? extends Sound.Type> type, @NotNull Sound.Source.Provider source, float volume, float pitch)	Creates a new sound.
static @NotNull Sound	sound(@NotNull Supplier<? extends Sound.Type> type, @NotNull Sound.Source source, float volume, float pitch)	Creates a new sound.
static @NotNull Sound	sound(@NotNull Key name, @NotNull Sound.Source.Provider source, float volume, float pitch)	Creates a new sound.
static @NotNull Sound	sound(@NotNull Key name, @NotNull Sound.Source source, float volume, float pitch)	Creates a new sound.
static @NotNull Sound	sound(@NotNull Sound.Type type, @NotNull Sound.Source.Provider source, float volume, float pitch)	Creates a new sound.
static @NotNull Sound	sound(@NotNull Sound.Type type, @NotNull Sound.Source source, float volume, float pitch)	Creates a new sound.
@NotNull Sound.Source	source()	Gets the source.
float	volume()	Gets the volume.

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Method Detail

sound

@NotNull
static @NotNull Sound sound(@NotNull
                            @NotNull Key name,
                            @NotNull
                            @NotNull Sound.Source source,
                            float volume,
                            float pitch)

Creates a new sound.

Parameters:

name - the name

source - the source

volume - the volume

pitch - the pitch

Returns:

the sound

Since:

4.0.0

sound

@NotNull
static @NotNull Sound sound(@NotNull
                            @NotNull Sound.Type type,
                            @NotNull
                            @NotNull Sound.Source source,
                            float volume,
                            float pitch)

Creates a new sound.

Parameters:

type - the type

source - the source

volume - the volume

pitch - the pitch

Returns:

the sound

Since:

4.0.0

sound

@NotNull
static @NotNull Sound sound(@NotNull
                            @NotNull Supplier<? extends Sound.Type> type,
                            @NotNull
                            @NotNull Sound.Source source,
                            float volume,
                            float pitch)

Creates a new sound.

Parameters:

type - the type

source - the source

volume - the volume

pitch - the pitch

Returns:

the sound

Since:

4.0.0

sound

@NotNull
static @NotNull Sound sound(@NotNull
                            @NotNull Key name,
                            @NotNull Sound.Source.Provider source,
                            float volume,
                            float pitch)

Creates a new sound.

Parameters:

name - the name

source - the source

volume - the volume

pitch - the pitch

Returns:

the sound

Since:

4.8.0

sound

@NotNull
static @NotNull Sound sound(@NotNull
                            @NotNull Sound.Type type,
                            @NotNull Sound.Source.Provider source,
                            float volume,
                            float pitch)

Creates a new sound.

Parameters:

type - the type

source - the source

volume - the volume

pitch - the pitch

Returns:

the sound

Since:

4.8.0

sound

@NotNull
static @NotNull Sound sound(@NotNull
                            @NotNull Supplier<? extends Sound.Type> type,
                            @NotNull Sound.Source.Provider source,
                            float volume,
                            float pitch)

Creates a new sound.

Parameters:

type - the type

source - the source

volume - the volume

pitch - the pitch

Returns:

the sound

Since:

4.8.0

name

@NotNull
@NotNull Key name()

Gets the name.

Returns:

the name

Since:

4.0.0

source

@NotNull
@NotNull Sound.Source source()

Gets the source.

Returns:

the source

Since:

4.0.0

volume

float volume()

Gets the volume.

Returns:

the volume

Since:

4.0.0

pitch

float pitch()

Gets the pitch.

Returns:

the pitch

Since:

4.0.0

asStop

@NotNull
@NotNull SoundStop asStop()

Gets the SoundStop that will stop this specific sound.

Returns:

the sound stop

Since:

4.8.0