FlixelKeyInputManager

class

org.flixelgdx.input.keyboard.FlixelKeyInputManager

public class FlixelKeyInputManager implements FlixelInputProcessorManager

Keyboard input manager backed by Gdx.input.

Access via Flixel.keys after the framework is initialized.

Tracks pressed keys via an internal libGDX InputProcessor. The processor is the authoritative source of "is key X currently pressed", which keeps state correct across every libGDX backend (LWJGL3, Android, iOS, TeaVM). The TeaVM/web backend in particular does not always update Gdx.input.isKeyPressed for every keycode, so the framework cannot rebuild its set from polling each frame; doing so would erase any state the InputProcessor just wrote and break FlixelKeyInputManager.justPressed(int) / FlixelKeyInputManager.justReleased(int) on web. Instead, FlixelKeyInputManager.update() simply records this frame's snapshot for "just" detection without ever touching FlixelKeyInputManager.currentPressedKeys.

Make sure that the processor returned by FlixelKeyInputManager.getInputProcessor() is added to the libGDX input chain (this is wired automatically in FlixelGame.create() via an InputMultiplexer). If you replace the input processor with your own, add this one first so key state still updates.

Constructors

FlixelKeyInputManager()

public FlixelKeyInputManager()

Fields

enabled

public boolean enabled

Whether keyboard input is currently enabled. When false, all key checks return false.

Methods

getInputProcessor()

public InputProcessor getInputProcessor()

Returns the input processor that tracks key state. Add this first to an InputMultiplexer (before other processors) so key state is correct.

update()

public void update()

Called once per frame from the game loop. Reserved for future polling-based fallbacks; today the InputProcessor keeps FlixelKeyInputManager.currentPressedKeys up to date in real time, so this method intentionally does nothing.

Earlier versions rebuilt FlixelKeyInputManager.currentPressedKeys from Gdx.input.isKeyPressed every frame, which clobbered any state the InputProcessor had just written and silently broke FlixelKeyInputManager.justPressed(int), FlixelKeyInputManager.justReleased(int), and the "first" helpers on the TeaVM/web backend (where libGDX does not expose every key through isKeyPressed). The processor is now the only writer.

Call FlixelKeyInputManager.endFrame() at the end of the frame so "just pressed/released" detection works next frame.

endFrame()

public void endFrame()

Captures current key state as "previous" for the next frame. Must be called once per frame at the end of the update cycle (after all state updates) so that FlixelKeyInputManager.firstJustPressed() and FlixelKeyInputManager.firstJustReleased() work correctly next frame.

pressed(int)

public boolean pressed(int key)

Returns whether the given key is currently held down. Returns false when the active debug overlay reports that another UI layer (typically the imgui debugger console) is capturing keyboard input, so typing in a debug text field cannot leak into game-side input (e.g. an ui_accept action bound to ENTER).

Use FlixelKeyInputManager.rawPressed(int) when you specifically need the raw, unsuppressed state (the debug overlay itself uses this for its toggle keys so they keep working even when a text field is focused).

Parameters:

Name	Description
`key`	The key to check if it is pressed. (e.g. FlixelKey.A, `Keys`)

Returns: true if the key is pressed and input is enabled and not suppressed by UI.

rawPressed(int)

public boolean rawPressed(int key)

Same as FlixelKeyInputManager.pressed(int) but bypasses the "captured by debug UI" check. Intended for the debug overlay's own toggle keys and tools, which must keep responding even while a Dear ImGui text input has focus.

Parameters:

Name	Description
`key`	The key to check if it is pressed.

Returns: true if the key is pressed and input is enabled, regardless of UI capture.

justPressed(int)

public boolean justPressed(int key)

Returns whether the given key was just pressed this frame. Returns false while the active debug overlay reports that another UI layer is capturing keyboard input. Uses the same current vs previous key sets as FlixelKeyInputManager.justReleased(int) and FlixelKeyInputManager.firstJustPressed() so "just" transitions stay reliable on all backends (for example, WebGL where Gdx.input.isKeyJustPressed is not dependable).

Parameters:

Name	Description
`key`	key code

Returns: true if the key was just pressed and input is enabled and not suppressed by UI.

rawJustPressed(int)

public boolean rawJustPressed(int key)

Same as FlixelKeyInputManager.justPressed(int) but bypasses the "captured by debug UI" check. Use this for input that must keep working regardless of UI capture.

Parameters:

Name	Description
`key`	key code

Returns: true if the key was just pressed and input is enabled, regardless of UI capture.

justReleased(int)

public boolean justReleased(int key)

Returns whether the given key was just released this frame. Returns false while the active debug overlay reports that another UI layer is capturing keyboard input.

Parameters:

Name	Description
`key`	key code

Returns: true if the key was pressed last frame and is not pressed now, and input is enabled and not suppressed by UI.

rawJustReleased(int)

public boolean rawJustReleased(int key)

Same as FlixelKeyInputManager.justReleased(int) but bypasses the "captured by debug UI" check.

Parameters:

Name	Description
`key`	The key code to check if it was just released.

Returns: true if the key was just released and input is enabled, regardless of UI capture.

anyPressed(int)

public boolean anyPressed(int k1)

Returns whether at least one of the given keys is currently pressed.

Parameters:

Name	Description
`k1`	The first key code to check.