Record Class GuiScrollEvent

java.lang.Object
java.lang.Record
dev.boze.api.gui.input.GuiScrollEvent
public record GuiScrollEvent(double x, double y, double horizontal, double vertical) extends Record
A scroll at a position in GUI-scaled pixels. Positive vertical scrolls up.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GuiScrollEvent(double x, double y, double horizontal, double vertical)
    Creates an instance of a GuiScrollEvent 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.
    double
    horizontal()
    Returns the value of the horizontal record component.
    final String
    toString()
    Returns a string representation of this record class.
    double
    vertical()
    Returns the value of the vertical record component.
    double
    x()
    Returns the value of the x record component.
    double
    y()
    Returns the value of the y record component.

    Methods inherited from class Object

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

  • Constructor Details

    • GuiScrollEvent

      public GuiScrollEvent(double x, double y, double horizontal, double vertical)
      Creates an instance of a GuiScrollEvent record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component
      horizontal - the value for the horizontal record component
      vertical - the value for the vertical 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. 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 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

    • horizontal

      public double horizontal()
      Returns the value of the horizontal record component.
      Returns:
      the value of the horizontal record component

    • vertical

      public double vertical()
      Returns the value of the vertical record component.
      Returns:
      the value of the vertical record component