Skip to content

UIFocusInputOptions

Defined in: ui/src/types.ts:413

Action names a focus scope polls, one role per key, merged over the defaults move-up, move-down, move-left, move-right, interact and cancel. A role takes one name or a list.

A scope consumes nothing it polls: gameplay code reading the same action in the same frame still sees the press. Use input groups (InputManager.setActiveGroups) to keep menu input out of gameplay.

optional cancel?: string | readonly string[]

Defined in: ui/src/types.ts:419


optional confirm?: string | readonly string[]

Defined in: ui/src/types.ts:418


optional down?: string | readonly string[]

Defined in: ui/src/types.ts:415


optional left?: string | readonly string[]

Defined in: ui/src/types.ts:416


optional repeat?: boolean | { delay?: number; interval?: number; }

Defined in: ui/src/types.ts:426

Hold-to-repeat for the four directions; confirm and cancel never repeat. Defaults to true, taking the input package’s own delay and interval. Repeats count on the raw input clock, so they run while the scene is paused.


optional right?: string | readonly string[]

Defined in: ui/src/types.ts:417


optional up?: string | readonly string[]

Defined in: ui/src/types.ts:414

Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/ui.md.