UIFocusSystem
Defined in: ui/src/UIFocusSystem.ts:31
Drives keyboard and gamepad focus: one scope, once a frame.
Runs in LateUpdate at priority 202, after UILayoutSystem and the React
root layout (both 200) and the floating overlay (201), so every
rectangle it searches was computed this frame.
It walks the whole scene stack, paused scenes included, so a pause menu shown over a paused scene takes the keyboard. Layout and hit testing are not filtered by pause either.
Extends
Section titled “Extends”System
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UIFocusSystem():
UIFocusSystem
Returns
Section titled “Returns”UIFocusSystem
Inherited from
Section titled “Inherited from”System.constructor
Properties
Section titled “Properties”context
Section titled “context”
protectedcontext:EngineContext
Defined in: core/dist/index.d.ts:1336
Reference to the engine context, set on registration.
Inherited from
Section titled “Inherited from”System.context
enabled
Section titled “enabled”enabled:
boolean
Defined in: core/dist/index.d.ts:1334
Whether this system is active.
Inherited from
Section titled “Inherited from”System.enabled
readonlyphase:LateUpdate=Phase.LateUpdate
Defined in: ui/src/UIFocusSystem.ts:32
The phase this system runs in.
Overrides
Section titled “Overrides”System.phase
priority
Section titled “priority”
readonlypriority:202=202
Defined in: ui/src/UIFocusSystem.ts:33
Execution priority within the phase. Lower = earlier. Default: 0.
Overrides
Section titled “Overrides”System.priority
Methods
Section titled “Methods”_setContext()
Section titled “_setContext()”_setContext(
context):void
Defined in: core/dist/index.d.ts:1343
Internal
Set the engine context. Called by SystemScheduler when the system is registered.
Parameters
Section titled “Parameters”context
Section titled “context”EngineContext
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”System._setContext
onRegister()
Section titled “onRegister()”onRegister(
context):void
Defined in: ui/src/UIFocusSystem.ts:41
Called once when the system is registered with the engine.
Parameters
Section titled “Parameters”context
Section titled “context”EngineContext
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”System.onRegister
onUnregister()?
Section titled “onUnregister()?”
optionalonUnregister():void
Defined in: core/dist/index.d.ts:1351
Called when the system is removed.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”System.onUnregister
update()
Section titled “update()”update():
void
Defined in: ui/src/UIFocusSystem.ts:46
Called every frame (or every fixed step for FixedUpdate).
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”System.update
protecteduse<T>(key):T
Defined in: core/dist/index.d.ts:1345
Resolve a service by key, cached after first lookup.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”ServiceKey<T>
Returns
Section titled “Returns”T
Inherited from
Section titled “Inherited from”System.use
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.