Entity
Defined in: Entity.ts:31
An entity is a named container of components with O(1) lookups by type.
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Entity(
name?,tags?):Entity
Defined in: Entity.ts:48
Parameters
Section titled “Parameters”string
Iterable<string, any, any>
Returns
Section titled “Returns”Entity
Properties
Section titled “Properties”
readonlyid:number
Defined in: Entity.ts:34
Unique auto-incrementing ID.
readonlyname:string
Defined in: Entity.ts:36
Display name for debugging.
readonlytags:Set<string>
Defined in: Entity.ts:38
Tags for group queries.
[TRAITS_KEY]
Section titled “[TRAITS_KEY]”
static[TRAITS_KEY]:Set<symbol>
Defined in: Entity.ts:32
Accessors
Section titled “Accessors”children
Section titled “children”Get Signature
Section titled “Get Signature”get children():
ReadonlyMap<string,Entity>
Defined in: Entity.ts:70
Named children as a read-only map. Empty map if no children.
Returns
Section titled “Returns”ReadonlyMap<string, Entity>
isDestroyed
Section titled “isDestroyed”Get Signature
Section titled “Get Signature”get isDestroyed():
boolean
Defined in: Entity.ts:60
True if destroy() has been called.
Returns
Section titled “Returns”boolean
parent
Section titled “parent”Get Signature
Section titled “Get Signature”get parent():
Entity|null
Defined in: Entity.ts:65
The parent entity, or null if this is a root entity.
Returns
Section titled “Returns”Entity | null
Get Signature
Section titled “Get Signature”get scene():
Scene|null
Defined in: Entity.ts:55
The scene this entity belongs to, or null.
Returns
Section titled “Returns”Scene | null
Methods
Section titled “Methods”_performDestroy()
Section titled “_performDestroy()”_performDestroy():
void
Defined in: Entity.ts:235
Internal
Internal: perform actual destruction — remove all components and clear state. Called by Scene during endOfFrame flush.
Returns
Section titled “Returns”void
_setScene()
Section titled “_setScene()”_setScene(
scene,callbacks):void
Defined in: Entity.ts:290
Internal
Internal: set the scene and callbacks. Called by Scene.spawn().
Parameters
Section titled “Parameters”Scene | null
callbacks
Section titled “callbacks”EntityCallbacks | null
Returns
Section titled “Returns”void
add<
C>(component):C
Defined in: Entity.ts:132
Add a component instance. Returns the component for chaining.
Type Parameters
Section titled “Type Parameters”C extends Component
Parameters
Section titled “Parameters”component
Section titled “component”C
Returns
Section titled “Returns”C
addChild()
Section titled “addChild()”addChild(
name,child):void
Defined in: Entity.ts:75
Add a named child entity. Auto-adds to parent’s scene if not already in one.
Parameters
Section titled “Parameters”string
Entity
Returns
Section titled “Returns”void
afterRestore()?
Section titled “afterRestore()?”
optionalafterRestore(data,resolve):void
Defined in: Entity.ts:271
Called after components are restored during save/load. Rebuild non-serializable state here.
Parameters
Section titled “Parameters”unknown
resolve
Section titled “resolve”Returns
Section titled “Returns”void
destroy()
Section titled “destroy()”destroy():
void
Defined in: Entity.ts:216
Mark for deferred destruction. Actual cleanup happens at end of frame.
Returns
Section titled “Returns”void
emit()
Section titled “emit()”Call Signature
Section titled “Call Signature”emit(
token):void
Defined in: Entity.ts:194
Emit a typed event on this entity. Bubbles to the scene.
Parameters
Section titled “Parameters”EventToken<void>
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”emit<
T>(token,data):void
Defined in: Entity.ts:195
Emit a typed event on this entity. Bubbles to the scene.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”EventToken<T>
T
Returns
Section titled “Returns”void
get<
C>(cls):C
Defined in: Entity.ts:147
Get a component by class. Throws if not found.
Type Parameters
Section titled “Type Parameters”C extends Component
Parameters
Section titled “Parameters”Returns
Section titled “Returns”C
getAll()
Section titled “getAll()”getAll():
Iterable<Component>
Defined in: Entity.ts:211
Get all components as an iterable.
Returns
Section titled “Returns”Iterable<Component>
getChild()
Section titled “getChild()”getChild(
name):Entity
Defined in: Entity.ts:118
Get a child by name. Throws if not found.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Entity
has(
cls):boolean
Defined in: Entity.ts:163
Check if entity has a component of the given class.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean
hasTrait()
Section titled “hasTrait()”hasTrait<
T>(token):this is Entity & T
Defined in: Entity.ts:274
Check if this entity’s class implements a given trait. Acts as a type guard.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”TraitToken<T>
Returns
Section titled “Returns”this is Entity & T
on<
T>(token,handler): () =>void
Defined in: Entity.ts:179
Subscribe to a typed event on this entity. Returns an unsubscribe function.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”EventToken<T>
handler
Section titled “handler”(data) => void
Returns
Section titled “Returns”() => void
remove()
Section titled “remove()”remove(
cls):void
Defined in: Entity.ts:168
Remove a component by class.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
removeChild()
Section titled “removeChild()”removeChild(
name):Entity
Defined in: Entity.ts:103
Remove a named child. Returns the detached entity.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Entity
serialize()?
Section titled “serialize()?”
optionalserialize():unknown
Defined in: Entity.ts:268
Return a JSON-serializable snapshot of this entity’s custom state. Used by the save system.
Returns
Section titled “Returns”unknown
setup()?
Section titled “setup()?”
optionalsetup(params):void
Defined in: Entity.ts:265
Optional setup method. Called by scene.spawn(Class, params) after the
entity is wired to its scene, so components can access services.
Override in subclasses — do NOT use the constructor for component setup.
Parameters
Section titled “Parameters”params
Section titled “params”unknown
Returns
Section titled “Returns”void
tryGet()
Section titled “tryGet()”tryGet<
C>(cls):C|undefined
Defined in: Entity.ts:158
Get a component by class, or undefined if not found.
Type Parameters
Section titled “Type Parameters”C extends Component
Parameters
Section titled “Parameters”Returns
Section titled “Returns”C | undefined
tryGetChild()
Section titled “tryGetChild()”tryGetChild(
name):Entity|undefined
Defined in: Entity.ts:127
Get a child by name, or undefined if not found.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Entity | undefined