TimerEntity

Defined in: TimerEntity.ts:17

A pre-built entity that exposes the ProcessComponent API directly. Useful for scene-level timing without manual component wiring.

const timers = this.spawn(TimerEntity);
timers.run(Process.delay(500, () => { ... }));
const cd = timers.slot({ duration: 300 });

Extends

• Entity

Constructors

Constructor

new TimerEntity(name?, tags?): TimerEntity

Defined in: Entity.ts:72

Parameters

name?

string

tags?

Iterable<string, any, any>

Returns

TimerEntity

Inherited from

Entity.constructor

Properties

id

readonly id: number

Defined in: Entity.ts:36

Unique auto-incrementing ID.

Inherited from

Entity.id

---

key?

readonly optional key?: string

Defined in: Entity.ts:47

Stable identity key, scene-scoped. Set at spawn-time when options.key is passed to scene.spawn / entity.spawnChild; undefined otherwise. Used with scene.findByKey and as a stable id in reactive stores (e.g. a createSet<string>() persisted under "world.opened").

Inherited from

Entity.key

---

name

readonly name: string

Defined in: Entity.ts:38

Display name for debugging.

Inherited from

Entity.name

---

tags

readonly tags: Set<string>

Defined in: Entity.ts:40

Tags for group queries.

Inherited from

Entity.tags

---

timeScale

timeScale: number = 1

Defined in: Entity.ts:62

Per-entity time-scale multiplier. Mirrors Scene.timeScale but scoped to this single entity: the engine composes the delta time passed to this entity’s components (and its ProcessComponent, particle emitters) as dt * scene.timeScale * entity.timeScale. 1 = normal speed, 0.5 = half speed, 0 = frozen, 2 = double speed.

Physics is deliberately NOT affected: PhysicsSystem steps a single shared Rapier world per scene under scene.timeScale only, so a rigid-body entity’s simulation cannot be individually slowed or sped up via this field. Use a kinematic body or scale velocities manually if you need per-body time control.

Inherited from

Entity.timeScale

---

[TRAITS_KEY]

static [TRAITS_KEY]: Set<symbol>

Defined in: Entity.ts:34

Inherited from

Entity.[TRAITS_KEY]

Accessors

children

Get Signature

get children(): ReadonlyMap<string, Entity>

Defined in: Entity.ts:114

Named children as a read-only map. Empty map if no children.

Returns

ReadonlyMap<string, Entity>

Inherited from

Entity.children

---

isDestroyed

Get Signature

get isDestroyed(): boolean

Defined in: Entity.ts:104

True if destroy() has been called.

Returns

boolean

Inherited from

Entity.isDestroyed

---

parent

Get Signature

get parent(): Entity | null

Defined in: Entity.ts:109

The parent entity, or null if this is a root entity.

Returns

Entity | null

Inherited from

Entity.parent

---

scene

Get Signature

get scene(): Scene

Defined in: Entity.ts:89

The scene this entity belongs to. Throws if the entity is not attached to a scene — which in practice only happens before scene.spawn / addChild wires it up, or after destroy() tears it down. Inside lifecycle methods (setup, component onAdd, update, etc.) this is always safe to access.

For the rare case where you genuinely need to inspect whether an entity has a scene (e.g. defensive code in systems iterating a query result), use tryScene instead.

Returns

Scene

Inherited from

Entity.scene

---

tryScene

Get Signature

get tryScene(): Scene | null

Defined in: Entity.ts:99

The scene this entity belongs to, or null if detached.

Returns

Scene | null

Inherited from

Entity.tryScene

Methods

_performDestroy()

_performDestroy(): void

Defined in: Entity.ts:361

Internal

Internal: perform actual destruction — remove all components and clear state. Called by Scene during endOfFrame flush.

Returns

void

Inherited from

Entity._performDestroy

---

_setKey()

_setKey(key): void

Defined in: Entity.ts:445

Internal

Internal: assign the stable identity key. Called by Scene._registerKey during spawn. Throws if the entity already has a key — keys are immutable for an entity’s lifetime.

Parameters

key

string

Returns

void

Inherited from

Entity._setKey

---

_setScene()

_setScene(scene, callbacks): void

Defined in: Entity.ts:431

Internal

Internal: set the scene and callbacks. Called by Scene.spawn().

Parameters

scene

Scene | null

callbacks

