Class BaseAnimationPlayer<A, T>`Abstract`

Abstract base class for animation player implementations.

Type Parameters

A extends BaseImage
T extends BaseImage

Hierarchy (View Summary)

BaseAnimationPlayer
- EndingPlayer
- PortraitPlayer

Implements

AnimationPlayer

Index

Constructors

constructor

Methods

getFrame getHeight getNextDelay getNextDelayInUnits getSpeed getWidth init next nextFrame reset setSpeed start stop

Constructors

`Protected`constructor

new BaseAnimationPlayer<A extends BaseImage, T extends BaseImage>(
animation: A,
onDraw: (frame: T) => void,
): BaseAnimationPlayer<A, T>
Creates a new animation player for the given animation and calling the given draw callback for each animation frame.
Type Parameters
- A extends BaseImage
- T extends BaseImage
Parameters
- animation: A
  The animation to play.
- onDraw: (frame: T) => void
  Callback to call on each frame update. This callback is responsible for actually showing the animation frame to the user.
Returns BaseAnimationPlayer<A, T>
- Defined in image/BaseAnimationPlayer.ts:36

Methods

getFrame

getFrame(): T
Returns the current animation frame.

Returns T
The current animation frame.
- Defined in image/BaseAnimationPlayer.ts:63

getHeight

getHeight(): number
Returns the animation height in pixels.

Returns number
The animation height in pixels.
Implementation of AnimationPlayer.getHeight
- Defined in image/BaseAnimationPlayer.ts:157

getNextDelay

getNextDelay(): number
Returns the delay to wait before rendering the next frame.

Returns number
The next delay in milliseconds.
Implementation of AnimationPlayer.getNextDelay
- Defined in image/BaseAnimationPlayer.ts:98

`Protected` `Abstract`getNextDelayInUnits

getNextDelayInUnits(animation: A): number
Returns the number of time units to wait before rendering the next frame.
Parameters
- animation: A
  The animation to play.
Returns number
The next delay in time units.
- Defined in image/BaseAnimationPlayer.ts:91

getSpeed

getSpeed(): number
Returns the animation speed in milliseconds per time unit. Default is 50.

Returns number
The animation speed in milliseconds per time unit.
Implementation of AnimationPlayer.getSpeed
- Defined in image/BaseAnimationPlayer.ts:130

getWidth

getWidth(): number
Returns the animation width in pixels.

Returns number
The animation width in pixels.
Implementation of AnimationPlayer.getWidth
- Defined in image/BaseAnimationPlayer.ts:148

`Protected` `Abstract`init

init(animation: A): T
Initializes the player. Called for initialization when player is created and each time it is reset.
Parameters
- animation: A
  The animation to play.
Returns T
The base frame to start the animation with.
- Defined in image/BaseAnimationPlayer.ts:48

next(): void
Advances the animation to the next frame.

Returns void
Implementation of AnimationPlayer.next
- Defined in image/BaseAnimationPlayer.ts:81

`Protected` `Abstract`nextFrame

nextFrame(animation: A, currentFrame: T): T
Creates and returns the next frame in the animation.

TODO Do we need a return value here?
Parameters
- animation: A
  The animation to play.
- currentFrame: T
  The current frame.
Returns T
The next frame.
- Defined in image/BaseAnimationPlayer.ts:76

reset

reset(): void
Stops and resets the animation to the base frame.

Returns void
Implementation of AnimationPlayer.reset
- Defined in image/BaseAnimationPlayer.ts:53

setSpeed

setSpeed(speed: number): void
Sets the animation speed in milliseconds per time unit. Default is 50.
Parameters
- speed: number
  The animation speed to set.
Returns void
Implementation of AnimationPlayer.setSpeed
- Defined in image/BaseAnimationPlayer.ts:139

start

start(): void
Starts the animation if not already running.

Returns void
Implementation of AnimationPlayer.start
- Defined in image/BaseAnimationPlayer.ts:105

stop

stop(): void
Stops the animation if currently running.

Returns void
Implementation of AnimationPlayer.stop
- Defined in image/BaseAnimationPlayer.ts:118

Class BaseAnimationPlayer<A, T>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns BaseAnimationPlayer<A, T>

Methods

getFrame

Returns T

getHeight

Returns number

getNextDelay

Returns number

Protected AbstractgetNextDelayInUnits

Parameters

Returns number

getSpeed

Returns number

getWidth

Returns number

Protected Abstractinit

Parameters

Returns T

next

Returns void

Protected AbstractnextFrame

Parameters

Returns T

reset

Returns void

setSpeed

Parameters

Returns void

start

Returns void

stop

Returns void

Settings

On This Page

Class BaseAnimationPlayer<A, T>`Abstract`

`Protected`constructor

`Protected` `Abstract`getNextDelayInUnits

`Protected` `Abstract`init

`Protected` `Abstract`nextFrame