Record Class BlockPosition

java.lang.Object
java.lang.Record
fr.robie.machineengine.api.world.BlockPosition
public record BlockPosition(int x, int y, int z) extends Record
A block position.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BlockPosition(int x, int y, int z)
    Creates an instance of a BlockPosition record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    chunkX()
     
    int
    chunkZ()
     
    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.
    @NotNull BlockPosition
    relative(@NotNull Direction direction)
     
    @NotNull String
    toString()
    Returns a string representation of this record class.
    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

    • BlockPosition

      public BlockPosition(int x, int y, int z)
      Creates an instance of a BlockPosition 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

  • Method Details

    • relative

      @NotNull public @NotNull BlockPosition relative(@NotNull @NotNull Direction direction)

    • chunkX

      public int chunkX()

    • chunkZ

      public int chunkZ()

    • toString

      @NotNull public @NotNull 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 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