Record Class MazeLocation

java.lang.Object
java.lang.Record
dev.despical.mazeengine.api.model.MazeLocation
Record Components:
worldId - the persistent world UUID
x - the world block X coordinate
y - the world block Y coordinate
z - the world block Z coordinate
public record MazeLocation(UUID worldId, int x, int y, int z) extends Record
Stores a world block position without retaining a live Bukkit world.

The UUID identifies the world persistently, even while it is unloaded. X, Y, and Z are integer block coordinates and may be negative. This value does not check build height, world borders, or whether the world currently exists.

Creation requests interpret this position as the maze's minimum block corner and floor layer. Route endpoints instead use CellPosition indices.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MazeLocation(UUID worldId, int x, int y, int z)
    Constructs a block position with a required world identity.

  • 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.
    final String
    toString()
    Returns a string representation of this record class.
    UUID
    worldId()
    Returns the value of the worldId record component.
    int
    x()
    Returns the value of the x record component.
    int
    y()
    Returns the value of the y record component.
    int
    z()
    Returns the value of the z record component.

    Methods inherited from class Object

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

  • Constructor Details

    • MazeLocation

      public MazeLocation(UUID worldId, int x, int y, int z)
      Constructs a block position with a required world identity.

      No Bukkit world lookup occurs here. APIs that resolve a live destination or submit world work check world availability separately.

      Parameters:
      worldId - the world UUID
      x - the world block X coordinate
      y - the world block Y coordinate
      z - the world block Z coordinate
      Throws:
      NullPointerException - if worldId is null

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

    • y

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

    • z

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