Package de.freesoccerhdx.advancedworldcreatorapi.biome

Record Class BiomeCaveSoundSettings

java.lang.Object
java.lang.Record
de.freesoccerhdx.advancedworldcreatorapi.biome.BiomeCaveSoundSettings
public record BiomeCaveSoundSettings(org.bukkit.Sound sound, int tickDelay, int blockSearchExtent, double offset) extends Record
Represents an Object that holds Data about the Cave-Sound that will randomly play when the Player is in caves

  • Constructor Summary

    Constructors
    Constructor
    Description
    BiomeCaveSoundSettings(org.bukkit.Sound sound, int tickDelay, int blockSearchExtent, double offset)
    Creates an instance of a BiomeCaveSoundSettings 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.
    int
    getBlockSearchExtent()
    Gets the Maximum Block-Range where the Sound can play
    double
    getOffset()
    Gets the Sound-Offset which is used to customaze the Sound a little bit
    org.bukkit.Sound
    getSound()
    Gets the Sound-Type to use
    int
    getTickDelay()
    Gets the Delay before this Sound will play again in ticks
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    offset()
    Returns the value of the offset record component.
    org.bukkit.Sound
    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 java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • BiomeCaveSoundSettings

      public BiomeCaveSoundSettings(org.bukkit.Sound sound, int tickDelay, int blockSearchExtent, double offset)
      Creates an instance of a BiomeCaveSoundSettings 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

    • getSound

      public org.bukkit.Sound getSound()
      Gets the Sound-Type to use
      Returns:
      The Sound-Type that will be used

    • getOffset

      public double getOffset()
      Gets the Sound-Offset which is used to customaze the Sound a little bit
      Returns:
      The Sound-Offset

    • getBlockSearchExtent

      public int getBlockSearchExtent()
      Gets the Maximum Block-Range where the Sound can play
      Returns:
      The Block-Range

    • getTickDelay

      public int getTickDelay()
      Gets the Delay before this Sound will play again in ticks
      Returns:
      The Delay in ticks

    • 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 '=='.
      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 org.bukkit.Sound 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