Record Class Shortcut

java.lang.Object
java.lang.Record
de.luckymcdev.foundryengine.client.util.key.Shortcut
public record Shortcut(int key, boolean ctrl, boolean shift, boolean alt) extends Record

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    alt()
    Returns the value of the alt record component.
    static Shortcut
    alt(int key)
     
    boolean
    ctrl()
    Returns the value of the ctrl record component.
    static Shortcut
    ctrl(int key)
     
    static Shortcut
    ctrlAlt(int key)
     
    static Shortcut
    ctrlShift(int key)
     
    static Shortcut
    empty()
     
    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
    isPressed()
    Returns true on the frame this shortcut is pressed.
    int
    key()
    Returns the value of the key record component.
    static Shortcut
    of(int key)
     
    boolean
    shift()
    Returns the value of the shift record component.
    static Shortcut
    shift(int key)
     
    String
    toLabel()
    Formats a human-readable label like "Ctrl+P" for display in menus.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • Shortcut

      public Shortcut(int key, boolean ctrl, boolean shift, boolean alt)
      Creates an instance of a Shortcut record class.
      Parameters:
      key - the value for the key record component
      ctrl - the value for the ctrl record component
      shift - the value for the shift record component
      alt - the value for the alt record component

  • Method Details

    • of

      public static Shortcut of(int key)

    • ctrl

      public static Shortcut ctrl(int key)

    • shift

      public static Shortcut shift(int key)

    • alt

      public static Shortcut alt(int key)

    • ctrlShift

      public static Shortcut ctrlShift(int key)

    • ctrlAlt

      public static Shortcut ctrlAlt(int key)

    • empty

      public static Shortcut empty()

    • isPressed

      public boolean isPressed()
      Returns true on the frame this shortcut is pressed.

    • toLabel

      public String toLabel()
      Formats a human-readable label like "Ctrl+P" for display in menus.

    • 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

    • 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

    • alt

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