Record Class UiPoint

java.lang.Object
java.lang.Record
guideme.ui.UiPoint
public record UiPoint(int x, int y) extends Record
Represents an integer x,y coordinate in the UI.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final UiPoint
    ZERO
     

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static UiPoint
    fromTopLeft(net.minecraft.client.renderer.Rect2i bounds)
     
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isIn(net.minecraft.client.renderer.Rect2i rect)
     
    UiPoint
    move(int x, int y)
     
    final 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.

    Methods inherited from class Object

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

  • Field Details

    • ZERO

      public static final UiPoint ZERO

  • Constructor Details

    • UiPoint

      public UiPoint(int x, int y)
      Creates an instance of a UiPoint record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component

  • Method Details

    • fromTopLeft

      public static UiPoint fromTopLeft(net.minecraft.client.renderer.Rect2i bounds)

    • move

      public UiPoint move(int x, int y)

    • isIn

      public boolean isIn(net.minecraft.client.renderer.Rect2i rect)

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