FloatingOverlaySystem
Defined in: ui/src/FloatingOverlaySystem.ts:18
Re-anchors every scene’s floating overlay (tooltips/popovers/menus) once
per frame. Runs in LateUpdate at priority 201 — after
UILayoutSystem (priority 200) so floats read up-to-date trigger
geometry, and after any React UIRootLayoutSystem.
Crucially this drives the overlay with no UIRoot required: it walks
SceneManager.activeScenes, resolves each scene’s FloatingOverlay +
render tree, attaches the overlay layer idempotently, then ticks it
against the renderer viewport. So attachTooltip works in a pure
imperative scene that never mounts a React tree.
Extends
Section titled “Extends”System
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FloatingOverlaySystem():
FloatingOverlaySystem
Returns
Section titled “Returns”FloatingOverlaySystem
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:1086
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:1084
Whether this system is active.
Inherited from
Section titled “Inherited from”System.enabled
readonlyphase:LateUpdate=Phase.LateUpdate
Defined in: ui/src/FloatingOverlaySystem.ts:19
The phase this system runs in.
Overrides
Section titled “Overrides”System.phase
priority
Section titled “priority”
readonlypriority:201=201
Defined in: ui/src/FloatingOverlaySystem.ts:20
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:1093
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/FloatingOverlaySystem.ts:24
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:1101
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/FloatingOverlaySystem.ts:28
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:1095
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