Class AnimationSequence

constructor

• new AnimationSequence(loop): AnimationSequence

• Create the shell of an animation. Once the shell is created, use "to()" to add steps to the animation.

  Parameters

  • loop: boolean

    Should the animation repeat?

  Returns AnimationSequence

Readonly loop

steps

clone

• clone(): AnimationSequence

• Make a clone of this animation

  Returns AnimationSequence

getDuration

• getDuration(): number

• Return the duration of the entire animation sequence

  Returns number

to

• to(imgName, duration): AnimationSequence

• Add a step to an animation

  Parameters

  • imgName: string | Sprite

    The name of the image to add to the animation

  • duration: number

    The time in milliseconds that this image should be shown

  Returns AnimationSequence

  The Animation, so that we can chain calls to "to()"

Static makeSimple

• makeSimple(cfg): AnimationSequence

• Create a "simple" animation (i.e., one that shows each of a set of images for the same amount of time)

  Parameters

  • cfg: {
        images: (string | Sprite)[];
        repeat: boolean;
        timePerFrame: number;
    }

    • images: (string | Sprite)[]

      The names of the images that comprise the animation

    • repeat: boolean

      True if the animation should repeat when it reaches the end

    • timePerFrame: number

      The time to show each image, in milliseconds

  Returns AnimationSequence

  The animation