Package net.kyori.adventure.sound

Interface Sound

All Superinterfaces:
net.kyori.examination.Examinable
public interface Sound
extends net.kyori.examination.Examinable
A sound.
Since:
4.0.0

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Interface Description
    static class  Sound.Source
    The sound source.
    static interface  Sound.Type
    A sound type.

  • Method Summary

    Modifier and Type Method Description
    @NonNull Key name()
    Gets the name.
    float pitch()
    Gets the pitch.
    static @NonNull Sound sound​(@NonNull Supplier<? extends Sound.Type> type, @NonNull Sound.Source source, float volume, float pitch)
    Creates a new sound.
    static @NonNull Sound sound​(@NonNull Key name, @NonNull Sound.Source source, float volume, float pitch)
    Creates a new sound.
    static @NonNull Sound sound​(@NonNull Sound.Type type, @NonNull Sound.Source source, float volume, float pitch)
    Creates a new sound.
    @NonNull Sound.Source source()
    Gets the source.
    float volume()
    Gets the volume.

    Methods inherited from interface net.kyori.examination.Examinable

    examinableName, examinableProperties, examine

  • Method Details

    • sound

      static @NonNull Sound sound​(@NonNull Key name, @NonNull 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

      static @NonNull Sound sound​(@NonNull Sound.Type type, @NonNull 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

      static @NonNull Sound sound​(@NonNull Supplier<? extends Sound.Type> type, @NonNull 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

    • name

      @NonNull Key name()
      Gets the name.
      Returns:
      the name
      Since:
      4.0.0

    • source

      @NonNull 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