Package net.kyori.adventure.sound
Interface SoundStop
-
- All Superinterfaces:
net.kyori.examination.Examinable
@NonExtendable public interface SoundStop extends net.kyori.examination.Examinable
A sound and/or a sound source, used for stopping in-game sounds that are being played on a game client matching the given sound and/or sound source.For clarification: a
SoundStop
consisting of the sound "ambient.weather.rain" and the sourceSound.Source.AMBIENT
will only stop sounds matching BOTH parameters and not sounds matching only the sound or only the source.- Since:
- 4.0.0
- See Also:
Audience.stopSound(SoundStop)
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static @NotNull SoundStop
all()
Stops all sounds.static @NotNull SoundStop
named(@NotNull java.util.function.Supplier<? extends Sound.Type> sound)
Stops all sounds namedsound
.static @NotNull SoundStop
named(@NotNull Key sound)
Stops all sounds namedsound
.static @NotNull SoundStop
named(@NotNull Sound.Type sound)
Stops all sounds namedsound
.static @NotNull SoundStop
namedOnSource(@NotNull java.util.function.Supplier<? extends Sound.Type> sound, @NotNull Sound.Source source)
Stops all sounds namedname
on sourcesource
.static @NotNull SoundStop
namedOnSource(@NotNull Key sound, @NotNull Sound.Source source)
Stops all sounds namedname
on sourcesource
.static @NotNull SoundStop
namedOnSource(@NotNull Sound.Type sound, @NotNull Sound.Source source)
Stops all sounds namedname
on sourcesource
.@Nullable Key
sound()
Gets the sound.@Nullable Sound.Source
source()
Gets the source.static @NotNull SoundStop
source(@NotNull Sound.Source source)
Stops all sounds on sourcesource
.
-
-
-
Method Detail
-
all
@NotNull static @NotNull SoundStop all()
Stops all sounds.- Returns:
- a sound stopper
- Since:
- 4.0.0
-
named
@NotNull static @NotNull SoundStop named(@NotNull @NotNull Key sound)
Stops all sounds namedsound
.- Parameters:
sound
- the sound- Returns:
- a sound stopper
- Since:
- 4.0.0
-
named
@NotNull static @NotNull SoundStop named(@NotNull Sound.Type sound)
Stops all sounds namedsound
.- Parameters:
sound
- the sound- Returns:
- a sound stopper
- Since:
- 4.0.0
-
named
@NotNull static @NotNull SoundStop named(@NotNull @NotNull java.util.function.Supplier<? extends Sound.Type> sound)
Stops all sounds namedsound
.- Parameters:
sound
- the sound- Returns:
- a sound stopper
- Since:
- 4.0.0
-
source
@NotNull static @NotNull SoundStop source(@NotNull Sound.Source source)
Stops all sounds on sourcesource
.- Parameters:
source
- the source- Returns:
- a sound stopper
- Since:
- 4.0.0
-
namedOnSource
@NotNull static @NotNull SoundStop namedOnSource(@NotNull @NotNull Key sound, @NotNull Sound.Source source)
Stops all sounds namedname
on sourcesource
.- Parameters:
sound
- the soundsource
- the source- Returns:
- a sound stopper
- Since:
- 4.0.0
-
namedOnSource
@NotNull static @NotNull SoundStop namedOnSource(@NotNull Sound.Type sound, @NotNull Sound.Source source)
Stops all sounds namedname
on sourcesource
.- Parameters:
sound
- the soundsource
- the source- Returns:
- a sound stopper
- Since:
- 4.0.0
-
namedOnSource
@NotNull static @NotNull SoundStop namedOnSource(@NotNull @NotNull java.util.function.Supplier<? extends Sound.Type> sound, @NotNull Sound.Source source)
Stops all sounds namedname
on sourcesource
.- Parameters:
sound
- the soundsource
- the source- Returns:
- a sound stopper
- Since:
- 4.0.0
-
sound
@Nullable @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
-
-