Record Class PlatformPlayerAdapter.Coordinates

java.lang.Object
java.lang.Record
net.flectone.pulse.platform.adapter.PlatformPlayerAdapter.Coordinates
Record Components:
x - the X coordinate
y - the Y coordinate
z - the Z coordinate
Enclosing interface:
PlatformPlayerAdapter
public static record PlatformPlayerAdapter.Coordinates(double x, double y, double z, float yaw, float pitch) extends Record
Player coordinates in the world.
Since:
0.8.1

  • Constructor Summary

    Constructors
    Constructor
    Description
    Coordinates(double x, double y, double z, float yaw, float pitch)
    Creates an instance of a Coordinates record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    distance(PlatformPlayerAdapter.Coordinates other)
    The straight-line distance to another point, ignoring the facing angles.
    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.
    float
    pitch()
    Returns the value of the pitch record component.
    final String
    toString()
    Returns a string representation of this record class.
    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

    • Coordinates

      public Coordinates(double x, double y, double z, float yaw, float pitch)
      Creates an instance of a Coordinates record class.
      Parameters:
      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

    • distance

      public double distance(PlatformPlayerAdapter.Coordinates other)
      The straight-line distance to another point, ignoring the facing angles.
      Parameters:
      other - the other point
      Returns:
      the distance

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

    • 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