Package com.cryptomorin.xseries

Class XSound.Record

java.lang.Object
com.cryptomorin.xseries.XSound.Record
Enclosing class:
XSound
public static class XSound.Record
extends Object
A class to help caching sound properties parsed from config.
Since:
3.0.0

  • Field Summary

    Fields 
    Modifier and Type Field Description
    org.bukkit.Location location  
    float pitch  
    boolean playAtLocation  
    org.bukkit.entity.Player player  
    org.bukkit.Sound sound  
    float volume  

  • Constructor Summary

    Constructors 
    Constructor Description
    Record​(org.bukkit.Sound sound, org.bukkit.entity.Player player, org.bukkit.Location location, float volume, float pitch, boolean playAtLocation)  

  • Method Summary

    Modifier and Type Method Description
    void play()
    Plays the sound with the given options and updating the players location.
    void play​(org.bukkit.Location updatedLocation)
    Plays the sound with the updated location.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • sound

      public final org.bukkit.Sound sound

    • player

      public final org.bukkit.entity.Player player

    • location

      public final org.bukkit.Location location

    • volume

      public final float volume

    • pitch

      public final float pitch

    • playAtLocation

      public final boolean playAtLocation

  • Constructor Details

    • Record

      public Record​(@Nonnull org.bukkit.Sound sound, @Nullable org.bukkit.entity.Player player, @Nonnull org.bukkit.Location location, float volume, float pitch, boolean playAtLocation)

  • Method Details

    • play

      public void play()
      Plays the sound with the given options and updating the players location.
      Since:
      3.0.0

    • play

      public void play​(@Nonnull org.bukkit.Location updatedLocation)
      Plays the sound with the updated location.
      Parameters:
      updatedLocation - the upated location.
      Since:
      3.0.0