Added in all of the animation callbacks (start, repeat, update and complete), and user-defined arguments for each of them + callback scope.

Author: photonstorm

v3/src/animation/AnimationManager.js

@@ -44,22 +44,28 @@ AnimationManager.prototype = {
     //  {
     //      frames: [
     //          { key: textureKey, frame: textureFrame },
-    //          { key: textureKey, frame: textureFrame, duration: float },
-    //          { key: textureKey, frame: textureFrame, onUpdate: function }
+    //          { key: textureKey, frame: textureFrame, duration: float }
     //          { key: textureKey, frame: textureFrame, visible: boolean }
+    //          { key: textureKey, frame: textureFrame, onUpdate: function }
     //      ]
     //      framerate: integer
     //      duration: float (seconds, optional, ignored if framerate is set)
     //      skipMissedFrames: boolean
     //      delay: integer
-    //      repeat: -1 = forever, otherwise integer
+    //      repeat: integer (-1 = forever)
     //      repeatDelay: integer
     //      yoyo: boolean
     //      showOnStart: boolean
     //      hideOnComplete: boolean
+    //      callbackScope: Object
     //      onStart: function
+    //      onStartParams: array
     //      onRepeat: function
+    //      onRepeatParams: array
+    //      onUpdate: function
+    //      onUpdateParams: array
     //      onComplete: function
+    //      onCompleteParams: array
     //      transitions: [
     //          {
     //              key: string <- key of the animation to blend with,

v3/src/animation/frame/Animation.js

@@ -61,11 +61,20 @@ var Animation = function (manager, key, config)
     //  Should sprite.visible = false when the animation finishes?
     this.hideOnComplete = GetObjectValue(config, 'hideOnComplete', false);
 
-    //  Callbacks (swap for Events?)
+    //  Callbacks
+    this.callbackScope = GetObjectValue(config, 'callbackScope', this);
+
     this.onStart = GetObjectValue(config, 'onStart', false);
+    this.onStartParams = GetObjectValue(config, 'onStartParams', []);
+
     this.onRepeat = GetObjectValue(config, 'onRepeat', false);
+    this.onRepeatParams = GetObjectValue(config, 'onRepeatParams', []);
+
+    this.onUpdate = GetObjectValue(config, 'onUpdate', false);
+    this.onUpdateParams = GetObjectValue(config, 'onUpdateParams', []);
+
     this.onComplete = GetObjectValue(config, 'onComplete', false);
-    this.onStop = GetObjectValue(config, 'onStop', false);
+    this.onCompleteParams = GetObjectValue(config, 'onCompleteParams', []);
 };
 
 Animation.prototype.constructor = Animation;
@@ -92,6 +101,8 @@ Animation.prototype = {
             component._repeat = this.repeat;
             component._repeatDelay = this.repeatDelay;
             component._yoyo = this.yoyo;
+            component._callbackArgs[1] = this;
+            component._updateParams = component._callbackArgs.concat(this.onUpdateParams);
         }
 
         component.updateFrame(this.frames[startFrame]);
@@ -209,21 +220,21 @@ Animation.prototype = {
 
             component.pendingRepeat = false;
 
-            //  OnRepeat
+            if (this.onRepeat)
+            {
+                this.onRepeat.apply(this.callbackScope, component._callbackArgs.concat(this.onRepeatParams));
+            }
         }
     },
 
     completeAnimation: function (component)
     {
-        component.stop();
-
         if (this.hideOnComplete)
         {
             component.parent.visible = false;
         }
 
-        //  Events
-
+        component.stop(true);
     },
 
     setFrame: function (component)

v3/src/animation/frame/Play.js

@@ -4,22 +4,29 @@ var Play = function (key, startFrame)
 
     this.load(key, startFrame);
 
+    var anim = this.currentAnim;
+
     //  Should give us 9,007,199,254,740,991 safe repeats
     this.repeatCounter = (this._repeat === -1) ? Number.MAX_SAFE_INTEGER : this._repeat;
 
-    this.currentAnim.getFirstTick(this);
+    anim.getFirstTick(this);
 
     this.forward = true;
     this.isPlaying = true;
     this.pendingRepeat = false;
 
     this.prevTick = this.mainloop.lastFrameTimeMs;
 
-    if (currentAnim.showOnStart)
+    if (anim.showOnStart)
     {
         this.parent.visible = true;
     }
 
+    if (anim.onStart)
+    {
+        anim.onStart.apply(anim.callbackScope, this._callbackArgs.concat(anim.onStartParams));
+    }
+
     return this;
 };
 

v3/src/animation/frame/Stop.js

@@ -1,7 +1,16 @@
-var Stop = function ()
+var Stop = function (dispatchCallbacks)
 {
+    if (dispatchCallbacks === undefined) { dispatchCallbacks = false; }
+
     this.isPlaying = false;
 
+    var anim = this.currentAnim;
+
+    if (dispatchCallbacks && anim.onComplete)
+    {
+        anim.onComplete.apply(anim.callbackScope, this._callbackArgs.concat(anim.onCompleteParams));
+    }
+
     return this;
 };
 

v3/src/animation/frame/UpdateFrame.js

@@ -7,14 +7,24 @@ var UpdateFrame = function (animationFrame)
     sprite.texture = animationFrame.frame.texture;
     sprite.frame = animationFrame.frame;
 
-    if (animationFrame.setAlpha)
+    if (this.isPlaying)
     {
-        sprite.alpha = animationFrame.alpha;
-    }
+        if (animationFrame.setAlpha)
+        {
+            sprite.alpha = animationFrame.alpha;
+        }
 
-    if (animationFrame.onUpdate)
-    {
-        animationFrame.onUpdate(sprite, animationFrame);
+        var anim = this.currentAnim;
+
+        if (anim.onUpdate)
+        {
+            anim.onUpdate.apply(anim.callbackScope, this._updateParams);
+        }
+
+        if (animationFrame.onUpdate)
+        {
+            animationFrame.onUpdate(sprite, animationFrame);
+        }
     }
 };
 

v3/src/checksum.js

@@ -1,4 +1,4 @@
 var CHECKSUM = {
-build: 'e6996440-1de8-11e7-bd97-cdf675a0abb1'
+build: '6d1ac140-1e01-11e7-abae-c74d411e0c22'
 };
 module.exports = CHECKSUM;

v3/src/components/Animation.js

@@ -72,6 +72,9 @@ var Animation = new Class({
 
         this._paused = false;
         this._wasPlaying = false;
+
+        this._callbackArgs = [ parent, null ];
+        this._updateParams = [];
     },
 
     delay: Components.Delay,