Record Class KeyInputEvent

java.lang.Object
java.lang.Record
com.botwithus.bot.api.event.KeyInputEvent
Record Components:
key - the virtual key code (VK_*)
alt - whether ALT was held
ctrl - whether CTRL was held
shift - whether SHIFT was held
timestamp - event creation time in milliseconds since epoch
All Implemented Interfaces:
GameEvent
public record KeyInputEvent(int key, boolean alt, boolean ctrl, boolean shift, long timestamp) extends Record implements GameEvent
Fired when a key is pressed while the overlay has keyboard focus.

  • Constructor Summary

    Constructors
    Constructor
    Description
    KeyInputEvent(int key, boolean alt, boolean ctrl, boolean shift)
     
    KeyInputEvent(int key, boolean alt, boolean ctrl, boolean shift, long timestamp)
    Creates an instance of a KeyInputEvent record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    alt()
    Returns the value of the alt record component.
    boolean
    ctrl()
    Returns the value of the ctrl 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.
    int
    key()
    Returns the value of the key record component.
    boolean
    shift()
    Returns the value of the shift record component.
    long
    timestamp()
    Returns the value of the timestamp record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface GameEvent

    type

  • Constructor Details

    • KeyInputEvent

      public KeyInputEvent(int key, boolean alt, boolean ctrl, boolean shift)

    • KeyInputEvent

      public KeyInputEvent(int key, boolean alt, boolean ctrl, boolean shift, long timestamp)
      Creates an instance of a KeyInputEvent record class.
      Parameters:
      key - the value for the key record component
      alt - the value for the alt record component
      ctrl - the value for the ctrl record component
      shift - the value for the shift record component
      timestamp - the value for the timestamp 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.

    • key

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

    • alt

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

    • ctrl

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

    • shift

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

    • timestamp

      public long timestamp()
      Returns the value of the timestamp record component.
      Specified by:
      timestamp in interface GameEvent
      Returns:
      the value of the timestamp record component