Key

const Key: object

Defined in: client/api.d.ts:4992

Client-only, resource-owned physical key bindings exposed as the global Key.

Type Declaration

bind()

bind(key, stateOrHandler, handler?): boolean

Binds a resource-owned handler that fires while the game has foreground input and no UI is capturing it.

Parameters

key

string

Case-insensitive supported keyboard or mouse key name.

stateOrHandler

"down" | "up" | "both" | KeyHandler

Trigger state, or the handler itself to use the default down state.

handler?

KeyHandler

Handler required when an explicit trigger state is provided.

Returns

boolean

True after the binding is installed; invalid keys or states throw.

getLabel()

getLabel(key): string

Returns the current layout’s label for a physical key, even while UI owns input. Query again when refreshing prompts. Throws for unknown keys or non-string arguments.

Parameters

key

string

Case-insensitive physical key name, using the same names as bind.

Returns

string

Uppercase printable text, or an English name such as Enter or Mouse 1. Falls back to the uppercase canonical key name when translation is unavailable.

isDown()

isDown(key): boolean

Queries live physical key state using the same foreground and UI-input gate as binding dispatch.

Parameters

key

string

Case-insensitive supported key name.

Returns

boolean

False when the key is up, the game is backgrounded, UI owns input, or the key name is invalid.

unbind()

unbind(key, state?, handler?): boolean

Removes matching bindings owned by the calling resource; omitting filters removes every binding for the key.

Parameters

key

string

Case-insensitive supported key name.

state?

"down" | "up" | "both"

Optional trigger-state filter.

handler?

KeyHandler

Optional exact handler filter.

Returns

boolean

True when at least one binding was removed.