Record Class MoodSound

java.lang.Object
java.lang.Record
fr.fidorial.world.environment.MoodSound
Record Components:
sound - the minecraft:sound_event key
tickDelay - ticks the mood value needs to fill before the sound may play
blockSearchExtent - radius, in blocks, of the darkness search cube
offset - distance from the player the sound is emitted at
public record MoodSound(Key sound, int tickDelay, int blockSearchExtent, double offset) extends Record
Sound played when a player stays too long in the dark, the vanilla "cave ambience".

Part of the minecraft:audio/ambient_sounds environment attribute.

Since:
0.1.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final MoodSound
    CAVE
    The vanilla overworld cave mood sound.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MoodSound(Key sound, int tickDelay, int blockSearchExtent, double offset)
    Creates an instance of a MoodSound record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    blockSearchExtent()
    Returns the value of the blockSearchExtent record component.
    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.
    static MoodSound
    of(Key sound, int tickDelay, int blockSearchExtent, double offset)
    Creates a mood sound.
    double
    offset()
    Returns the value of the offset record component.
    Key
    sound()
    Returns the value of the sound record component.
    int
    tickDelay()
    Returns the value of the tickDelay 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

  • Field Details

    • CAVE

      public static final MoodSound CAVE
      The vanilla overworld cave mood sound.

  • Constructor Details

    • MoodSound

      public MoodSound(Key sound, int tickDelay, int blockSearchExtent, double offset)
      Creates an instance of a MoodSound record class.
      Parameters:
      sound - the value for the sound record component
      tickDelay - the value for the tickDelay record component
      blockSearchExtent - the value for the blockSearchExtent record component
      offset - the value for the offset record component

  • Method Details

    • of

      public static MoodSound of(Key sound, int tickDelay, int blockSearchExtent, double offset)
      Creates a mood sound.
      Parameters:
      sound - the sound event key
      tickDelay - ticks before the sound may play
      blockSearchExtent - radius of the darkness search cube
      offset - emission distance
      Returns:
      the mood sound

    • 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

    • tickDelay

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

    • blockSearchExtent

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

    • offset

      public double offset()
      Returns the value of the offset record component.
      Returns:
      the value of the offset record component