1681-engine / index / Animator
Class: Animator<Name> ​
Defined in: src/anim/Animator.ts:26
Type Parameters ​
| Type Parameter | Default type |
|---|---|
Name extends string | string |
Constructors ​
Constructor ​
new Animator<Name>(clips, initial): Animator<Name>;Defined in: src/anim/Animator.ts:37
Parameters ​
| Parameter | Type |
|---|---|
clips | Record<Name, AnimationClip> |
initial | NoInfer<Name> |
Returns ​
Animator<Name>
Properties ​
onComplete ​
onComplete: ((clip) => void) | null = null;Defined in: src/anim/Animator.ts:33
Called when a clip that does not loop reaches its last frame.
speed ​
speed: number = 1;Defined in: src/anim/Animator.ts:35
Playback speed multiplier (1 normal, 0 paused).
Accessors ​
current ​
Get Signature ​
get current(): Name;Defined in: src/anim/Animator.ts:49
The clip playing.
Returns ​
Name
finished ​
Get Signature ​
get finished(): boolean;Defined in: src/anim/Animator.ts:64
A non-looping clip has reached its last frame.
Returns ​
boolean
frame ​
Get Signature ​
get frame(): string | number;Defined in: src/anim/Animator.ts:54
The frame to show now.
Returns ​
string | number
frameIndex ​
Get Signature ​
get frameIndex(): number;Defined in: src/anim/Animator.ts:59
Which frame of the clip (0-based).
Returns ​
number
Methods ​
play() ​
play(name, restart?): this;Defined in: src/anim/Animator.ts:69
Plays name. The clip already playing keeps its place unless restart.
Parameters ​
| Parameter | Type | Default value |
|---|---|---|
name | Name | undefined |
restart | boolean | false |
Returns ​
this
update() ​
update(dt): boolean;Defined in: src/anim/Animator.ts:83
Advances by dt seconds; returns true when the frame changed.
Parameters ​
| Parameter | Type |
|---|---|
dt | number |
Returns ​
boolean