Record Class TeleportDestination

java.lang.Object
java.lang.Record
dev.despical.mazeengine.api.model.TeleportDestination
Record Components:
worldId - the target world UUID
x - the exact world X coordinate
y - the exact world Y coordinate at the player's feet
z - the exact world Z coordinate
yaw - the horizontal facing angle in degrees
pitch - the vertical facing angle in degrees
public record TeleportDestination(UUID worldId, double x, double y, double z, float yaw, float pitch) extends Record
Describes an exact arrival position and orientation in a world.

Unlike MazeLocation, this value retains fractional coordinates and player-facing angles. Y is the position of the player's feet; yaw and pitch use Bukkit's angle conventions in degrees.

No live Bukkit world is retained. Registry destination queries resolve a loaded world before returning this value, but a saved custom destination in a maze snapshot may refer to an unloaded world. Converting it to a Bukkit Location requires looking up its world UUID.

This value describes coordinates only. Constructing it does not validate terrain safety or teleport a player.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TeleportDestination(UUID worldId, double x, double y, double z, float yaw, float pitch)
    Creates an instance of a TeleportDestination 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.
    float
    pitch()
    Returns the value of the pitch record component.
    final String
    toString()
    Returns a string representation of this record class.
    UUID
    worldId()
    Returns the value of the worldId 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

    • TeleportDestination

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

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

    • worldId

      public UUID worldId()
      Returns the value of the worldId record component.
      Returns:
      the value of the worldId 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