Record Class AdditionsSound

java.lang.Object
java.lang.Record
fr.fidorial.world.environment.AdditionsSound
Record Components:
sound - the minecraft:sound_event key
tickChance - chance, per tick, that the sound plays; must be in [0, 1]
public record AdditionsSound(Key sound, float tickChance) extends Record
Sound randomly played while a player is inside the biome.
Since:
0.1.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    AdditionsSound(Key sound, float tickChance)
    Creates an instance of a AdditionsSound 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.
    static AdditionsSound
    of(Key sound, float tickChance)
    Creates an additions sound.
    Key
    sound()
    Returns the value of the sound record component.
    float
    tickChance()
    Returns the value of the tickChance 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

    • AdditionsSound

      public AdditionsSound(Key sound, float tickChance)
      Creates an instance of a AdditionsSound record class.
      Parameters:
      sound - the value for the sound record component
      tickChance - the value for the tickChance record component

  • Method Details

    • of

      public static AdditionsSound of(Key sound, float tickChance)
      Creates an additions sound.
      Parameters:
      sound - the sound event key
      tickChance - chance per tick
      Returns:
      the additions 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

    • tickChance

      public float tickChance()
      Returns the value of the tickChance record component.
      Returns:
      the value of the tickChance record component