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 source Sound.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 Detail

      • all

        static @NonNull SoundStop all()
        Stops all sounds.
        Returns:
        a sound stopper
        Since:
        4.0.0

      • named

        static @NonNull SoundStop named​(@NonNull net.kyori.adventure.key.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 net.kyori.adventure.key.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 net.kyori.adventure.key.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