SpriteAnimation

Constructors

new SpriteAnimation()

new SpriteAnimation(props): SpriteAnimation

Creates an instance of sprite animation.

Parameters

• props: SpriteAnimationProps

Returns

SpriteAnimation

Source

src/gameobjects/animation/SpriteAnimation.ts:44

Accessors

duration

get duration(): number

Gets duration (automatically calculated based on framerate)

Returns

number

Source

src/gameobjects/animation/SpriteAnimation.ts:91

framerate

get framerate(): number

Gets framerate

set framerate(value): void

Sets framerate

Parameters

• value: number

Returns

number

Source

src/gameobjects/animation/SpriteAnimation.ts:77

frames

get frames(): number

Gets number of frames

Returns

number

Source

src/gameobjects/animation/SpriteAnimation.ts:70

isLooping

get isLooping(): boolean

Gets whether is looping

Returns

boolean

Source

src/gameobjects/animation/SpriteAnimation.ts:98

Methods

fireOnComplete()

fireOnComplete(reversed?): void

Fires on complete

Parameters

• reversed?: boolean

Returns

void

Source

src/gameobjects/animation/SpriteAnimation.ts:133

fireOnLoop()

fireOnLoop(): void

Fires on loop

Returns

void

Source

src/gameobjects/animation/SpriteAnimation.ts:142

getFrame()

getFrame(frame): Texture<Resource>

Gets a specific frame

Parameters

• frame: number

Returns

Texture<Resource>

frame

Source

src/gameobjects/animation/SpriteAnimation.ts:107

onComplete()

onComplete(callback): void

onComplete

Parameters

• callback

Returns

void

Todo

SH: Optimize the adding of onComplete callbacks (constructor?)

Source

src/gameobjects/animation/SpriteAnimation.ts:117

onLoop()

onLoop(callback): void

onLoop

Parameters

• callback

Returns

void

Source

src/gameobjects/animation/SpriteAnimation.ts:125