Package com.pixelmonmod.api.client.screen.util

Record Class ScreenArea

java.lang.Object
java.lang.Record
com.pixelmonmod.api.client.screen.util.ScreenArea
Record Components:
x - the left edge of the area
y - the top edge of the area
width - the width of the area
height - the height of the area
public record ScreenArea(int x, int y, int width, int height) extends Record
Immutable rectangular area in GUI screen coordinates.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    bottom()
    Gets the bottom edge of this area.
    boolean
    contains(double x, double y)
    Checks whether the given screen coordinate is inside this area.
    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.
    int
    height()
    Returns the value of the height record component.
    int
    right()
    Gets the right edge of this area.
    final String
    toString()
    Returns a string representation of this record class.
    int
    width()
    Returns the value of the width record component.
    int
    x()
    Returns the value of the x record component.
    int
    x(float relative)
    Gets an x coordinate relative to this area's width.
    int
    y()
    Returns the value of the y record component.
    int
    y(float relative)
    Gets a y coordinate relative to this area's height.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ScreenArea

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

  • Method Details

    • x

      public int x(float relative)
      Gets an x coordinate relative to this area's width.
      Parameters:
      relative - the horizontal position from 0.0F at the left edge to 1.0F at the right edge
      Returns:
      the absolute screen x coordinate

    • y

      public int y(float relative)
      Gets a y coordinate relative to this area's height.
      Parameters:
      relative - the vertical position from 0.0F at the top edge to 1.0F at the bottom edge
      Returns:
      the absolute screen y coordinate

    • right

      public int right()
      Gets the right edge of this area.
      Returns:
      the absolute x coordinate immediately after this area's width

    • bottom

      public int bottom()
      Gets the bottom edge of this area.
      Returns:
      the absolute y coordinate immediately after this area's height

    • contains

      public boolean contains(double x, double y)
      Checks whether the given screen coordinate is inside this area.
      Parameters:
      x - the absolute screen x coordinate
      y - the absolute screen y coordinate
      Returns:
      true if the coordinate is inside or on this area's edges

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

    • width

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

    • height

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