Class InputEvent.Key

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.InputEvent

net.neoforged.neoforge.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.

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

Nested Class Summary

Nested classes/interfaces inherited from class InputEvent

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

Field Summary

Fields

Modifier and Type	Field	Description
private final int	action
private final KeyEvent	keyEvent

Constructor Summary

Constructors

Constructor	Description
Key(KeyEvent keyEvent, int action)

Method Summary

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

Methods inherited from class Object

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

Field Details

keyEvent

private final KeyEvent keyEvent

action

private final int action

Constructor Details

Key

@Internal
public Key(KeyEvent keyEvent,
 int action)

Method Details

getKeyEvent

public KeyEvent getKeyEvent()

getKey

public int getKey()

Returns the GLFW (platform-agnostic) key code.

Returns:

the GLFW (platform-agnostic) key code

See Also:

• input constants starting with KEY_
• key constants starting with GLFW_KEY_
• the online GLFW documentation

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:

• InputConstants.getKey(KeyEvent)

getAction

public int getAction()

Returns the mouse button's action.

Returns:

the mouse button's action

See Also:

• InputConstants.PRESS
• InputConstants.RELEASE
• InputConstants.REPEAT

getModifiers

public int getModifiers()

Returns a bit field representing the active modifier keys.

Returns:

a bit field representing the active modifier keys

See Also:

• CTRL modifier key bit
• SHIFT modifier key bit
• ALT modifier key bit
• SUPER modifier key bit
• CAPS LOCK modifier key bit
• NUM LOCK modifier key bit
• the online GLFW documentation