AnimationController

Defined in: renderer/src/AnimationController.ts:80

High-level animation controller that manages named animations on top of a sibling AnimatedSpriteComponent.

Provides one-shot locking, per-animation anchors, and type-safe animation names via the generic parameter.

Narrowing the animation-name type — entity.get(AnimationController) returns AnimationController<string> (the default T); the runtime class isn’t generic, and a string-typed instance can’t substitute for a narrower one (the current: T | "" getter is covariant on T). Cast at the field declaration so every consumer downstream sees the narrow type:

type Anim = "idle" | "walk" | "shoot";

class HeroController extends Component {
  private readonly _anim = this.sibling(AnimationController) as
    AnimationController<Anim>;
}

For multi-sprite (head + body + outfit) characters, see LayeredAnimationController — it fans play()/playOneShot() across a list of sibling controllers with a single shared lock timer.

Extends

• Component

Type Parameters

T

T extends string = string

Constructors

Constructor

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

Defined in: renderer/src/AnimationController.ts:95

Parameters

animations

Record<T, AnimationDef>

Returns

AnimationController<T>

Overrides

Component.constructor

Properties

entity

entity: Entity

Defined in: core/dist/index.d.ts:4116

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

---

inspectExclude?

static optional inspectExclude?: readonly string[]

Defined in: core/dist/index.d.ts:4338

Own fields and getters the Inspector leaves out of this component’s reflected state. Use it for bulk data that is not worth a diagnostic copy — a parsed tilemap, a large lookup table. Lists merge down the class chain, so a subclass adds to its base class’s exclusions.

class TilemapComponent extends VisualComponent {
  static inspectExclude = ["data"];
}

Inherited from

Component.inspectExclude

---

updatePriority?

static optional updatePriority?: number

Defined in: core/dist/index.d.ts:4325

Class-level default for updatePriority: every instance runs at this priority unless its own updatePriority is written. Undeclared = 0. Subclasses inherit their base class’s value unless they declare their own. Declare it on a component whose behavior depends on running after (or before) a sibling, so the entity that adds it does not have to control the add order.

class BoundsClamp extends Component {
  static updatePriority = 10; // after the follow that moves the camera
}

Inherited from

Component.updatePriority

Accessors

context

Get Signature

get context(): EngineContext

Defined in: core/dist/index.d.ts:4171

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

Returns

EngineContext

Inherited from

Component.context

---

current

Get Signature

get current(): "" | T

Defined in: renderer/src/AnimationController.ts:113

Currently playing animation name, or "" if none.

Returns

"" | T

---

effectiveEnabled

Get Signature

get effectiveEnabled(): boolean

Defined in: core/dist/index.d.ts:4141

Whether the component is actually running: enabled, on an active entity, and past onAdd. This is the state onEnable and onDisable track — read it when a method has to behave one way live and another way dormant.

Returns

boolean

Inherited from

Component.effectiveEnabled

---

enabled

Get Signature

get enabled(): boolean

Defined in: core/dist/index.d.ts:4133

Whether this component runs. Disabled components are skipped by ComponentUpdateSystem.

Writing this fires onEnable / onDisable when the effective state changes — enabled && entity.isActive. A component disabled here stays disabled through a setActive(false) / setActive(true) cycle on its entity.

Returns

boolean

Set Signature

set enabled(value): void

Defined in: core/dist/index.d.ts:4134

Parameters

value

boolean

Returns

void

Inherited from

SpriteComponent.enabled

---

frame

Get Signature

get frame(): number

Defined in: renderer/src/AnimationController.ts:123

Current frame index of the underlying AnimatedSprite.

Returns

number

---

locked

Get Signature

get locked(): boolean

Defined in: renderer/src/AnimationController.ts:118

True if a one-shot animation is blocking.

Returns

boolean

---

scene

Get Signature

get scene(): Scene

Defined in: core/dist/index.d.ts:4166

Access the entity’s scene. Throws if the entity is not in a scene. Prefer this over threading through this.entity.scene in component code.

Returns

Scene

Inherited from

Component.scene

---

speed

Get Signature

get speed(): number

Defined in: renderer/src/AnimationController.ts:131

Runtime speed multiplier (default 1). A controller owned by a LayeredAnimationController shares this value with every layer.

Returns

number

Set Signature

set speed(value): void

Defined in: renderer/src/AnimationController.ts:135

Parameters

value

number

Returns

void

---

updatePriority

Get Signature

get updatePriority(): number

Defined in: core/dist/index.d.ts:4159

Where this component runs among its siblings. ComponentUpdateSystem calls update / fixedUpdate on an entity’s components in ascending priority; equal priorities run in add order. Undeclared = 0, so a negative value runs before siblings that keep the default and a positive value runs after them. Writable at any time, before or after add(). Defaults to the class’s static updatePriority.

