Interface SoundsAPI<P,L,S>

All Known Subinterfaces:
HTSoundsAPI<P,L,S>, MCSoundsAPI<P,L,S>

public interface SoundsAPI<P,L,S>
API for playing sounds and music to players.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    pauseMusic(P player)
    Pause music for player without losing position.
    void
    play(P player, String key)
    Play sound from module's sounds.yml by key.
    void
    play(P player, S sound, float volume, float pitch)
    Play Bukkit sound directly.
    void
    playAt(L loc, String key)
    Play sound at location.
    void
    playNBS(P player, String nbsFile)
    Deprecated.
    Use platform-specific APIs instead: MCSoundsAPI.playNBS for Minecraft, HTSoundsAPI.playMIDI for Hytale.
    void
    playRandomMusic(P player, List<String> sounds)
    Play random music from a list in sounds.yml.
    void
    resumeMusic(P player)
    Resume paused music for player.
    void
    stopMusic(P player)
    Stop music for player.
  • Method Details

    • play

      void play(P player, String key)
      Play sound from module's sounds.yml by key.
    • play

      void play(P player, S sound, float volume, float pitch)
      Play Bukkit sound directly.
    • playAt

      void playAt(L loc, String key)
      Play sound at location.
    • playNBS

      @Deprecated void playNBS(P player, String nbsFile)
      Deprecated.
      Use platform-specific APIs instead: MCSoundsAPI.playNBS for Minecraft, HTSoundsAPI.playMIDI for Hytale. This method will be removed in a future major-version window.
      Play NoteBlock song (.nbs file).
      Since:
      3.3
    • playRandomMusic

      void playRandomMusic(P player, List<String> sounds)
      Play random music from a list in sounds.yml.
    • stopMusic

      void stopMusic(P player)
      Stop music for player.
    • pauseMusic

      void pauseMusic(P player)
      Pause music for player without losing position.
    • resumeMusic

      void resumeMusic(P player)
      Resume paused music for player.