ProcessComponent

Defined in: ProcessComponent.ts:11

A component that holds a set of processes on an entity. Processes are ticked automatically by ProcessSystem each frame. All processes are cancelled when the entity is destroyed.

Extends

Component

Constructors

Constructor

new ProcessComponent(): ProcessComponent

Returns

ProcessComponent

Inherited from

Component.constructor

Properties

enabled

enabled: boolean = true

Defined in: Component.ts:22

Whether this component is active. Disabled components are skipped by ComponentUpdateSystem.

Inherited from

Component.enabled

entity

entity: Entity

Defined in: Component.ts:19

Back-reference to the owning entity. Set by the engine when the component is added to an entity. Do not set manually.

Inherited from

Component.entity

Accessors

context

Get Signature

get context(): EngineContext

Defined in: Component.ts:45

Access the EngineContext from the entity’s scene. Throws if the entity is not in a scene.

Returns

EngineContext

Inherited from

Component.context

count

Get Signature

get count(): number

Defined in: ProcessComponent.ts:56

Number of active (non-completed) processes and slots.

Returns

number

scene

Get Signature

get scene(): Scene

Defined in: Component.ts:31

Access the entity’s scene. Throws if the entity is not in a scene. Prefer this over this.entity.scene! in component methods.

Returns

Scene

Inherited from

Component.scene

Methods

_runCleanups()

_runCleanups(): void

Defined in: Component.ts:140

Internal

Run and clear all registered cleanups. Called by Entity.remove() and Entity._performDestroy() before onRemove/onDestroy.

Returns

void

Inherited from

Component._runCleanups

_tick()

_tick(dt): void

Defined in: ProcessComponent.ts:71

Internal

Advance all processes and slots by dt milliseconds and remove completed one-offs. — called by ProcessSystem

Parameters

dt

number

Returns

void

addCleanup()

protected addCleanup(fn): void

Defined in: Component.ts:130

Parameters

fn

() => void

Returns

void

Inherited from

Component.addCleanup

afterRestore()?

optional afterRestore(data, resolve): void

Defined in: Component.ts:168

Called after onAdd() during save/load restoration. Apply state that depends on onAdd() having run.

Parameters

data

unknown

resolve

SnapshotResolver

Returns

void

Inherited from

Component.afterRestore

cancel()

cancel(tag?): void

Defined in: ProcessComponent.ts:38

Cancel all processes and slots, or only those matching a tag.

Parameters

tag?

string

Returns

void

fixedUpdate()?

optional fixedUpdate(dt): void

Defined in: Component.ts:162

Called every fixed timestep by the built-in ComponentUpdateSystem.

Parameters

dt

number

Returns

void

Inherited from

Component.fixedUpdate

listen()

protected listen<T>(entity, token, handler): void

Defined in: Component.ts:111

Subscribe to events on any entity, auto-unsubscribe on removal.

Type Parameters

T

T

Parameters

entity

Entity

token

EventToken<T>

handler

(data) => void

Returns

void

Inherited from

Component.listen

listenScene()

protected listenScene<T>(token, handler): void

Defined in: Component.ts:121

Subscribe to scene-level bubbled events, auto-unsubscribe on removal.

Type Parameters

T

T

Parameters

token

EventToken<T>

handler

(data, entity) => void

Returns

void

Inherited from

Component.listenScene

onAdd()?

optional onAdd(): void

Defined in: Component.ts:150

Called when the component is added to an entity.

Returns

void

Inherited from

Component.onAdd

onDestroy()

onDestroy(): void

Defined in: ProcessComponent.ts:84

Cancel all processes and slots on entity destroy.

Returns

void

Overrides

Component.onDestroy

onRemove()?

optional onRemove(): void

Defined in: Component.ts:153

Called when the component is removed from an entity.

Returns

void

Inherited from

Component.onRemove

run()

run(process, options?): Process

Defined in: ProcessComponent.ts:19

Run a one-off process (tween, sequence, delay). Optionally apply tags for cancel-by-tag.

Parameters

process

Process

options?

tags?

string[]

Returns

Process

serialize()?

optional serialize(): unknown

Defined in: Component.ts:165

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

Returns

unknown

Inherited from

Component.serialize

service()

protected service<T>(key): T

Defined in: Component.ts:67

Lazy proxy-based service resolution. Can be used at field-declaration time:

readonly camera = this.service(CameraKey);

The actual resolution is deferred until first property access.

Type Parameters

T

T extends object

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.service

sibling()

protected sibling<C>(cls): C

Defined in: Component.ts:92

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

C

C extends Component

Parameters

cls

ComponentClass<C>

Returns

C

Inherited from

Component.sibling

slot()

slot(config?): ProcessSlot

Defined in: ProcessComponent.ts:31

Create a reusable, restartable process slot.

Parameters

config?

ProcessSlotConfig

Returns

ProcessSlot

update()?

optional update(dt): void

Defined in: Component.ts:159

Called every frame by the built-in ComponentUpdateSystem.

Parameters

dt

number

Returns

void

Inherited from

Component.update

use()

protected use<T>(key): T

Defined in: Component.ts:50

Resolve a service by key, cached after first lookup.

Type Parameters

T

T

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.use