class Player extends Entity {
  setup() {
    this.add(new Mover());
    this.add(new Brain()).updatePriority = -1; // decides before Mover moves
  }
}

Returns

number

Set Signature

set updatePriority(value): void

Defined in: core/dist/index.d.ts:4160

Parameters

value

number

Returns

void

Inherited from

Component.updatePriority

Methods

_applyEnabled()

_applyEnabled(effective): void

Defined in: core/dist/index.d.ts:4273

Internal

Force an effective-enabled transition, firing the hook on a flip. Used by Entity for teardown, where enabled and the entity’s activeness both still read true.

Parameters

effective

boolean

Returns

void

Inherited from

Component._applyEnabled

---

_assertTiming()

_assertTiming(name, options): void

Defined in: renderer/src/AnimationController.ts:258

Internal

Throw if this controller would reject the timing, without deriving a duration from it. LayeredAnimationController checks every layer before any layer switches; when the caller passes an explicit shared duration, no layer’s own duration feeds the timer, so only the frame and speed gates apply.

Parameters

name

T

options

AnimationTimingOptions | undefined

Returns

void

---

_isTornDown()

_isTornDown(): boolean

Defined in: core/dist/index.d.ts:4254

Internal

Internal: true once this component has been removed or its entity destroyed. Components are terminal — Entity.add uses this to reject re-attaching an instance whose cleanups and onDestroy already ran.

Returns

boolean

Inherited from

Component._isTornDown

---

_markTornDown()

_markTornDown(): void

Defined in: core/dist/index.d.ts:4260

Internal

Internal: mark this component torn down. Called by Entity.remove() and Entity._performDestroy() after onDestroy runs.

Returns

void

Inherited from

Component._markTornDown

---

_refreshEnabled()

_refreshEnabled(): void

Defined in: core/dist/index.d.ts:4266

Internal

Recompute effective enabled-ness from enabled and the entity’s activeness, firing the hook on a flip.

Returns

void

Inherited from

Component._refreshEnabled

---

_runCleanups()

_runCleanups(onError?): void

Defined in: core/dist/index.d.ts:4241

Internal

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

Parameters

onError?

(error) => void

Returns

void

Inherited from

Component._runCleanups

---

addCleanup()

protected addCleanup(fn): void

Defined in: core/dist/index.d.ts:4229

Register a cleanup function to run when this component is removed or destroyed, before onDestroy. Use it for what listen, listenScene and listenBus do not cover, such as an unsubscribe from a custom emitter.

Parameters

fn

() => void

Returns

void

Inherited from

Component.addCleanup

---

calcDuration()

calcDuration(name, options?): number

Defined in: renderer/src/AnimationController.ts:242

Calculate the engine-scaled duration (seconds) a one-shot of this animation would take, matching what playOneShot locks for.

Frame-rate independent: PixiJS normalises deltaTime via Ticker.targetFPMS (0.06), so the formula holds at any actual fps. The controller timer and animated sprite both receive engine-scaled time. Throws unless the effective speed is positive and produces a finite duration. Use an explicit one-shot duration for paused or reverse playback.

Parameters

name

T

options?

AnimationTimingOptions

Returns

number

---

destroy()

destroy(): void

Defined in: core/dist/index.d.ts:4247

End this component’s life on its own — the same as entity.remove(SomeClass), without having to name its own class from inside itself, which breaks under subclassing.

Returns

void

Inherited from

Component.destroy

---

fixedUpdate()?

optional fixedUpdate(dt): void

Defined in: core/dist/index.d.ts:4310

Called every fixed timestep by the built-in ComponentUpdateSystem.

Parameters

dt

number

Fixed timestep in seconds, scaled by scene and entity timeScale.

Returns

void

Inherited from

Component.fixedUpdate

---

forcePlay()

forcePlay(name): void

Defined in: renderer/src/AnimationController.ts:217

Clear lock and force-switch to the given animation.

Parameters

name

T

Returns

void

---

has()

has(name): name is T

Defined in: renderer/src/AnimationController.ts:166

Whether this controller defines the given animation name.

Parameters

name

string

Returns

name is T

---

inFrameRange()

inFrameRange(start, end): boolean

Defined in: renderer/src/AnimationController.ts:293

Check whether the current frame is within [start, end] inclusive.

Parameters

start

number

end

number

Returns

boolean

---

listen()

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

Defined in: core/dist/index.d.ts:4211

Subscribe to events from an entity or a state machine, auto-unsubscribe on removal.

this.listen(this.entity, Hurt, ({ dir }) => this.knockback(dir));
this.listen(brain.mode, brain.mode.events.entered, ({ state }) =>
  this.anim.play(state),
);

Type Parameters

T

T

Parameters

source

EventSource

token

EventToken<T>

handler

(data) => void

Returns

void

Inherited from

Component.listen

---

listenBus()

protected listenBus<K>(event, handler): void

Defined in: core/dist/index.d.ts:4222

Subscribe to an engine EventBus event, auto-unsubscribe on removal. Throws when the entity is not in a scene, like listenScene.

Type Parameters

K

K extends keyof EngineEvents

Parameters

event

K

handler

(data) => void

Returns

void

Inherited from

Component.listenBus

---

listenScene()

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

Defined in: core/dist/index.d.ts:4217

Subscribe to scene-level events, auto-unsubscribe on removal. Handlers fire for bubbled entity events (entity = source) and scene.emit events (entity = undefined).

Type Parameters

T

T

Parameters

token

EventToken<T>

handler

(data, entity?) => void

Returns

void

Inherited from

Component.listenScene

---

onAdd()

onAdd(): void

Defined in: renderer/src/AnimationController.ts:299

Auto-play the first defined animation.

Returns

void

Overrides

Component.onAdd

---

onDestroy()

onDestroy(): void

Defined in: renderer/src/AnimationController.ts:308

A live one-shot ends with the component, so its onCancel still runs.

Returns

void

Overrides

Component.onDestroy

---

onDisable()?

optional onDisable(): void

Defined in: core/dist/index.d.ts:4298

Called when the component stops being effectively enabled — enabled went false, the entity (or an ancestor) was deactivated, or the component is being removed or destroyed. Put live resources to sleep here; the component is reused afterwards, so do not free anything onEnable cannot rebuild.

Returns

void

Inherited from

Component.onDisable

---

onEnable()?

optional onEnable(): void

Defined in: core/dist/index.d.ts:4290

Called when the component becomes effectively enabled — enabled is true and the entity is active. Fires right after onAdd() for a component added to an active entity, and again on every later flip. Bring live resources back online here (unpause a sound, show a display object, re-enable a physics body). Game-state reset does not belong here: the hook sees whatever state the component held while dormant.

Returns

void

Inherited from

Component.onEnable

---

play()

play(name): void

Defined in: renderer/src/AnimationController.ts:171

Play a named animation. No-op if already current or locked.

Parameters

name

T

Returns

void

---

playOneShot()

playOneShot(name, options?): void

Defined in: renderer/src/AnimationController.ts:191

Play an animation as a one-shot, locking out other plays until complete. No-op if already locked on the same animation (prevents restart flicker).

Exactly one of onComplete and onCancel runs per one-shot: onComplete when the lock timer plays out, onCancel when another one-shot, forcePlay, unlock or component destruction ends it first. A cancel callback runs after the new state is in place, so calling playOneShot from inside it takes effect.

When options.duration is omitted, the lock duration is auto-calculated from the frames that will actually play — the frame count from startFrame on, at the controller speed times options.speed. Pass an explicit duration to synchronise lock release across multiple controllers (see LayeredAnimationController).

Parameters

name

T

options?

AnimationOneShotOptions

Returns

void

---

service()

protected service<T>(key): T

Defined in: core/dist/index.d.ts:4188

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

readonly input = this.service(InputManagerKey);

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: core/dist/index.d.ts:4199

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. The reference passes instanceof cls before it resolves, so an engine API that checks the type of what it is handed (camera.follow(this.transform)) accepts it.

Type Parameters

C

C extends Component

Parameters

cls

ComponentClass<C>

Returns

C

Inherited from

Component.sibling

---

stateMachine()

protected stateMachine<S>(states, initial, options?): StateMachine<S>

Defined in: core/dist/index.d.ts:4235

Create a state machine whose hooks and event handlers are attributed to this component when they throw. The machine can be declared as a field because service lookup waits until a hook runs.

Type Parameters

S

S extends string

Parameters

states

StateDefinitions<S>

initial

NoInfer<S>

options?

StateMachineOptions

Returns

StateMachine<S>

Inherited from

Component.stateMachine

---

unlock()

unlock(): void

Defined in: renderer/src/AnimationController.ts:226

Manually release the one-shot lock, firing a pending onCancel.

Returns

void

---

update()

update(dt): void

Defined in: renderer/src/AnimationController.ts:313

Tick the one-shot lock timer.

Parameters

dt

number

Returns

void

Overrides

Component.update

---

use()

protected use<T>(key): T

Defined in: core/dist/index.d.ts:4179

Resolve a service by key, cached after first lookup. Scene-scoped values (registered via scene._registerScoped) take precedence over engine scope. A key declared with scope: "scene" that falls back to engine scope emits a one-shot dev warning — almost always signals a missed beforeEnter hook.

Type Parameters

T

T

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.use