Class ScreenEvent.KeyInput

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.ScreenEvent

net.neoforged.neoforge.client.event.ScreenEvent.KeyInput

Direct Known Subclasses:

ScreenEvent.KeyPressed, ScreenEvent.KeyReleased

Enclosing class:

ScreenEvent

private abstract static class ScreenEvent.KeyInput
extends ScreenEvent

Fired whenever a keyboard key is pressed or released. See the various subclasses to listen for key pressing or releasing.

See Also:

• ScreenEvent.KeyPressed
• ScreenEvent.KeyReleased
• InputConstants
• the online GLFW documentation

Nested Class Summary

Nested classes/interfaces inherited from class ScreenEvent

ScreenEvent.CharacterTyped, ScreenEvent.Closing, ScreenEvent.Init, ScreenEvent.KeyPressed, ScreenEvent.KeyReleased, ScreenEvent.MouseButtonPressed, ScreenEvent.MouseButtonReleased, ScreenEvent.MouseDragged, ScreenEvent.MouseScrolled, ScreenEvent.Opening, ScreenEvent.Render, ScreenEvent.RenderInventoryMobEffects

Field Summary

Fields

Modifier and Type	Field	Description
private final KeyEvent	keyEvent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KeyInput(Screen screen, KeyEvent keyEvent)

Method Summary

Modifier and Type	Method	Description
int	getKeyCode()	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 ScreenEvent

getScreen

Methods inherited from class Object

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

Field Details

keyEvent

private final KeyEvent keyEvent

Constructor Details

KeyInput

@Internal
protected KeyInput(Screen screen,
 KeyEvent keyEvent)

Method Details

getKeyEvent

public KeyEvent getKeyEvent()

getKeyCode

public int getKeyCode()

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)

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