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:48

Parameters

name?

string

tags?

Iterable<string, any, any>

Returns

TimerEntity

Inherited from

Entity.constructor

Properties

id

readonly id: number

Defined in: Entity.ts:34

Unique auto-incrementing ID.

Inherited from

Entity.id

name

readonly name: string

Defined in: Entity.ts:36

Display name for debugging.

Inherited from

Entity.name

[TRAITS_KEY]

static [TRAITS_KEY]: Set<symbol>

Defined in: Entity.ts:32

Inherited from

Entity.[TRAITS_KEY]

Accessors

children

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

ReadonlyMap<string, Entity>

Inherited from

Entity.children

isDestroyed

Get Signature

get isDestroyed(): boolean

Defined in: Entity.ts:60

True if destroy() has been called.

Returns

boolean

Inherited from

Entity.isDestroyed

parent

Get Signature

get parent(): Entity | null

Defined in: Entity.ts:65

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

Returns

Entity | null

Inherited from

Entity.parent

scene

Get Signature

get scene(): Scene | null

Defined in: Entity.ts:55

The scene this entity belongs to, or null.

Returns

Scene | null

Inherited from

Entity.scene

Methods

_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

void

Inherited from

Entity._performDestroy

_setScene()

_setScene(scene, callbacks): void

Defined in: Entity.ts:290

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:132

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:75

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:271

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:216

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:194

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:195

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:147

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:211

Get all components as an iterable.

Returns

Iterable<Component>

Inherited from

Entity.getAll

getChild()

getChild(name): Entity

Defined in: Entity.ts:118

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:163

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:274

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:179

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:168

Remove a component by class.

Parameters

cls

ComponentClass

Returns

void

Inherited from

Entity.remove

removeChild()

removeChild(name): Entity

Defined in: Entity.ts:103

Remove a named child. Returns the detached entity.

Parameters

name

string

Returns

Entity

Inherited from

Entity.removeChild

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:268

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

tryGet()

tryGet<C>(cls): C | undefined

Defined in: Entity.ts:158

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:127

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

Parameters

name

string

Returns

Entity | undefined

Inherited from

Entity.tryGetChild