excalibur 0.26.0-alpha.263 → 0.26.0-alpha.267

package/.nvmrc

@@ -1 +1 @@
-14.18.0
+14.18.1

package/CHANGELOG.md

@@ -14,6 +14,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - `withEngine` utils support an aditional options parameter to override the Engine default options.
 - Story to show a play / pause implementation. 
 - `ex.Animation` now support `totalDuration` that will calculate automatically each frame duration based on how many frames have.
+- `ex.Animation` now supports `.reverse()` to reverse the direction of play in an animation, use the `ex.Animation.direction` to inspect if the animation is playing in the `ex.AnimationDirection.Forward` direction or the `ex.AnimationDirection.Backward` direction.
 -
 ### Changed
 

package/build/dist/Graphics/Animation.d.ts

@@ -11,6 +11,16 @@ export interface HasTick {
      */
     tick(elapsedMilliseconds: number, idempotencyToken?: number): void;
 }
+export declare enum AnimationDirection {
+    /**
+     * Animation is playing forwards
+     */
+    Forward = "forward",
+    /**
+     * Animation is play backwards
+     */
+    Backward = "backward"
+}
 export declare enum AnimationStrategy {
     /**
      * Animation ends without displaying anything
@@ -50,6 +60,10 @@ export interface AnimationOptions {
      * List of frames in the order you wish to play them
      */
     frames: Frame[];
+    /**
+     * Optionally reverse the direction of play
+     */
+    reverse?: boolean;
     /**
      * Optionally specify a default frame duration in ms (Default is 1000)
      */
@@ -114,15 +128,61 @@ export declare class Animation extends Graphic implements HasTick {
      * @returns LegacyDrawing.Animation
      */
     static toLegacyAnimation(engine: Engine, animation: Animation): LegacyDrawing.Animation;
+    /**
+     * Returns the current Frame of the animation
+     */
     get currentFrame(): Frame | null;
+    /**
+     * Returns the current frame index of the animation
+     */
+    get currentFrameIndex(): number;
+    /**
+     * Returns `true` if the animation is playing
+     */
     get isPlaying(): boolean;
+    private _reversed;
+    /**
+     * Reverses the play direction of the Animation, this preserves the current frame
+     */
+    reverse(): void;
+    /**
+     * Returns the current play direction of the animation
+     */
+    get direction(): AnimationDirection;
+    /**
+     * Plays or resumes the animation from the current frame
+     */
     play(): void;
+    /**
+     * Pauses the animation on the current frame
+     */
     pause(): void;
+    /**
+     * Reset the animation back to the beginning, including if the animation were done
+     */
     reset(): void;
+    /**
+     * Returns `true` if the animation can end
+     */
     get canFinish(): boolean;
+    /**
+     * Returns `true` if the animation is done, for looping type animations
+     * `ex.AnimationStrategy.PingPong` and `ex.AnimationStrategy.Loop` this will always return `false`
+     *
+     * See the `ex.Animation.canFinish()` method to know if an animation type can end
+     */
     get done(): boolean;
+    /**
+     * Jump the animation immediately to a specific frame if it exists
+     * @param frameNumber
+     */
     goToFrame(frameNumber: number): void;
     private _nextFrame;
+    /**
+     * Called internally by Excalibur to update the state of the animation potential update the current frame
+     * @param elapsedMilliseconds Milliseconds elapsed
+     * @param idempotencyToken Prevents double ticking in a frame by passing a unique token to the frame
+     */
     tick(elapsedMilliseconds: number, idempotencyToken?: number): void;
     private _updateDimensions;
     protected _drawImage(ctx: ExcaliburGraphicsContext, x: number, y: number): void;

package/build/dist/Graphics/Animation.js

@@ -4,6 +4,17 @@ import { EventDispatcher } from '../EventDispatcher';
 import { Logger } from '../Util/Log';
 import { LegacyDrawing } from '..';
 import { Sprite } from '.';
+export var AnimationDirection;
+(function (AnimationDirection) {
+    /**
+     * Animation is playing forwards
+     */
+    AnimationDirection["Forward"] = "forward";
+    /**
+     * Animation is play backwards
+     */
+    AnimationDirection["Backward"] = "backward";
+})(AnimationDirection || (AnimationDirection = {}));
 export var AnimationStrategy;
 (function (AnimationStrategy) {
     /**
@@ -41,16 +52,20 @@ export class Animation extends Graphic {
         this._firstTick = true;
         this._currentFrame = 0;
         this._timeLeftInFrame = 0;
-        this._direction = 1;
+        this._direction = 1; // TODO only used in ping-pong
         this._done = false;
         this._playing = true;
+        this._reversed = false;
         this.frames = options.frames;
         this.strategy = (_a = options.strategy) !== null && _a !== void 0 ? _a : this.strategy;
         this.frameDuration = options.totalDuration ? options.totalDuration / this.frames.length : (_b = options.frameDuration) !== null && _b !== void 0 ? _b : this.frameDuration;
+        if (options.reverse) {
+            this.reverse();
+        }
         this.goToFrame(0);
     }
     clone() {
-        return new Animation(Object.assign({ frames: this.frames.map((f) => (Object.assign({}, f))), frameDuration: this.frameDuration, strategy: this.strategy }, this.cloneGraphicOptions()));
+        return new Animation(Object.assign({ frames: this.frames.map((f) => (Object.assign({}, f))), frameDuration: this.frameDuration, reverse: this._reversed, strategy: this.strategy }, this.cloneGraphicOptions()));
     }
     /**
      * Create an Animation from a [[SpriteSheet]], a list of indices into the sprite sheet, a duration per frame
@@ -101,27 +116,68 @@ export class Animation extends Graphic {
             engine: engine
         });
     }
+    /**
+     * Returns the current Frame of the animation
+     */
     get currentFrame() {
         if (this._currentFrame >= 0 && this._currentFrame < this.frames.length) {
             return this.frames[this._currentFrame];
         }
         return null;
     }
+    /**
+     * Returns the current frame index of the animation
+     */
+    get currentFrameIndex() {
+        return this._currentFrame;
+    }
+    /**
+     * Returns `true` if the animation is playing
+     */
     get isPlaying() {
         return this._playing;
     }
+    /**
+     * Reverses the play direction of the Animation, this preserves the current frame
+     */
+    reverse() {
+        // Don't mutate with the original frame list, create a copy
+        this.frames = this.frames.slice().reverse();
+        this._reversed = !this._reversed;
+    }
+    /**
+     * Returns the current play direction of the animation
+     */
+    get direction() {
+        // Keep logically consistent with ping-pong direction
+        // If ping-pong is forward = 1 and reversed is true then we are logically reversed
+        const reversed = (this._reversed && this._direction === 1) ? true : false;
+        return reversed ? AnimationDirection.Backward : AnimationDirection.Forward;
+    }
+    /**
+     * Plays or resumes the animation from the current frame
+     */
     play() {
         this._playing = true;
     }
+    /**
+     * Pauses the animation on the current frame
+     */
     pause() {
         this._playing = false;
-        this._firstTick = true;
+        this._firstTick = true; // firstTick must be set to emit the proper frame event
     }
+    /**
+     * Reset the animation back to the beginning, including if the animation were done
+     */
     reset() {
         this._done = false;
         this._firstTick = true;
         this._currentFrame = 0;
     }
+    /**
+     * Returns `true` if the animation can end
+     */
     get canFinish() {
         switch (this.strategy) {
             case AnimationStrategy.End:
@@ -133,9 +189,19 @@ export class Animation extends Graphic {
             }
         }
     }
+    /**
+     * Returns `true` if the animation is done, for looping type animations
+     * `ex.AnimationStrategy.PingPong` and `ex.AnimationStrategy.Loop` this will always return `false`
+     *
+     * See the `ex.Animation.canFinish()` method to know if an animation type can end
+     */
     get done() {
         return this._done;
     }
+    /**
+     * Jump the animation immediately to a specific frame if it exists
+     * @param frameNumber
+     */
     goToFrame(frameNumber) {
         var _a, _b;
         this._currentFrame = frameNumber;
@@ -194,6 +260,11 @@ export class Animation extends Graphic {
         }
         return next;
     }
+    /**
+     * Called internally by Excalibur to update the state of the animation potential update the current frame
+     * @param elapsedMilliseconds Milliseconds elapsed
+     * @param idempotencyToken Prevents double ticking in a frame by passing a unique token to the frame
+     */
     tick(elapsedMilliseconds, idempotencyToken = 0) {
         if (this._idempotencyToken === idempotencyToken) {
             return;

package/build/dist/Graphics/Animation.js.map

@@ -1 +1 @@
-{"version":3,"file":"Animation.js","sourceRoot":"","sources":["../../../src/engine/Graphics/Animation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAkB,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAU,aAAa,EAAE,MAAM,IAAI,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAW3B,MAAM,CAAN,IAAY,iBAkBX;AAlBD,WAAY,iBAAiB;IAC3B;;OAEG;IACH,gCAAW,CAAA;IACX;;OAEG;IACH,kCAAa,CAAA;IACb;;OAEG;IACH,0CAAqB,CAAA;IAErB;;OAEG;IACH,sCAAiB,CAAA;AACnB,CAAC,EAlBW,iBAAiB,KAAjB,iBAAiB,QAkB5B;AA6CD;;;;GAIG;AACH,MAAM,OAAO,SAAU,SAAQ,OAAO;IAiBpC,YAAY,OAA0C;;QACpD,KAAK,CAAC,OAAO,CAAC,CAAC;QAhBV,WAAM,GAAG,IAAI,eAAe,CAAM,IAAI,CAAC,CAAC,CAAC,gCAAgC;QACzE,WAAM,GAAY,EAAE,CAAC;QACrB,aAAQ,GAAsB,iBAAiB,CAAC,IAAI,CAAC;QACrD,kBAAa,GAAW,GAAG,CAAC;QAC5B,cAAS,GAAW,CAAC,CAAC;QAErB,sBAAiB,GAAG,CAAC,CAAC,CAAC;QAEvB,eAAU,GAAG,IAAI,CAAC;QAClB,kBAAa,GAAG,CAAC,CAAC;QAClB,qBAAgB,GAAG,CAAC,CAAC;QACrB,eAAU,GAAG,CAAC,CAAC;QACf,UAAK,GAAG,KAAK,CAAC;QACd,aAAQ,GAAG,IAAI,CAAC;QAItB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,MAAA,OAAO,CAAC,QAAQ,mCAAI,IAAI,CAAC,QAAQ,CAAC;QAClD,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAA,OAAO,CAAC,aAAa,mCAAI,IAAI,CAAC,aAAa,CAAC;QACtI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAEM,KAAK;QACV,OAAO,IAAI,SAAS,iBAClB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAM,CAAC,EAAG,CAAC,EAC1C,aAAa,EAAE,IAAI,CAAC,aAAa,EACjC,QAAQ,EAAE,IAAI,CAAC,QAAQ,IACpB,IAAI,CAAC,mBAAmB,EAAE,EAC7B,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,eAAe,CAC3B,WAAwB,EACxB,YAAsB,EACtB,kBAA0B,EAC1B,WAA8B,iBAAiB,CAAC,IAAI;QAEpD,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;QAChD,MAAM,cAAc,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,QAAQ,CAAC,CAAC;QACrF,IAAI,cAAc,CAAC,MAAM,EAAE;YACzB,SAAS,CAAC,OAAO,CAAC,IAAI,CACpB,6DAA6D,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAC/G,CAAC;SACH;QACD,OAAO,IAAI,SAAS,CAAC;YACnB,MAAM,EAAE,WAAW,CAAC,OAAO;iBACxB,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;iBACtD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACX,OAAO,EAAE,CAAC;gBACV,QAAQ,EAAE,kBAAkB;aAC7B,CAAC,CAAC;YACL,QAAQ,EAAE,QAAQ;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,iBAAiB,CAAC,MAAc,EAAE,SAAoB;QAClE,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,OAAiB,CAAC,CAAC,CAAC;QAC5F,OAAO,IAAI,aAAa,CAAC,SAAS,CAAC;YACjC,OAAO,EAAE,aAAa;YACtB,IAAI,EAAE,SAAS,CAAC,QAAQ,KAAK,iBAAiB,CAAC,IAAI;YACnD,WAAW,EAAE,SAAS,CAAC,QAAQ,KAAK,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;YACnG,KAAK,EAAE,SAAS,CAAC,aAAa;YAC9B,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;IAED,IAAW,YAAY;QACrB,IAAI,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YACtE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACxC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,IAAI;QACT,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IACzB,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;IACzB,CAAC;IAED,IAAW,SAAS;QAClB,QAAQ,IAAI,CAAC,QAAQ,EAAE;YACrB,KAAK,iBAAiB,CAAC,GAAG,CAAC;YAC3B,KAAK,iBAAiB,CAAC,MAAM,CAAC,CAAC;gBAC7B,OAAO,IAAI,CAAC;aACb;YACD,OAAO,CAAC,CAAC;gBACP,OAAO,KAAK,CAAC;aACd;SACF;IACH,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEM,SAAS,CAAC,WAAmB;;QAClC,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC;QACjC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAC;QAC3C,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACnD,IAAI,UAAU,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YAC7B,IAAI,CAAC,gBAAgB,GAAG,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,QAAQ,KAAI,IAAI,CAAC,aAAa,CAAC;YACnE,IAAI,CAAC,KAAK,GAAG,MAAA,UAAU,CAAC,OAAO,0CAAE,KAAK,CAAC;YACvC,IAAI,CAAC,MAAM,GAAG,MAAA,UAAU,CAAC,OAAO,0CAAE,MAAM,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,UAAiB,CAAC,CAAC;SAC9C;IACH,CAAC;IAEO,UAAU;QAChB,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,OAAO,YAAY,CAAC;SACrB;QACD,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC;QAEd,QAAQ,IAAI,CAAC,QAAQ,EAAE;YACrB,KAAK,iBAAiB,CAAC,IAAI,CAAC,CAAC;gBAC3B,IAAI,GAAG,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;gBAC/C,IAAI,IAAI,KAAK,CAAC,EAAE;oBACd,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAW,CAAC,CAAC;iBACvC;gBACD,MAAM;aACP;YACD,KAAK,iBAAiB,CAAC,GAAG,CAAC,CAAC;gBAC1B,IAAI,GAAG,YAAY,GAAG,CAAC,CAAC;gBACxB,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;oBAC9B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;oBAClB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;oBACxC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,IAAW,CAAC,CAAC;iBACtC;gBACD,MAAM;aACP;YACD,KAAK,iBAAiB,CAAC,MAAM,CAAC,CAAC;gBAC7B,IAAI,GAAG,KAAK,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAC1D,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;oBAClC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;oBAClB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,IAAW,CAAC,CAAC;iBACtC;gBACD,MAAM;aACP;YACD,KAAK,iBAAiB,CAAC,QAAQ,CAAC,CAAC;gBAC/B,IAAI,YAAY,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;oBACxD,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;oBACrB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAW,CAAC,CAAC;iBACvC;gBAED,IAAI,YAAY,GAAG,IAAI,CAAC,UAAU,GAAG,CAAC,EAAE;oBACtC,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;oBACpB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAW,CAAC,CAAC;iBACvC;gBAED,IAAI,GAAG,YAAY,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAC7D,MAAM;aACP;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,IAAI,CAAC,mBAA2B,EAAE,mBAA2B,CAAC;QACnE,IAAI,IAAI,CAAC,iBAAiB,KAAK,gBAAgB,EAAE;YAC/C,OAAO;SACR;QACD,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAC1C,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,OAAO;SACR;QAED,2CAA2C;QAC3C,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;YACxB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAmB,CAAC,CAAC;SACrD;QAED,IAAI,CAAC,gBAAgB,IAAI,mBAAmB,GAAG,IAAI,CAAC,SAAS,CAAC;QAC9D,IAAI,IAAI,CAAC,gBAAgB,IAAI,CAAC,EAAE;YAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;SACnC;QACD,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;IAEO,iBAAiB;;QACvB,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,IAAI,CAAC,KAAK,GAAG,MAAA,IAAI,CAAC,YAAY,CAAC,OAAO,0CAAE,KAAK,CAAC;YAC9C,IAAI,CAAC,MAAM,GAAG,MAAA,IAAI,CAAC,YAAY,CAAC,OAAO,0CAAE,MAAM,CAAC;SACjD;IACH,CAAC;IAES,UAAU,CAAC,GAA6B,EAAE,CAAS,EAAE,CAAS;QACtE,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;SAC3C;IACH,CAAC;;AApOc,iBAAO,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC"}
+{"version":3,"file":"Animation.js","sourceRoot":"","sources":["../../../src/engine/Graphics/Animation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAkB,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAU,aAAa,EAAE,MAAM,IAAI,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAW3B,MAAM,CAAN,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B;;OAEG;IACH,yCAAmB,CAAA;IACnB;;OAEG;IACH,2CAAqB,CAAA;AACvB,CAAC,EATW,kBAAkB,KAAlB,kBAAkB,QAS7B;AAED,MAAM,CAAN,IAAY,iBAiBX;AAjBD,WAAY,iBAAiB;IAC3B;;OAEG;IACH,gCAAW,CAAA;IACX;;OAEG;IACH,kCAAa,CAAA;IACb;;OAEG;IACH,0CAAqB,CAAA;IACrB;;OAEG;IACH,sCAAiB,CAAA;AACnB,CAAC,EAjBW,iBAAiB,KAAjB,iBAAiB,QAiB5B;AAiDD;;;;GAIG;AACH,MAAM,OAAO,SAAU,SAAQ,OAAO;IAiBpC,YAAY,OAA0C;;QACpD,KAAK,CAAC,OAAO,CAAC,CAAC;QAhBV,WAAM,GAAG,IAAI,eAAe,CAAM,IAAI,CAAC,CAAC,CAAC,gCAAgC;QACzE,WAAM,GAAY,EAAE,CAAC;QACrB,aAAQ,GAAsB,iBAAiB,CAAC,IAAI,CAAC;QACrD,kBAAa,GAAW,GAAG,CAAC;QAC5B,cAAS,GAAW,CAAC,CAAC;QAErB,sBAAiB,GAAG,CAAC,CAAC,CAAC;QAEvB,eAAU,GAAG,IAAI,CAAC;QAClB,kBAAa,GAAG,CAAC,CAAC;QAClB,qBAAgB,GAAG,CAAC,CAAC;QACrB,eAAU,GAAG,CAAC,CAAC,CAAC,8BAA8B;QAC9C,UAAK,GAAG,KAAK,CAAC;QACd,aAAQ,GAAG,IAAI,CAAC;QAyGhB,cAAS,GAAG,KAAK,CAAC;QArGxB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,MAAA,OAAO,CAAC,QAAQ,mCAAI,IAAI,CAAC,QAAQ,CAAC;QAClD,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAA,OAAO,CAAC,aAAa,mCAAI,IAAI,CAAC,aAAa,CAAC;QACtI,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,IAAI,CAAC,OAAO,EAAE,CAAC;SAChB;QACD,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAEM,KAAK;QACV,OAAO,IAAI,SAAS,iBAClB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAM,CAAC,EAAG,CAAC,EAC1C,aAAa,EAAE,IAAI,CAAC,aAAa,EACjC,OAAO,EAAE,IAAI,CAAC,SAAS,EACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ,IACpB,IAAI,CAAC,mBAAmB,EAAE,EAC7B,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,eAAe,CAC3B,WAAwB,EACxB,YAAsB,EACtB,kBAA0B,EAC1B,WAA8B,iBAAiB,CAAC,IAAI;QAEpD,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;QAChD,MAAM,cAAc,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,QAAQ,CAAC,CAAC;QACrF,IAAI,cAAc,CAAC,MAAM,EAAE;YACzB,SAAS,CAAC,OAAO,CAAC,IAAI,CACpB,6DAA6D,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAC/G,CAAC;SACH;QACD,OAAO,IAAI,SAAS,CAAC;YACnB,MAAM,EAAE,WAAW,CAAC,OAAO;iBACxB,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;iBACtD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACX,OAAO,EAAE,CAAC;gBACV,QAAQ,EAAE,kBAAkB;aAC7B,CAAC,CAAC;YACL,QAAQ,EAAE,QAAQ;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,iBAAiB,CAAC,MAAc,EAAE,SAAoB;QAClE,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,OAAiB,CAAC,CAAC,CAAC;QAC5F,OAAO,IAAI,aAAa,CAAC,SAAS,CAAC;YACjC,OAAO,EAAE,aAAa;YACtB,IAAI,EAAE,SAAS,CAAC,QAAQ,KAAK,iBAAiB,CAAC,IAAI;YACnD,WAAW,EAAE,SAAS,CAAC,QAAQ,KAAK,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;YACnG,KAAK,EAAE,SAAS,CAAC,aAAa;YAC9B,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,IAAI,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YACtE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACxC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAGD;;OAEG;IACI,OAAO;QACZ,2DAA2D;QAC3D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAClB,qDAAqD;QACrD,kFAAkF;QAClF,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QAC1E,OAAO,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,OAAO,CAAC;IAC7E,CAAC;IAED;;OAEG;IACI,IAAI;QACT,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,uDAAuD;IACjF,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAClB,QAAQ,IAAI,CAAC,QAAQ,EAAE;YACrB,KAAK,iBAAiB,CAAC,GAAG,CAAC;YAC3B,KAAK,iBAAiB,CAAC,MAAM,CAAC,CAAC;gBAC7B,OAAO,IAAI,CAAC;aACb;YACD,OAAO,CAAC,CAAC;gBACP,OAAO,KAAK,CAAC;aACd;SACF;IACH,CAAC;IAED;;;;;OAKG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,WAAmB;;QAClC,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC;QACjC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAC;QAC3C,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACnD,IAAI,UAAU,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YAC7B,IAAI,CAAC,gBAAgB,GAAG,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,QAAQ,KAAI,IAAI,CAAC,aAAa,CAAC;YACnE,IAAI,CAAC,KAAK,GAAG,MAAA,UAAU,CAAC,OAAO,0CAAE,KAAK,CAAC;YACvC,IAAI,CAAC,MAAM,GAAG,MAAA,UAAU,CAAC,OAAO,0CAAE,MAAM,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,UAAiB,CAAC,CAAC;SAC9C;IACH,CAAC;IAEO,UAAU;QAChB,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,OAAO,YAAY,CAAC;SACrB;QACD,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC;QAEd,QAAQ,IAAI,CAAC,QAAQ,EAAE;YACrB,KAAK,iBAAiB,CAAC,IAAI,CAAC,CAAC;gBAC3B,IAAI,GAAG,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;gBAC/C,IAAI,IAAI,KAAK,CAAC,EAAE;oBACd,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAW,CAAC,CAAC;iBACvC;gBACD,MAAM;aACP;YACD,KAAK,iBAAiB,CAAC,GAAG,CAAC,CAAC;gBAC1B,IAAI,GAAG,YAAY,GAAG,CAAC,CAAC;gBACxB,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;oBAC9B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;oBAClB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;oBACxC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,IAAW,CAAC,CAAC;iBACtC;gBACD,MAAM;aACP;YACD,KAAK,iBAAiB,CAAC,MAAM,CAAC,CAAC;gBAC7B,IAAI,GAAG,KAAK,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAC1D,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;oBAClC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;oBAClB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,IAAW,CAAC,CAAC;iBACtC;gBACD,MAAM;aACP;YACD,KAAK,iBAAiB,CAAC,QAAQ,CAAC,CAAC;gBAC/B,IAAI,YAAY,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;oBACxD,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;oBACrB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAW,CAAC,CAAC;iBACvC;gBAED,IAAI,YAAY,GAAG,IAAI,CAAC,UAAU,GAAG,CAAC,EAAE;oBACtC,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;oBACpB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAW,CAAC,CAAC;iBACvC;gBAED,IAAI,GAAG,YAAY,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAC7D,MAAM;aACP;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,mBAA2B,EAAE,mBAA2B,CAAC;QACnE,IAAI,IAAI,CAAC,iBAAiB,KAAK,gBAAgB,EAAE;YAC/C,OAAO;SACR;QACD,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAC1C,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,OAAO;SACR;QAED,2CAA2C;QAC3C,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;YACxB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAmB,CAAC,CAAC;SACrD;QAED,IAAI,CAAC,gBAAgB,IAAI,mBAAmB,GAAG,IAAI,CAAC,SAAS,CAAC;QAC9D,IAAI,IAAI,CAAC,gBAAgB,IAAI,CAAC,EAAE;YAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;SACnC;QACD,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;IAEO,iBAAiB;;QACvB,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,IAAI,CAAC,KAAK,GAAG,MAAA,IAAI,CAAC,YAAY,CAAC,OAAO,0CAAE,KAAK,CAAC;YAC9C,IAAI,CAAC,MAAM,GAAG,MAAA,IAAI,CAAC,YAAY,CAAC,OAAO,0CAAE,MAAM,CAAC;SACjD;IACH,CAAC;IAES,UAAU,CAAC,GAA6B,EAAE,CAAS,EAAE,CAAS;QACtE,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;SAC3C;IACH,CAAC;;AApSc,iBAAO,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC"}

package/build/dist/excalibur.js

@@ -1,5 +1,5 @@
 /*!
- * excalibur - 0.26.0-alpha.263+f91f4ab - 2021-10-26
+ * excalibur - 0.26.0-alpha.267+ad95c5d - 2021-11-1
  * https://github.com/excaliburjs/Excalibur
  * Copyright (c) 2021 Excalibur.js <https://github.com/excaliburjs/Excalibur/graphs/contributors>
  * Licensed BSD-2-Clause
@@ -1792,6 +1792,7 @@ __webpack_require__.d(__webpack_exports__, {
   "AddedComponent": () => (/* reexport */ AddedComponent),
   "AddedEntity": () => (/* reexport */ AddedEntity),
   "Animation": () => (/* reexport */ Animation),
+  "AnimationDirection": () => (/* reexport */ AnimationDirection),
   "AnimationStrategy": () => (/* reexport */ AnimationStrategy),
   "ArcadeSolver": () => (/* reexport */ ArcadeSolver),
   "AudioContextFactory": () => (/* reexport */ AudioContextFactory),
@@ -19572,6 +19573,17 @@ GraphicsDiagnostics.DrawnImagesCount = 0;
 
 
 
+var AnimationDirection;
+(function (AnimationDirection) {
+    /**
+     * Animation is playing forwards
+     */
+    AnimationDirection["Forward"] = "forward";
+    /**
+     * Animation is play backwards
+     */
+    AnimationDirection["Backward"] = "backward";
+})(AnimationDirection || (AnimationDirection = {}));
 var AnimationStrategy;
 (function (AnimationStrategy) {
     /**
@@ -19609,16 +19621,20 @@ class Animation extends Graphic {
         this._firstTick = true;
         this._currentFrame = 0;
         this._timeLeftInFrame = 0;
-        this._direction = 1;
+        this._direction = 1; // TODO only used in ping-pong
         this._done = false;
         this._playing = true;
+        this._reversed = false;
         this.frames = options.frames;
         this.strategy = (_a = options.strategy) !== null && _a !== void 0 ? _a : this.strategy;
         this.frameDuration = options.totalDuration ? options.totalDuration / this.frames.length : (_b = options.frameDuration) !== null && _b !== void 0 ? _b : this.frameDuration;
+        if (options.reverse) {
+            this.reverse();
+        }
         this.goToFrame(0);
     }
     clone() {
-        return new Animation(Object.assign({ frames: this.frames.map((f) => (Object.assign({}, f))), frameDuration: this.frameDuration, strategy: this.strategy }, this.cloneGraphicOptions()));
+        return new Animation(Object.assign({ frames: this.frames.map((f) => (Object.assign({}, f))), frameDuration: this.frameDuration, reverse: this._reversed, strategy: this.strategy }, this.cloneGraphicOptions()));
     }
     /**
      * Create an Animation from a [[SpriteSheet]], a list of indices into the sprite sheet, a duration per frame
@@ -19669,27 +19685,68 @@ class Animation extends Graphic {
             engine: engine
         });
     }
+    /**
+     * Returns the current Frame of the animation
+     */
     get currentFrame() {
         if (this._currentFrame >= 0 && this._currentFrame < this.frames.length) {
             return this.frames[this._currentFrame];
         }
         return null;
     }
+    /**
+     * Returns the current frame index of the animation
+     */
+    get currentFrameIndex() {
+        return this._currentFrame;
+    }
+    /**
+     * Returns `true` if the animation is playing
+     */
     get isPlaying() {
         return this._playing;
     }
+    /**
+     * Reverses the play direction of the Animation, this preserves the current frame
+     */
+    reverse() {
+        // Don't mutate with the original frame list, create a copy
+        this.frames = this.frames.slice().reverse();
+        this._reversed = !this._reversed;
+    }
+    /**
+     * Returns the current play direction of the animation
+     */
+    get direction() {
+        // Keep logically consistent with ping-pong direction
+        // If ping-pong is forward = 1 and reversed is true then we are logically reversed
+        const reversed = (this._reversed && this._direction === 1) ? true : false;
+        return reversed ? AnimationDirection.Backward : AnimationDirection.Forward;
+    }
+    /**
+     * Plays or resumes the animation from the current frame
+     */
     play() {
         this._playing = true;
     }
+    /**
+     * Pauses the animation on the current frame
+     */
     pause() {
         this._playing = false;
-        this._firstTick = true;
+        this._firstTick = true; // firstTick must be set to emit the proper frame event
     }
+    /**
+     * Reset the animation back to the beginning, including if the animation were done
+     */
     reset() {
         this._done = false;
         this._firstTick = true;
         this._currentFrame = 0;
     }
+    /**
+     * Returns `true` if the animation can end
+     */
     get canFinish() {
         switch (this.strategy) {
             case AnimationStrategy.End:
@@ -19701,9 +19758,19 @@ class Animation extends Graphic {
             }
         }
     }
+    /**
+     * Returns `true` if the animation is done, for looping type animations
+     * `ex.AnimationStrategy.PingPong` and `ex.AnimationStrategy.Loop` this will always return `false`
+     *
+     * See the `ex.Animation.canFinish()` method to know if an animation type can end
+     */
     get done() {
         return this._done;
     }
+    /**
+     * Jump the animation immediately to a specific frame if it exists
+     * @param frameNumber
+     */
     goToFrame(frameNumber) {
         var _a, _b;
         this._currentFrame = frameNumber;
@@ -19762,6 +19829,11 @@ class Animation extends Graphic {
         }
         return next;
     }
+    /**
+     * Called internally by Excalibur to update the state of the animation potential update the current frame
+     * @param elapsedMilliseconds Milliseconds elapsed
+     * @param idempotencyToken Prevents double ticking in a frame by passing a unique token to the frame
+     */
     tick(elapsedMilliseconds, idempotencyToken = 0) {
         if (this._idempotencyToken === idempotencyToken) {
             return;
@@ -28427,7 +28499,7 @@ Promises_Promise = Promise_1 = Promises_decorate([
  * The current Excalibur version string
  * @description `process.env.__EX_VERSION` gets replaced by Webpack on build
  */
-const EX_VERSION = "0.26.0-alpha.263+f91f4ab";
+const EX_VERSION = "0.26.0-alpha.267+ad95c5d";
 
 polyfill();
 // This file is used as the bundle entry point and exports everything