EntityCallbacks | null

Returns

void

Inherited from

Entity._setScene

---

add()

add<C>(component): C

Defined in: Entity.ts:257

Add a component instance. Returns the component for chaining.

Type Parameters

C

C extends Component

Parameters

component

C

Returns

C

Inherited from

Entity.add

---

addChild()

addChild(name, child): void

Defined in: Entity.ts:119

Add a named child entity. Auto-adds to parent’s scene if not already in one.

Parameters

name

string

child

Entity

Returns

void

Inherited from

Entity.addChild

---

afterRestore()?

optional afterRestore(data, resolve): void

Defined in: Entity.ts:397

Called after components are restored during save/load. Rebuild non-serializable state here.

Parameters

data

unknown

resolve

SnapshotResolver

Returns

void

Inherited from

Entity.afterRestore

---

cancel()

cancel(tag?): void

Defined in: TimerEntity.ts:32

Parameters

tag?

string

Returns

void

---

destroy()

destroy(): void

Defined in: Entity.ts:342

Mark for deferred destruction. Actual cleanup happens at end of frame.

Returns

void

Inherited from

Entity.destroy

---

emit()

Call Signature

emit(token): void

Defined in: Entity.ts:319

Emit a typed event on this entity. Bubbles to the scene.

Parameters

token

EventToken<void>

Returns

void

Inherited from

Entity.emit

Call Signature

emit<T>(token, data): void

Defined in: Entity.ts:320

Emit a typed event on this entity. Bubbles to the scene.

Type Parameters

T

T

Parameters

token

EventToken<T>

data

T

Returns

void

Inherited from

Entity.emit

---

get()

get<C>(cls): C

Defined in: Entity.ts:272

Get a component by class. Throws if not found.

Type Parameters

C

C extends Component

Parameters

cls

ComponentClass<C>

Returns

C

Inherited from

Entity.get

---

getAll()

getAll(): Iterable<Component>

Defined in: Entity.ts:337

Get all components as an iterable.

Returns

Iterable<Component>

Inherited from

Entity.getAll

---

getChild()

getChild(name): Entity

Defined in: Entity.ts:243

Get a child by name. Throws if not found.

Parameters

name

string

Returns

Entity

Inherited from

Entity.getChild

---

has()

has(cls): boolean

Defined in: Entity.ts:288

Check if entity has a component of the given class.

Parameters

cls

ComponentClass

Returns

boolean

Inherited from

Entity.has

---

hasTrait()

hasTrait<T>(token): this is TimerEntity & T

Defined in: Entity.ts:400

Check if this entity’s class implements a given trait. Acts as a type guard.

Type Parameters

T

T

Parameters

token

TraitToken<T>

Returns

this is TimerEntity & T

Inherited from

Entity.hasTrait

---

on()

on<T>(token, handler): () => void

Defined in: Entity.ts:304

Subscribe to a typed event on this entity. Returns an unsubscribe function.

Type Parameters

T

T

Parameters

token

EventToken<T>

handler

(data) => void

Returns

() => void

Inherited from

Entity.on

---

remove()

remove(cls): void

Defined in: Entity.ts:293

Remove a component by class.

Parameters

cls

ComponentClass

Returns

void

Inherited from

Entity.remove

---

removeChild()

removeChild(name): Entity

Defined in: Entity.ts:228

Remove a named child. Returns the detached entity.

Parameters

name

string

Returns

Entity

Inherited from

Entity.removeChild

---

requireKey()

requireKey(): string

Defined in: Entity.ts:417

Return the stable key, or throw if this entity was spawned without one. Use inside component setup() when the component depends on identity (e.g. reading from a createSet keyed by entity key).

Returns

string

Inherited from

Entity.requireKey

---

run()

run(process, options?): Process

Defined in: TimerEntity.ts:24

Parameters

process

Process

options?

tags?

string[]

Returns

Process

---

serialize()?

optional serialize(): unknown

Defined in: Entity.ts:394

Return a JSON-serializable snapshot of this entity’s custom state. Used by the save system.

Returns

unknown

Inherited from

Entity.serialize

---

setup()

setup(): void

Defined in: TimerEntity.ts:20

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.

Returns

void

Overrides

Entity.setup

---

slot()

slot(config?): ProcessSlot

Defined in: TimerEntity.ts:28

Parameters

config?

ProcessSlotConfig

