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 SDL 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.Preedit, 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	getKey()	Returns the SDL physical key code.
int	getKeycode()	Returns the SDL virtual key code.
KeyEvent	getKeyEvent()
int	getModifiers()	Returns a bit field representing the active modifier keys.

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()

getKey

public int getKey()

Returns the SDL physical key code.

Returns:

the SDL physical key code

See Also:

• input constants starting with KEY_
• key constants
• the online SDL documentation

getKeycode

public int getKeycode()

Returns the SDL virtual key code.

Returns:

the SDL virtual key code

See Also:

• input constants starting with KEYCODE_
• key constants starting with SDLK_
• the online SDL documentation

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
• key constants starting with SDL_KMOD
• the online SDL documentation