Package dev.itsharshxd.zentrix.api.world

Record Class WorldBorderSnapshot

java.lang.Object
java.lang.Record
dev.itsharshxd.zentrix.api.world.WorldBorderSnapshot
public record WorldBorderSnapshot(double diameter, double damageAmount, double damageBuffer, int warningDistance, int warningTime) extends Record
Immutable snapshot of Bukkit world-border settings. Diameter, damage buffer, and warning distance are measured in blocks; warning time is in seconds.
Since:
1.3.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    WorldBorderSnapshot(double diameter, double damageAmount, double damageBuffer, int warningDistance, int warningTime)
    Creates an instance of a WorldBorderSnapshot record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    damageAmount()
    Returns the value of the damageAmount record component.
    double
    damageBuffer()
    Returns the value of the damageBuffer record component.
    double
    diameter()
    Returns the value of the diameter 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.
    final String
    toString()
    Returns a string representation of this record class.
    int
    warningDistance()
    Returns the value of the warningDistance record component.
    int
    warningTime()
    Returns the value of the warningTime record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • WorldBorderSnapshot

      public WorldBorderSnapshot(double diameter, double damageAmount, double damageBuffer, int warningDistance, int warningTime)
      Creates an instance of a WorldBorderSnapshot record class.
      Parameters:
      diameter - the value for the diameter record component
      damageAmount - the value for the damageAmount record component
      damageBuffer - the value for the damageBuffer record component
      warningDistance - the value for the warningDistance record component
      warningTime - the value for the warningTime record component

  • Method Details

    • 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. All components in this record class 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.

    • diameter

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

    • damageAmount

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

    • damageBuffer

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

    • warningDistance

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

    • warningTime

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