Record Class InputModifiers

java.lang.Object
java.lang.Record
top.untold.frostlumen.core.data.InputModifiers

public record InputModifiers(boolean isShiftPressed, boolean isControlPressed, boolean isAltPressed, boolean isSuperPressed, boolean isCapsLockEnabled, boolean isNumberLockEnabled) extends Record
  • Constructor Summary

    Constructors
    Constructor
    Description
    InputModifiers(boolean isShiftPressed, boolean isControlPressed, boolean isAltPressed, boolean isSuperPressed, boolean isCapsLockEnabled, boolean isNumberLockEnabled)
    Creates an instance of a InputModifiers record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    fromGLFWValue(int modifiers)
     
    final int
    Returns a hash code value for this object.
    boolean
    Returns the value of the isAltPressed record component.
    boolean
    Returns the value of the isCapsLockEnabled record component.
    boolean
    Returns the value of the isControlPressed record component.
    boolean
    Returns the value of the isNumberLockEnabled record component.
    boolean
    Returns the value of the isShiftPressed record component.
    boolean
    Returns the value of the isSuperPressed record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • InputModifiers

      public InputModifiers(boolean isShiftPressed, boolean isControlPressed, boolean isAltPressed, boolean isSuperPressed, boolean isCapsLockEnabled, boolean isNumberLockEnabled)
      Creates an instance of a InputModifiers record class.
      Parameters:
      isShiftPressed - the value for the isShiftPressed record component
      isControlPressed - the value for the isControlPressed record component
      isAltPressed - the value for the isAltPressed record component
      isSuperPressed - the value for the isSuperPressed record component
      isCapsLockEnabled - the value for the isCapsLockEnabled record component
      isNumberLockEnabled - the value for the isNumberLockEnabled record component
  • Method Details

    • fromGLFWValue

      public static InputModifiers fromGLFWValue(int modifiers)
    • 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.
    • isShiftPressed

      public boolean isShiftPressed()
      Returns the value of the isShiftPressed record component.
      Returns:
      the value of the isShiftPressed record component
    • isControlPressed

      public boolean isControlPressed()
      Returns the value of the isControlPressed record component.
      Returns:
      the value of the isControlPressed record component
    • isAltPressed

      public boolean isAltPressed()
      Returns the value of the isAltPressed record component.
      Returns:
      the value of the isAltPressed record component
    • isSuperPressed

      public boolean isSuperPressed()
      Returns the value of the isSuperPressed record component.
      Returns:
      the value of the isSuperPressed record component
    • isCapsLockEnabled

      public boolean isCapsLockEnabled()
      Returns the value of the isCapsLockEnabled record component.
      Returns:
      the value of the isCapsLockEnabled record component
    • isNumberLockEnabled

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