Record Class MusicTrack

java.lang.Object
java.lang.Record
fr.fidorial.world.environment.MusicTrack
Record Components:
sound - the minecraft:sound_event key
minDelay - minimum delay, in ticks, between two plays
maxDelay - maximum delay, in ticks, between two plays
replaceCurrentMusic - whether this track cuts the music already playing
public record MusicTrack(Key sound, int minDelay, int maxDelay, boolean replaceCurrentMusic) extends Record
One track of the minecraft:audio/background_music environment attribute.
Since:
0.1.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    MusicTrack(Key sound, int minDelay, int maxDelay, boolean replaceCurrentMusic)
    Creates an instance of a MusicTrack record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    maxDelay()
    Returns the value of the maxDelay record component.
    int
    minDelay()
    Returns the value of the minDelay record component.
    static MusicTrack
    of(Key sound, int minDelay, int maxDelay)
    Creates a track that waits for the current music to end.
    boolean
    replaceCurrentMusic()
    Returns the value of the replaceCurrentMusic record component.
    Key
    sound()
    Returns the value of the sound record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • MusicTrack

      public MusicTrack(Key sound, int minDelay, int maxDelay, boolean replaceCurrentMusic)
      Creates an instance of a MusicTrack record class.
      Parameters:
      sound - the value for the sound record component
      minDelay - the value for the minDelay record component
      maxDelay - the value for the maxDelay record component
      replaceCurrentMusic - the value for the replaceCurrentMusic record component

  • Method Details

    • of

      public static MusicTrack of(Key sound, int minDelay, int maxDelay)
      Creates a track that waits for the current music to end.
      Parameters:
      sound - the sound event key
      minDelay - minimum delay in ticks
      maxDelay - maximum delay in ticks
      Returns:
      the track

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • sound

      public Key sound()
      Returns the value of the sound record component.
      Returns:
      the value of the sound record component

    • minDelay

      public int minDelay()
      Returns the value of the minDelay record component.
      Returns:
      the value of the minDelay record component

    • maxDelay

      public int maxDelay()
      Returns the value of the maxDelay record component.
      Returns:
      the value of the maxDelay record component

    • replaceCurrentMusic

      public boolean replaceCurrentMusic()
      Returns the value of the replaceCurrentMusic record component.
      Returns:
      the value of the replaceCurrentMusic record component