KeyframeAnimator

Component that manages named keyframe animations.

Multiple animations can play concurrently (bob + pulse). Each animation runs as a Process on the sibling ProcessComponent. Requires a sibling ProcessComponent on the same entity.

Extends

Component

Type Parameters

T

T extends string = string

Constructors

Constructor

new KeyframeAnimator<T>(animations): KeyframeAnimator<T>

Defined in: KeyframeAnimator.ts:33

Parameters

animations

Record<T, KeyframeAnimationDef>

Returns

KeyframeAnimator<T>

Overrides

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

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

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

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

isPlaying()

isPlaying(name): boolean

Defined in: KeyframeAnimator.ts:82

Whether a named animation is currently playing.

Parameters

name

T

Returns

boolean

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: KeyframeAnimator.ts:86

Called when the component is destroyed (entity destroyed or component removed).

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

play()

play(name): void

Defined in: KeyframeAnimator.ts:39

Start (or restart) a named animation.

Parameters

name

T

Returns

void

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

stop()

stop(name): void

Defined in: KeyframeAnimator.ts:70

Stop a named animation.

Parameters

name

T

Returns

void

stopAll()

stopAll(): void

Defined in: KeyframeAnimator.ts:75

Stop all playing animations.

Returns

void

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