Record Class Position

java.lang.Object
java.lang.Record
fr.mathildeuh.youneedme.api.model.Position
public record Position(String worldName, double x, double y, double z, float yaw, float pitch) extends Record
A storage-friendly, always-serializable coordinate: unlike Location it never requires the target World to be loaded to exist, so it is what every persisted model (homes, warps, last-death location, ...) actually stores.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Position(String worldName, double x, double y, double z, float yaw, float pitch)
    Creates an instance of a Position 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.
    boolean
    isWorldLoaded()
     
    static Position
    of(org.bukkit.Location location)
     
    float
    pitch()
    Returns the value of the pitch record component.
    @Nullable org.bukkit.Location
    toLocation()
    Resolves this position back to a live Location, or null if its world isn't loaded.
    final String
    toString()
    Returns a string representation of this record class.
    String
    worldName()
    Returns the value of the worldName record component.
    double
    x()
    Returns the value of the x record component.
    double
    y()
    Returns the value of the y record component.
    float
    yaw()
    Returns the value of the yaw record component.
    double
    z()
    Returns the value of the z record component.

    Methods inherited from class Object

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

  • Constructor Details

    • Position

      public Position(String worldName, double x, double y, double z, float yaw, float pitch)
      Creates an instance of a Position record class.
      Parameters:
      worldName - the value for the worldName record component
      x - the value for the x record component
      y - the value for the y record component
      z - the value for the z record component
      yaw - the value for the yaw record component
      pitch - the value for the pitch record component

  • Method Details

    • of

      public static Position of(org.bukkit.Location location)

    • toLocation

      @Nullable public @Nullable org.bukkit.Location toLocation()
      Resolves this position back to a live Location, or null if its world isn't loaded.

    • isWorldLoaded

      public boolean isWorldLoaded()

    • 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.

    • worldName

      public String worldName()
      Returns the value of the worldName record component.
      Returns:
      the value of the worldName record component

    • x

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

    • y

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

    • z

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

    • yaw

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

    • pitch

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