Interface AnimationPlayer

Shared interface for [[EndingAnimationPlayer]] and [[PortraitAnimationPlayer]].

interface AnimationPlayer {
    getHeight(): number;
    getNextDelay(): number;
    getSpeed(): number;
    getWidth(): number;
    next(): void;
    reset(): void;
    setSpeed(speed: number): void;
    start(): void;
    stop(): void;
}

Implemented by

BaseAnimationPlayer

Index

Methods

getHeight getNextDelay getSpeed getWidth next reset setSpeed start stop

Methods

getHeight

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

Returns number
The animation height in pixels.
- Defined in image/AnimationPlayer.ts:63

getNextDelay

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

Returns number
The next delay in milliseconds.
- Defined in image/AnimationPlayer.ts:25

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.
- Defined in image/AnimationPlayer.ts:42

getWidth

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

Returns number
The animation width in pixels.
- Defined in image/AnimationPlayer.ts:56

next

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

Returns void
- Defined in image/AnimationPlayer.ts:18

reset

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

Returns void
- Defined in image/AnimationPlayer.ts:13

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
- Defined in image/AnimationPlayer.ts:49

start

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

Returns void
- Defined in image/AnimationPlayer.ts:30

stop

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

Returns void
- Defined in image/AnimationPlayer.ts:35