Skip to main content

Interface: CanvasInputOptions

Defined in: ui/components/canvas-component.ts:41

Optional InputActions driving a canvas's gamepad/keyboard focus navigation. All optional - a canvas with none of these is still fully pointer-interactive, just not focus-navigable.

Extended by​

Properties​

cancelInput?​

optional cancelInput?: TriggerAction

Defined in: ui/components/canvas-component.ts:56

The action that clears this canvas's currently focused element, read by createUiNavigationEcsSystem. Register your own listener on cancelInput.triggerEvent (e.g. to close a menu) - the canvas itself only clears focus.

optional navigateInput?: Axis2dAction

Defined in: ui/components/canvas-component.ts:64

The action that moves this canvas's focus between interactable elements, read by createUiNavigationEcsSystem. A step is taken on the tick the dominant axis first crosses navigationThreshold, not every tick the stick is held over.

submitInput?​

optional submitInput?: TriggerAction

Defined in: ui/components/canvas-component.ts:48

The action that raises onInvoke on the currently focused interactable

  • the gamepad/keyboard counterpart to a pointer click, read by createUiNavigationEcsSystem. Omit to leave this canvas's focused element only invocable by pointer.