Skip to content

input ​

Read keyboard and cursor state and request control or cursor changes.

Functions ​

input.show_cursor ​

Requests Harmony's rendered cursor while the game is focused.

text
input.show_cursor(enabled)

input.disable_input ​

Requests suppression of game controls; does not disable Harmony menu navigation.

text
input.disable_input(disabled)

input.is_key_down ​

Held state for VK 1..254 while the game is focused.

text
input.is_key_down(vk)

input.key_name ​

Existing Harmony display name for that VK.

text
input.key_name(vk)

input.is_focused ​

Whether the game window is foreground.

text
input.is_focused()

input.cursor_position ​

math.vec2 in game-window client pixels; errors if unavailable.

text
input.cursor_position()

Cursor/input requests remain active until cleared or the script stops. Requests are combined across scripts, independently of menu popup capture. util.key_down remains a compatibility alias for input.is_key_down; use events.subscribe for press/release actions instead of polling transitions.