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

        @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 named sound.
        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 named sound.
        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 named sound.
        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 source source.
        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 named name on source source.
        Parameters:
        sound - the sound
        source - 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 named name on source source.
        Parameters:
        sound - the sound
        source - 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 named name on source source.
        Parameters:
        sound - the sound
        source - 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