Returns

ProcessSlot

---

spawnChild()

Call Signature

spawnChild(name, options?): Entity

Defined in: Entity.ts:161

Spawn a new entity in this entity’s scene and add it as a named child. Combines scene.spawn(...) + this.addChild(name, ...) in one call — the idiomatic way to compose entity trees (logical root + visual body

• UI sibling + …).

Mirrors the overload shape of Scene.spawn: pass an Entity subclass (with optional setup params), a Blueprint, or omit for an anonymous base Entity.

this.spawnChild("body", EnemyBody, { color: 0xff6b6b });
this.spawnChild("hp", EnemyHealthBar);

Parameters

name

string

options?

SpawnOptions

Returns

Entity

Inherited from

Entity.spawnChild

Call Signature

spawnChild<E>(name, Class, options?): E

Defined in: Entity.ts:162

Spawn a new entity in this entity’s scene and add it as a named child. Combines scene.spawn(...) + this.addChild(name, ...) in one call — the idiomatic way to compose entity trees (logical root + visual body

• UI sibling + …).

Mirrors the overload shape of Scene.spawn: pass an Entity subclass (with optional setup params), a Blueprint, or omit for an anonymous base Entity.

this.spawnChild("body", EnemyBody, { color: 0xff6b6b });
this.spawnChild("hp", EnemyHealthBar);

Type Parameters

E

E extends Entity

Parameters

name

string

Class

() => E

options?

SpawnOptions

Returns

E

Inherited from

Entity.spawnChild

Call Signature

spawnChild<E, P>(name, Class, params, options?): E

Defined in: Entity.ts:167

Spawn a new entity in this entity’s scene and add it as a named child. Combines scene.spawn(...) + this.addChild(name, ...) in one call — the idiomatic way to compose entity trees (logical root + visual body

• UI sibling + …).

Mirrors the overload shape of Scene.spawn: pass an Entity subclass (with optional setup params), a Blueprint, or omit for an anonymous base Entity.

this.spawnChild("body", EnemyBody, { color: 0xff6b6b });
this.spawnChild("hp", EnemyHealthBar);

Type Parameters

E

E extends Entity

P

P

Parameters

name

string

Class

() => E & object

params

P

options?

SpawnOptions

Returns

E

Inherited from

Entity.spawnChild

Call Signature

spawnChild<P>(name, blueprint, params, options?): Entity

Defined in: Entity.ts:173

Spawn a new entity in this entity’s scene and add it as a named child. Combines scene.spawn(...) + this.addChild(name, ...) in one call — the idiomatic way to compose entity trees (logical root + visual body

• UI sibling + …).

Mirrors the overload shape of Scene.spawn: pass an Entity subclass (with optional setup params), a Blueprint, or omit for an anonymous base Entity.

this.spawnChild("body", EnemyBody, { color: 0xff6b6b });
this.spawnChild("hp", EnemyHealthBar);

Type Parameters

P

P

Parameters

name

string

blueprint

Blueprint<P>

params

P

options?

SpawnOptions

Returns

Entity

Inherited from

Entity.spawnChild

Call Signature

spawnChild(name, blueprint, options?): Entity

Defined in: Entity.ts:180

Spawn a new entity in this entity’s scene and add it as a named child. Combines scene.spawn(...) + this.addChild(name, ...) in one call — the idiomatic way to compose entity trees (logical root + visual body

• UI sibling + …).

Mirrors the overload shape of Scene.spawn: pass an Entity subclass (with optional setup params), a Blueprint, or omit for an anonymous base Entity.

this.spawnChild("body", EnemyBody, { color: 0xff6b6b });
this.spawnChild("hp", EnemyHealthBar);

Parameters

name

string

blueprint

Blueprint<void>

options?

SpawnOptions

Returns

Entity

Inherited from

Entity.spawnChild

---

tryGet()

tryGet<C>(cls): C | undefined

Defined in: Entity.ts:283

Get a component by class, or undefined if not found.

Type Parameters

C

C extends Component

Parameters

cls

ComponentClass<C>

Returns

C | undefined

Inherited from

Entity.tryGet

---

tryGetChild()

tryGetChild(name): Entity | undefined

Defined in: Entity.ts:252

Get a child by name, or undefined if not found.

Parameters

name

string

Returns

Entity | undefined

Inherited from

Entity.tryGetChild