Package net.kyori.adventure.sound

Interface SoundStop

All Superinterfaces:

net.kyori.examination.Examinable

public interface SoundStop
extends net.kyori.examination.Examinable

A sound stop.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
static @NonNull SoundStop	all()	Stops all sounds.
static @NonNull SoundStop	named(@NonNull Supplier<? extends Sound.Type> sound)	Stops all sounds named sound.
static @NonNull SoundStop	named(@NonNull Key sound)	Stops all sounds named sound.
static @NonNull SoundStop	named(@NonNull Sound.Type sound)	Stops all sounds named sound.
static @NonNull SoundStop	namedOnSource(@NonNull Supplier<? extends Sound.Type> sound, @NonNull Sound.Source source)	Stops all sounds named name on source source.
static @NonNull SoundStop	namedOnSource(@NonNull Key sound, @NonNull Sound.Source source)	Stops all sounds named name on source source.
static @NonNull SoundStop	namedOnSource(@NonNull Sound.Type sound, @NonNull Sound.Source source)	Stops all sounds named name on source source.
@Nullable Key	sound()	Gets the sound.
@Nullable Sound.Source	source()	Gets the source.
static @NonNull SoundStop	source(@NonNull Sound.Source source)	Stops all sounds on source source.

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Method Details

all

static @NonNull SoundStop all()

Stops all sounds.

Returns:

a sound stopper

Since:

4.0.0

named

static @NonNull SoundStop named(@NonNull Key sound)

Stops all sounds named sound.

Parameters:

sound - the sound

Returns:

a sound stopper

Since:

4.0.0

named

static @NonNull SoundStop named(@NonNull Sound.Type sound)

Stops all sounds named sound.

Parameters:

sound - the sound

Returns:

a sound stopper

Since:

4.0.0

named

static @NonNull SoundStop named(@NonNull Supplier<? extends Sound.Type> sound)

Stops all sounds named sound.

Parameters:

sound - the sound

Returns:

a sound stopper

Since:

4.0.0

source

static @NonNull SoundStop source(@NonNull Sound.Source source)

Stops all sounds on source source.

Parameters:

source - the source

Returns:

a sound stopper

Since:

4.0.0

namedOnSource

static @NonNull SoundStop namedOnSource(@NonNull Key sound, @NonNull Sound.Source source)

Stops all sounds named name on source source.

Parameters:

sound - the sound

source - the source

Returns:

a sound stopper

Since:

4.0.0

namedOnSource

static @NonNull SoundStop namedOnSource(@NonNull Sound.Type sound, @NonNull Sound.Source source)

Stops all sounds named name on source source.

Parameters:

sound - the sound

source - the source

Returns:

a sound stopper

Since:

4.0.0

namedOnSource

static @NonNull SoundStop namedOnSource(@NonNull Supplier<? extends Sound.Type> sound, @NonNull Sound.Source source)

Stops all sounds named name on source source.

Parameters:

sound - the sound

source - the source

Returns:

a sound stopper

Since:

4.0.0

sound

@Nullable Key sound()

Gets the sound.

Returns:

the sound

Since:

4.0.0

source

@Nullable Sound.Source source()

Gets the source.

Returns:

the source

Since:

4.0.0