Package net.minecraftforge.client.event

Class InputEvent.Key

java.lang.Object
net.minecraftforge.eventbus.api.Event
net.minecraftforge.client.event.InputEvent
net.minecraftforge.client.event.InputEvent.Key
Enclosing class:
InputEvent
public static class InputEvent.Key extends InputEvent
Fired when a keyboard key input occurs, such as pressing, releasing, or repeating a key.

This event is not cancellable, and does not have a result.

This event is fired on the main Forge event bus, only on the logical client.

  • Nested Class Summary

    Nested classes/interfaces inherited from class net.minecraftforge.client.event.InputEvent

    InputEvent.InteractionKeyMappingTriggered, InputEvent.Key, InputEvent.MouseButton, InputEvent.MouseScrollingEvent

    Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event

    net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    action
     
    private final int
    key
     
    private final int
    modifiers
     
    private final int
    scanCode
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Key(int key, int scanCode, int action, int modifiers)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getAction()
    Returns the mouse button's action.
    int
    getKey()
    Returns the GLFW (platform-agnostic) key code.
    int
    getModifiers()
    Returns a bit field representing the active modifier keys.
    int
    getScanCode()
    Returns the platform-specific scan code.

    Methods inherited from class net.minecraftforge.eventbus.api.Event

    getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • key

      private final int key

    • scanCode

      private final int scanCode

    • action

      private final int action

    • modifiers

      private final int modifiers

  • Constructor Details

    • Key

      @Internal public Key(int key, int scanCode, int action, int modifiers)

  • Method Details

    • getKey

      public int getKey()
      Returns the GLFW (platform-agnostic) key code.
      Returns:
      the GLFW (platform-agnostic) key code
      See Also:

    • getScanCode

      public int getScanCode()
      Returns the platform-specific scan code.

      The scan code is unique for every key, regardless of whether it has a key code. Scan codes are platform-specific but consistent over time, so keys will have different scan codes depending on the platform but they are safe to save to disk as custom key bindings.

      Returns:
      the platform-specific scan code
      See Also:

    • getAction

      public int getAction()
      Returns the mouse button's action.
      Returns:
      the mouse button's action
      See Also:

    • getModifiers

      public int getModifiers()
      Returns a bit field representing the active modifier keys.
      Returns:
      a bit field representing the active modifier keys
      See Also: