Kiln API / kiln / SpriteAnimation

Class: SpriteAnimation

A sprite entity's animation: the shared controller (set, trigger, play, state, time) plus the sheet, the shown frame (sheet frame number), clipFrame (index within the clip), and flipX. Made by spriteAnimator(sheet, options).

Extends

• AnimationController

Constructors

Constructor

new SpriteAnimation(sheet?, options?): SpriteAnimation;

Parameters

Parameter	Type	Default value
sheet	SpriteSheet | null	null
options	SpriteAnimatorOptions	{}

Returns

SpriteAnimation

Overrides

AnimationController.constructor

Properties

graph

graph: AnimationGraph | null;

Inherited from

AnimationController.graph

---

state

state: string = '';

The current state's name ('' until the clips are known).

Inherited from

AnimationController.state

---

time

time: number = 0;

Seconds of clip time since the state was entered (keeps growing across loops).

Inherited from

AnimationController.time

---

speed

speed: number = 1;

Playback rate for the whole animator, multiplied with each state's speed.

Inherited from

AnimationController.speed

---

paused

paused: boolean = false;

Holds the playhead (events and transitions wait too).

Inherited from

AnimationController.paused

---

params

readonly params: Record<string, number | boolean> = {};

Parameter values; write them with set().

Inherited from

AnimationController.params

---

triggers

readonly triggers: Set<string>;

Triggers set since the last animation step.

Inherited from

AnimationController.triggers

---

fade

fade: Fade | null = null;

The crossfade in progress, or null.

Inherited from

AnimationController.fade

---

request

protected request: 
  | {
  state: string;
  fade: number | undefined;
  restart: boolean;
}
  | null = null;

play() requests, applied at the start of the next animation step.

Inherited from

AnimationController.request

---

startState

protected startState: string | null;

The state to enter first, overriding the graph's initial state.

Inherited from

AnimationController.startState

---

sheet

sheet: SpriteSheet | null;

---

frame

frame: number = -1;

The sheet frame on screen.

---

clipFrame

clipFrame: number = 0;

The frame's index within the current clip.

---

flipX

flipX: boolean;

---

mesh

mesh: 
  | Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>
  | null = null;

The quad the plugin made (its MeshRef).

---

shown

shown: object;

What the UVs were last written for.

frame

frame: number = -1;

flipX

flipX: boolean = false;

texW

texW: number = 0;

texH

texH: number = 0;

Accessors

stateSpec

Get Signature

get stateSpec(): AnimationStateSpec | undefined;

The current state's spec.

Returns

AnimationStateSpec | undefined

Inherited from

AnimationController.stateSpec

---

clip

Get Signature

get clip(): string;

The current state's clip name.

Returns

string

Inherited from

AnimationController.clip

---

loop

Get Signature

get loop(): LoopMode;

The current state's loop mode.

Returns

LoopMode

Inherited from

AnimationController.loop

---

normalizedTime

Get Signature

get normalizedTime(): number;

Plays of the current clip so far: 0..1 through the first, 1 at the end of a 'once' clip, 2.5 halfway through a third loop.

Returns

number

Inherited from

AnimationController.normalizedTime

---

finished

Get Signature

get finished(): boolean;

A 'once' clip has reached its end.

Returns

boolean

Inherited from

AnimationController.finished

---

weight

Get Signature

get weight(): number;

The crossfade weight of the current state: 0 just after a faded transition, 1 when settled.

Returns

number

Inherited from

AnimationController.weight

---

bound

Get Signature

get bound(): boolean;

True once the plugin has told the controller about its clips.

Returns

boolean

Inherited from

AnimationController.bound

Methods

set()

set(name, value): this;

Sets a parameter declared in the graph's params.

Parameters

Parameter	Type
name	string
value	number | boolean

Returns

this

Inherited from

AnimationController.set

---

get()

get(name): number | boolean | undefined;

A parameter's value.

Parameters

Parameter	Type
name	string

Returns

number | boolean | undefined

Inherited from

AnimationController.get

---

trigger()

trigger(name): this;

Sets a trigger declared in the graph's triggers. It lasts one animation step unless a transition takes it.

Parameters

Parameter	Type
name	string

Returns

this

Inherited from

AnimationController.trigger

---

play()

play(state, options?): this;

Enters a state at the next animation step, skipping transitions. Already in it: nothing, unless restart. fade overrides the graph's crossfade seconds.

Parameters

Parameter	Type
state	string
options	{ fade?: number; restart?: boolean; }
options.fade?	number
options.restart?	boolean

Returns

this

Inherited from

AnimationController.play

---

is()

is(state): boolean;

True when the current state is state.

Parameters

Parameter	Type
state	string

Returns

boolean

Inherited from

AnimationController.is

---

bind()

bind(clips, what): void;

Called by the plugin when the clips are known. Checks every state's clip exists, then enters the first state.

Parameters

Parameter	Type
clips	ReadonlyMap<string, ClipInfo>
what	string

Returns

void

Inherited from

AnimationController.bind

---

clipInfo()

clipInfo(name): ClipInfo | undefined;

Info for a clip by name.

Parameters

Parameter	Type
name	string

Returns

ClipInfo | undefined

Inherited from

AnimationController.clipInfo

---

step()

step(dt, out): void;

One animation step of dt seconds: play() requests, then transitions, then the playhead and its events.

Parameters

Parameter	Type
dt	number
out	AnimationSink

Returns

void

Inherited from

AnimationController.step

---

toJSON()

toJSON(): Record<string, unknown>;

Returns

Record<string, unknown>

Overrides

AnimationController.toJSON