Close [#585] Implement actor.on('kill') event (#597)

dist/Excalibur.d.ts

@@ -3743,6 +3743,13 @@ declare module ex {
          */
         target: any;
     }
+    /**
+     * The 'kill' event is emitted on actors when it is killed. The target is the actor that was killed.
+     */
+    class KillEvent extends GameEvent {
+        target: any;
+        constructor(target: any);
+    }
     /**
      * The 'predraw' event is emitted on actors, scenes, and engine before drawing starts. Actors' predraw happens inside their graphics
      * transform so that all drawing takes place with the actor as the origin.

dist/Excalibur.js

@@ -6378,6 +6378,7 @@ var ex;
          */
         Actor.prototype.kill = function () {
             if (this.scene) {
+                this.emit('kill', new ex.KillEvent(this));
                 this.scene.remove(this);
                 this._isKilled = true;
             }
@@ -7353,6 +7354,18 @@ var ex;
         return GameEvent;
     })();
     ex.GameEvent = GameEvent;
+    /**
+     * The 'kill' event is emitted on actors when it is killed. The target is the actor that was killed.
+     */
+    var KillEvent = (function (_super) {
+        __extends(KillEvent, _super);
+        function KillEvent(target) {
+            _super.call(this);
+            this.target = target;
+        }
+        return KillEvent;
+    })(GameEvent);
+    ex.KillEvent = KillEvent;
     /**
      * The 'predraw' event is emitted on actors, scenes, and engine before drawing starts. Actors' predraw happens inside their graphics
      * transform so that all drawing takes place with the actor as the origin.

dist/excalibur-0.6.0.d.ts

@@ -3743,6 +3743,13 @@ declare module ex {
          */
         target: any;
     }
+    /**
+     * The 'kill' event is emitted on actors when it is killed. The target is the actor that was killed.
+     */
+    class KillEvent extends GameEvent {
+        target: any;
+        constructor(target: any);
+    }
     /**
      * The 'predraw' event is emitted on actors, scenes, and engine before drawing starts. Actors' predraw happens inside their graphics
      * transform so that all drawing takes place with the actor as the origin.

dist/excalibur-0.6.0.js

@@ -6378,6 +6378,7 @@ var ex;
          */
         Actor.prototype.kill = function () {
             if (this.scene) {
+                this.emit('kill', new ex.KillEvent(this));
                 this.scene.remove(this);
                 this._isKilled = true;
             }
@@ -7353,6 +7354,18 @@ var ex;
         return GameEvent;
     })();
     ex.GameEvent = GameEvent;
+    /**
+     * The 'kill' event is emitted on actors when it is killed. The target is the actor that was killed.
+     */
+    var KillEvent = (function (_super) {
+        __extends(KillEvent, _super);
+        function KillEvent(target) {
+            _super.call(this);
+            this.target = target;
+        }
+        return KillEvent;
+    })(GameEvent);
+    ex.KillEvent = KillEvent;
     /**
      * The 'predraw' event is emitted on actors, scenes, and engine before drawing starts. Actors' predraw happens inside their graphics
      * transform so that all drawing takes place with the actor as the origin.

sandbox/web/Excalibur.js

@@ -6378,6 +6378,7 @@ var ex;
          */
         Actor.prototype.kill = function () {
             if (this.scene) {
+                this.emit('kill', new ex.KillEvent(this));
                 this.scene.remove(this);
                 this._isKilled = true;
             }
@@ -7353,6 +7354,18 @@ var ex;
         return GameEvent;
     })();
     ex.GameEvent = GameEvent;
+    /**
+     * The 'kill' event is emitted on actors when it is killed. The target is the actor that was killed.
+     */
+    var KillEvent = (function (_super) {
+        __extends(KillEvent, _super);
+        function KillEvent(target) {
+            _super.call(this);
+            this.target = target;
+        }
+        return KillEvent;
+    })(GameEvent);
+    ex.KillEvent = KillEvent;
     /**
      * The 'predraw' event is emitted on actors, scenes, and engine before drawing starts. Actors' predraw happens inside their graphics
      * transform so that all drawing takes place with the actor as the origin.

src/engine/Actor.ts

@@ -511,6 +511,7 @@ module ex {
      */
     public kill() {
        if (this.scene) {
+          this.emit('kill', new ex.KillEvent(this));
           this.scene.remove(this);
           this._isKilled = true;
        } else {

src/engine/Events.ts

@@ -30,6 +30,15 @@ module ex {
       public target: any;
    }
 
+   /**
+    * The 'kill' event is emitted on actors when it is killed. The target is the actor that was killed. 
+    */
+   export class KillEvent extends GameEvent {
+      constructor(public target) {
+         super();
+      }
+   }
+
    /**
     * The 'predraw' event is emitted on actors, scenes, and engine before drawing starts. Actors' predraw happens inside their graphics 
     * transform so that all drawing takes place with the actor as the origin.

src/spec/ActorSpec.ts

@@ -939,4 +939,16 @@ describe('A game actor', () => {
       expect(childActor.draw).not.toHaveBeenCalled();
    });
 
-});
+   it('fires a killed event when killed', () => {
+      var actor = new ex.Actor();
+      scene.add(actor);
+      var killed = false;
+      actor.on('kill', (evt: ex.KillEvent) => {
+         killed = true;
+      });
+      actor.kill();
+
+      expect(killed).toBe(true);
+   });
+
+});