AnimationController

Defined in: packages/three-flatland/src/animation/AnimationController.ts:27

Controls animation playback and state.

Example

const controller = new AnimationController();
controller.addAnimation({
  name: 'walk',
  frames: walkFrames,
  fps: 12,
  loop: true,
});
controller.play('walk');

// In update loop
controller.update(deltaMs, (frame) => {
  sprite.setFrame(frame);
});

Constructors

Constructor

new AnimationController(): AnimationController

Returns

AnimationController

Accessors

currentAnimation

Get Signature

get currentAnimation(): string | null

Defined in: packages/three-flatland/src/animation/AnimationController.ts:311

Get current animation name.

Returns

string | null

Methods

addAnimation()

addAnimation(animation): this

Defined in: packages/three-flatland/src/animation/AnimationController.ts:46

Add an animation definition.

Parameters

animation

Animation

Returns

this

---

addAnimations()

addAnimations(animations): this

Defined in: packages/three-flatland/src/animation/AnimationController.ts:54

Add multiple animations.

Parameters

animations

Animation[]

Returns

this

---

dispose()

dispose(): void

Defined in: packages/three-flatland/src/animation/AnimationController.ts:352

Dispose of resources.

Returns

void

---

getAnimation()

getAnimation(name): Animation | undefined

Defined in: packages/three-flatland/src/animation/AnimationController.ts:75

Get an animation by name.

Parameters

name

string

Returns

Animation | undefined

---

getAnimationDuration()

getAnimationDuration(name): number

Defined in: packages/three-flatland/src/animation/AnimationController.ts:337

Get animation duration in milliseconds.

Parameters

name

string

Returns

number

---

getAnimationNames()

getAnimationNames(): string[]

Defined in: packages/three-flatland/src/animation/AnimationController.ts:82

Get all animation names.

Returns

string[]

---

getCurrentFrame()

getCurrentFrame(): SpriteFrame | null

Defined in: packages/three-flatland/src/animation/AnimationController.ts:276

Get current frame.

Returns

SpriteFrame | null

---

getSpeed()

getSpeed(): number

Defined in: packages/three-flatland/src/animation/AnimationController.ts:318

Get playback speed.

Returns

number

---

getState()

getState(): AnimationState

Defined in: packages/three-flatland/src/animation/AnimationController.ts:286

Get current animation state.

Returns

AnimationState

---

gotoFrame()

gotoFrame(index): this

Defined in: packages/three-flatland/src/animation/AnimationController.ts:158

Go to a specific frame.

Parameters

index

number

Returns

this

---

isPlaying()

isPlaying(name?): boolean

Defined in: packages/three-flatland/src/animation/AnimationController.ts:301

Check if an animation is playing.

Parameters

name?

string

Returns

boolean

---

pause()

pause(): this

Defined in: packages/three-flatland/src/animation/AnimationController.ts:126

Pause the current animation.

Returns

this

---

play()

play(name, options?): this

Defined in: packages/three-flatland/src/animation/AnimationController.ts:89

Play an animation.

Parameters

name

string

options?

PlayOptions

Returns

this

---

removeAnimation()

removeAnimation(name): this

Defined in: packages/three-flatland/src/animation/AnimationController.ts:64

Remove an animation.

Parameters

name

string

Returns

this

---

resume()

resume(): this

Defined in: packages/three-flatland/src/animation/AnimationController.ts:135

Resume a paused animation.

Returns

this

---

setSpeed()

setSpeed(speed): this

Defined in: packages/three-flatland/src/animation/AnimationController.ts:325

Set playback speed.

Parameters

speed

number

Returns

this

---

stop()

stop(): this

Defined in: packages/three-flatland/src/animation/AnimationController.ts:144

Stop the current animation.

Returns

this

---

update()

update(deltaMs, onFrame?, onEvent?): void

Defined in: packages/three-flatland/src/animation/AnimationController.ts:173

Update animation state.

Parameters

deltaMs

number

Time since last update in milliseconds

onFrame?

FrameCallback

Callback when frame changes

onEvent?

EventCallback

Callback when frame event fires

Returns

void