Interface SpriteAnimationConfig

Configuration for creating a SpriteAnimation.

const config: SpriteAnimationConfig = {
  frameWidth: 16,
  frameHeight: 16,
  frames: [0, 1, 2, 3],
  speed: 8,
  loop: true,
};

interface SpriteAnimationConfig {
    frameHeight: number;
    frames: number[];
    frameWidth: number;
    loop?: boolean;
    speed: number;
}

Properties

frameHeight: number

Height of a single frame in the sprite sheet, in pixels.

frames: number[]

Ordered array of frame indices into the sprite sheet. Indices are numbered left-to-right, top-to-bottom starting at 0.

frameWidth: number

Width of a single frame in the sprite sheet, in pixels.

loop?: boolean

Whether the animation loops. Defaults to true.

speed: number

Playback speed in frames per second.