Record Class GuiMouseEvent

java.lang.Object
java.lang.Record
dev.boze.api.gui.input.GuiMouseEvent
Record Components:
button - GLFW mouse button
modifiers - GLFW modifier bits
doubleClick - Whether this press completes a double click
public record GuiMouseEvent(double x, double y, int button, int modifiers, boolean doubleClick) extends Record
A mouse press or release in GUI-scaled pixels.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GuiMouseEvent(double x, double y, int button, int modifiers, boolean doubleClick)
    Creates an instance of a GuiMouseEvent record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    button()
    Returns the value of the button record component.
    boolean
    doubleClick()
    Returns the value of the doubleClick record component.
    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.
    boolean
    isLeft()
     
    boolean
    isMiddle()
     
    boolean
    isRight()
     
    int
    modifiers()
    Returns the value of the modifiers record component.
    final String
    toString()
    Returns a string representation of this record class.
    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

    • GuiMouseEvent

      public GuiMouseEvent(double x, double y, int button, int modifiers, boolean doubleClick)
      Creates an instance of a GuiMouseEvent record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component
      button - the value for the button record component
      modifiers - the value for the modifiers record component
      doubleClick - the value for the doubleClick record component

  • Method Details

    • isLeft

      public boolean isLeft()

    • isRight

      public boolean isRight()

    • isMiddle

      public boolean isMiddle()

    • 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

    • button

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

    • modifiers

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

    • doubleClick

      public boolean doubleClick()
      Returns the value of the doubleClick record component.
      Returns:
      the value of the doubleClick record component