UIPlugin
Defined in: ui/src/UIPlugin.ts:45
UIPlugin loads Yoga, installs UI defaults, and registers the layout system.
UI entities attach to the
active scene’s render tree via this.use(SceneRenderTreeKey) — no
dedicated global screen container is created.
Implements
Section titled “Implements”Plugin
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UIPlugin(
options?):UIPlugin
Defined in: ui/src/UIPlugin.ts:59
Parameters
Section titled “Parameters”options?
Section titled “options?”UIPluginOptions = {}
Returns
Section titled “Returns”UIPlugin
Properties
Section titled “Properties”dependencies
Section titled “dependencies”
readonlydependencies:string[]
Defined in: ui/src/UIPlugin.ts:48
Names of plugins this plugin depends on.
Implementation of
Section titled “Implementation of”Plugin.dependencies
readonlyname:"ui"="ui"
Defined in: ui/src/UIPlugin.ts:46
Unique plugin name.
Implementation of
Section titled “Implementation of”Plugin.name
version
Section titled “version”
readonlyversion:"3.0.0"="3.0.0"
Defined in: ui/src/UIPlugin.ts:47
Semantic version string.
Implementation of
Section titled “Implementation of”Plugin.version
Methods
Section titled “Methods”install()
Section titled “install()”install(
context):Promise<void>
Defined in: ui/src/UIPlugin.ts:63
Install services into the engine context. Called in topological order.
Parameters
Section titled “Parameters”context
Section titled “context”EngineContext
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”Plugin.install
onDestroy()
Section titled “onDestroy()”onDestroy():
void
Defined in: ui/src/UIPlugin.ts:102
Called when the engine is destroyed.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Plugin.onDestroy
registerSystems()
Section titled “registerSystems()”registerSystems(
scheduler):void
Defined in: ui/src/UIPlugin.ts:95
Register systems with the scheduler. Called after install.
Parameters
Section titled “Parameters”scheduler
Section titled “scheduler”SystemScheduler
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Plugin.registerSystems
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.