Component
Defined in: Component.ts:16
Base class for all components.
Components are the primary authoring model. Game developers write behavior
in components using optional update(dt) and fixedUpdate(dt) methods.
The built-in ComponentUpdateSystem calls these methods automatically.
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Component():
Component
Returns
Section titled “Returns”Component
Properties
Section titled “Properties”enabled
Section titled “enabled”enabled:
boolean=true
Defined in: Component.ts:24
Whether this component is active. Disabled components are skipped by ComponentUpdateSystem.
entity
Section titled “entity”entity:
Entity
Defined in: Component.ts:21
Back-reference to the owning entity. Set by the engine when the component is added to an entity. Do not set manually.
Accessors
Section titled “Accessors”context
Section titled “context”Get Signature
Section titled “Get Signature”get context():
EngineContext
Defined in: Component.ts:48
Access the EngineContext from the entity’s scene. Throws if the entity is not in a scene.
Returns
Section titled “Returns”Get Signature
Section titled “Get Signature”get scene():
Scene
Defined in: Component.ts:34
Access the entity’s scene. Throws if the entity is not in a scene.
Prefer this over threading through this.entity.scene in component
code.
Returns
Section titled “Returns”Methods
Section titled “Methods”_runCleanups()
Section titled “_runCleanups()”_runCleanups():
void
Defined in: Component.ts:172
Internal
Run and clear all registered cleanups. Called by Entity.remove() and Entity._performDestroy() before onRemove/onDestroy.
Returns
Section titled “Returns”void
addCleanup()
Section titled “addCleanup()”
protectedaddCleanup(fn):void
Defined in: Component.ts:162
Register a cleanup function to run when this component is removed or destroyed.
Parameters
Section titled “Parameters”() => void
Returns
Section titled “Returns”void
afterRestore()?
Section titled “afterRestore()?”
optionalafterRestore(data,resolve):void
Defined in: Component.ts:200
Called after onAdd() during save/load restoration. Apply state that depends on onAdd() having run.
Parameters
Section titled “Parameters”unknown
resolve
Section titled “resolve”Returns
Section titled “Returns”void
fixedUpdate()?
Section titled “fixedUpdate()?”
optionalfixedUpdate(dt):void
Defined in: Component.ts:194
Called every fixed timestep by the built-in ComponentUpdateSystem.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
listen()
Section titled “listen()”
protectedlisten<T>(entity,token,handler):void
Defined in: Component.ts:143
Subscribe to events on any entity, auto-unsubscribe on removal.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”entity
Section titled “entity”EventToken<T>
handler
Section titled “handler”(data) => void
Returns
Section titled “Returns”void
listenScene()
Section titled “listenScene()”
protectedlistenScene<T>(token,handler):void
Defined in: Component.ts:153
Subscribe to scene-level bubbled events, auto-unsubscribe on removal.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”EventToken<T>
handler
Section titled “handler”(data, entity) => void
Returns
Section titled “Returns”void
onAdd()?
Section titled “onAdd()?”
optionalonAdd():void
Defined in: Component.ts:182
Called when the component is added to an entity.
Returns
Section titled “Returns”void
onDestroy()?
Section titled “onDestroy()?”
optionalonDestroy():void
Defined in: Component.ts:188
Called when the component is destroyed (entity destroyed or component removed).
Returns
Section titled “Returns”void
onRemove()?
Section titled “onRemove()?”
optionalonRemove():void
Defined in: Component.ts:185
Called when the component is removed from an entity.
Returns
Section titled “Returns”void
serialize()?
Section titled “serialize()?”
optionalserialize():unknown
Defined in: Component.ts:197
Return a JSON-serializable snapshot of this component’s state. Used by the save system.
Returns
Section titled “Returns”unknown
service()
Section titled “service()”
protectedservice<T>(key):T
Defined in: Component.ts:99
Lazy proxy-based service resolution. Can be used at field-declaration time:
readonly input = this.service(InputManagerKey);The actual resolution is deferred until first property access.
Type Parameters
Section titled “Type Parameters”T extends object
Parameters
Section titled “Parameters”ServiceKey<T>
Returns
Section titled “Returns”T
sibling()
Section titled “sibling()”
protectedsibling<C>(cls):C
Defined in: Component.ts:124
Lazy proxy-based sibling component resolution. Can be used at field-declaration time:
readonly anim = this.sibling(AnimatedSpriteComponent);The actual resolution is deferred until first property access.
Type Parameters
Section titled “Type Parameters”C extends Component
Parameters
Section titled “Parameters”Returns
Section titled “Returns”C
update()?
Section titled “update()?”
optionalupdate(dt):void
Defined in: Component.ts:191
Called every frame by the built-in ComponentUpdateSystem.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
protecteduse<T>(key):T
Defined in: Component.ts:59
Resolve a service by key, cached after first lookup. Scene-scoped values
(registered via scene._registerScoped) take precedence over engine
scope. A key declared with scope: "scene" that falls back to engine
scope emits a one-shot dev warning — almost always signals a missed
beforeEnter hook.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”ServiceKey<T>
Returns
Section titled “Returns”T