Files
Manage multiple sprite animations in the same sprite sheet.
\n\nAll methods except SpriteMap.clone are chainable (they return the SpriteMap\ninstance).
\nThe name of the active animation sequence.
\nThe name of the active animation sequence.
\nCreates a new SpriteMap instance.
\nThe image to draw, in the form of one of the following:
\n\nA map (Object) where the keys are the names of animation sequences and the\n values are maps (Objects) specifying the starting and ending frames of the\n relevant animation sequence. All properties are optional:
\n\nAlternatively, instead of the inner values being Objects with the\n properties specified above, they can be Arrays that hold the same values\n (in the same order). This is less clear to read, but more concise to\n write.
\nThis parameter is the same as the options parameter for the Sprite\n class.
\nClone the SpriteMap.
\nA SpriteMap instance that is identical to the current instance.
\nDraw the sprite's current frame.
\nThe canvas graphics context onto which the sprite should be drawn.
\nThe x-coordinate of the canvas graphics context at which the upper-left\n corner of the Sprite should be drawn. This is usually (but not always)\n the horizontal distance in pixels from the left side of the canvas.
\nThe y-coordinate of the canvas graphics context at which the upper-left\n corner of the Sprite should be drawn. This is usually (but not always)\n the vertical distance in pixels from the top of the canvas.
\nThe width of the image when drawn onto the canvas. Defaults to the\n Sprite's projected width, which in turn defaults to the frame width.
\nThe height of the image when drawn onto the canvas. Defaults to the\n Sprite's projected height, which in turn defaults to the frame height.
\nthis
\nReset the active animation sequence to the first frame.
\n\nIf the sequence is running when SpriteMap.reset() is called, it will still\nbe running afterwards, so usually SpriteMap.stop() is called first.
\nthis
\nRun an animation sequence once.
\nA function to call after the animation sequence is done running.
\nThe Sprite that was animated. Its \"spriteMap\" property holds the parent\n SpriteMap.
\nThe name of the animation sequence to start. If not given, defaults to\n the active animation sequence. If no animation sequence is active, the\n default sequence is to show the whole sprite sheet.
\nthis
\nAdd or modify an animation sequence.
\nThe name of the sequence.
\nSpecifies the frames of the animation sequence. If an Array is passed,\n the values should be included in the order below.
\nThe index of the sequence's starting row.
\nDefaults to: 0
The index of the sequence's starting column.
\nDefaults to: 0
The index of the sequence's ending row. Defaults to the Sprite's last\n row.
\nThe index of the sequence's ending column. Defaults to the Sprite's last\n column.
\nDetermines which frames are included in the animation loop. If set to\n true, frames are constrained within startCol and endCol, regardless of\n the row. If set to false (the default), frames will run to the last\n column in the Sprite and then loop back to the first column on the next\n row in the Sprite until reaching the last frame in the loop. More\n details on how this work are documented in the Sprite\n constructor.
\nDefaults to: false
An object with \"horizontal\" and \"vertical\" properties (both Booleans)\n indicating whether the Sprite should be drawn flipped along the\n horizontal or vertical axes.
\nDefaults to: {horizontal: false, vertical: false}
Defaults to: false
Defaults to: false
this
\nStart the animation sequence.
\nThe name of the animation sequence to start. If not given, defaults to\n the active animation sequence. If no animation sequence is active, the\n default sequence is to show the whole sprite sheet.
\nthis
\nRemove an animation sequence.
\nThe animation sequence to remove.
\nthis
\nSwitch the active animation sequence.
\nThe name of the animation sequence to switch to.
\nA Boolean indicating whether to restart the animation sequence if the\n specified sequence is already in use.
\nDefaults to: false
this
\n