API Docs for: 1.4.0
Show:

Kiwi.Animations.Sequence Class

Defined in: src\animations\Sequence.ts:10
Module: Animations
Parent Module: Kiwi

A Sequence is a series of cells that are held on a SpriteSheet/TextureAtlas. Sequences are generally used with the AnimationManager/Animation sections as a way to initially create Animations on GameObjects that use the same TextureAtlas.

Constructor

Kiwi.Animations.Sequence

(
  • name
  • cells
  • [speed=0.1]
  • [loop=true]
)
Kiwi.Animations.Sequence

Defined in src\animations\Sequence.ts:10

Parameters:

  • name String

    The name of this sequence. This is not unique.

  • cells Number

    The cells that are in this animation.

  • [speed=0.1] Number optional

    The time an animation should spend on each frame.

  • [loop=true] Boolean optional

    If the sequence should play again if it was animating and the animation reaches the last frame.

Returns:

Kiwi.Animations.Sequence:

Item Index

Properties

Properties

cells

Number public

Defined in src\animations\Sequence.ts:41

The cells that are in this animation. These are a reference to the cells that are contained in a texture atlas that this sequence should be a part of.

loop

Boolean public

Defined in src\animations\Sequence.ts:58

If the sequence should play again if it was animating and the animation reaches the last frame.

name

String public

Defined in src\animations\Sequence.ts:33

The name of this sequence.

speed

Boolean public

Defined in src\animations\Sequence.ts:50

The time an animation should spend on each cell.