Record Class WorldPosition

java.lang.Object
java.lang.Record
eu.cloudnetservice.modules.bridge.WorldPosition
Record Components:
x - the x coordinate of the position.
y - the y coordinate of the position.
z - the z coordinate of the position.
yaw - the yaw of the position.
pitch - the pitch of the position.
world - the world this position is located on.
group - the group this position is created for.
public record WorldPosition(double x, double y, double z, double yaw, double pitch, @NonNull String world, @Nullable String group) extends Record
A world position represents a position in a platform dependent world.
Since:
4.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Type
    COL_TYPE
     
    private final @Nullable String
    group
    The field for the group record component.
    private final double
    pitch
    The field for the pitch record component.
    private final @NonNull String
    world
    The field for the world record component.
    private final double
    x
    The field for the x record component.
    private final double
    y
    The field for the y record component.
    private final double
    yaw
    The field for the yaw record component.
    private final double
    z
    The field for the z record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    WorldPosition(double x, double y, double z, double yaw, double pitch, @NonNull String world, @Nullable String group)
    Creates an instance of a WorldPosition record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @Nullable String
    group()
    Returns the value of the group record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    pitch()
    Returns the value of the pitch record component.
    final String
    toString()
    Returns a string representation of this record class.
    @NonNull String
    world()
    Returns the value of the world record component.
    double
    x()
    Returns the value of the x record component.
    double
    y()
    Returns the value of the y record component.
    double
    yaw()
    Returns the value of the yaw record component.
    double
    z()
    Returns the value of the z record component.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • x

      private final double x
      The field for the x record component.

    • y

      private final double y
      The field for the y record component.

    • z

      private final double z
      The field for the z record component.

    • yaw

      private final double yaw
      The field for the yaw record component.

    • pitch

      private final double pitch
      The field for the pitch record component.

    • world

      @NonNull private final @NonNull String world
      The field for the world record component.

    • group

      @Nullable private final @Nullable String group
      The field for the group record component.

    • COL_TYPE

      public static final Type COL_TYPE

  • Constructor Details

    • WorldPosition

      public WorldPosition(double x, double y, double z, double yaw, double pitch, @NonNull @NonNull String world, @Nullable @Nullable String group)
      Creates an instance of a WorldPosition 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
      world - the value for the world record component
      group - the value for the group 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. 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.

    • 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 double yaw()
      Returns the value of the yaw record component.
      Returns:
      the value of the yaw record component

    • pitch

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

    • world

      @NonNull public @NonNull String world()
      Returns the value of the world record component.
      Returns:
      the value of the world record component

    • group

      @Nullable public @Nullable String group()
      Returns the value of the group record component.
      Returns:
      the value of the group record component