Module technology.sola.engine
Package technology.sola.engine.input

Record Class MouseEvent

java.lang.Object
java.lang.Record
technology.sola.engine.input.MouseEvent
Record Components:
button - the MouseButton for the event
x - the x coordinate of the event
y - the y coordinate of the event
@NullMarked public record MouseEvent(MouseButton button, int x, int y) extends Record
MouseEvent contains data for a mouse related event.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MouseEvent(int buttonCode, int x, int y)
    Creates a MouseEvent via the MouseButton.getCode().
    MouseEvent(MouseButton button, int x, int y)
    Creates an instance of a MouseEvent record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    MouseButton
    button()
    Returns the value of the button 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.
    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 java.lang.Object

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

  • Constructor Details

    • MouseEvent

      public MouseEvent(int buttonCode, int x, int y)
      Creates a MouseEvent via the MouseButton.getCode().
      Parameters:
      buttonCode - the code of the mouse button for the event
      x - the x coordinate of the event
      y - the y coordinate of the event

    • MouseEvent

      public MouseEvent(MouseButton button, int x, int y)
      Creates an instance of a MouseEvent record class.
      Parameters:
      button - the value for the button record component
      x - the value for the x record component
      y - the value for the y 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • button

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

    • 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