Matter Events added

Author: photonstorm

src/physics/matter-js/World.js

@@ -10,6 +10,7 @@ var Common = require('./lib/core/Common');
 var Composite = require('./lib/body/Composite');
 var Engine = require('./lib/core/Engine');
 var EventEmitter = require('eventemitter3');
+var Events = require('./events');
 var GetFastValue = require('../../utils/object/GetFastValue');
 var GetValue = require('../../utils/object/GetValue');
 var MatterBody = require('./lib/body/Body');
@@ -238,12 +239,12 @@ var World = new Class({
 
         MatterEvents.on(engine, 'beforeUpdate', function (event)
         {
-            _this.emit('beforeupdate', event);
+            _this.emit(Events.BEFORE_UPDATE, event);
         });
 
         MatterEvents.on(engine, 'afterUpdate', function (event)
         {
-            _this.emit('afterupdate', event);
+            _this.emit(Events.AFTER_UPDATE, event);
         });
 
         MatterEvents.on(engine, 'collisionStart', function (event)
@@ -258,7 +259,7 @@ var World = new Class({
                 bodyB = pairs[0].bodyB;
             }
 
-            _this.emit('collisionstart', event, bodyA, bodyB);
+            _this.emit(Events.COLLISION_START, event, bodyA, bodyB);
         });
 
         MatterEvents.on(engine, 'collisionActive', function (event)
@@ -273,7 +274,7 @@ var World = new Class({
                 bodyB = pairs[0].bodyB;
             }
 
-            _this.emit('collisionactive', event, bodyA, bodyB);
+            _this.emit(Events.COLLISION_ACTIVE, event, bodyA, bodyB);
         });
 
         MatterEvents.on(engine, 'collisionEnd', function (event)
@@ -288,7 +289,7 @@ var World = new Class({
                 bodyB = pairs[0].bodyB;
             }
 
-            _this.emit('collisionend', event, bodyA, bodyB);
+            _this.emit(Events.COLLISION_END, event, bodyA, bodyB);
         });
     },
 
@@ -603,6 +604,7 @@ var World = new Class({
      * [description]
      *
      * @method Phaser.Physics.Matter.World#pause
+     * @fires Phaser.Physics.Matter.Events#PAUSE
      * @since 3.0.0
      *
      * @return {Phaser.Physics.Matter.World} This Matter World object.
@@ -611,7 +613,7 @@ var World = new Class({
     {
         this.enabled = false;
 
-        this.emit('pause');
+        this.emit(Events.PAUSE);
 
         return this;
     },
@@ -620,6 +622,7 @@ var World = new Class({
      * [description]
      *
      * @method Phaser.Physics.Matter.World#resume
+     * @fires Phaser.Physics.Matter.Events#RESUME
      * @since 3.0.0
      *
      * @return {Phaser.Physics.Matter.World} This Matter World object.
@@ -628,7 +631,7 @@ var World = new Class({
     {
         this.enabled = true;
 
-        this.emit('resume');
+        this.emit(Events.RESUME);
 
         return this;
     },

src/physics/matter-js/components/Sleep.js

@@ -4,6 +4,7 @@
  * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
  */
 
+var Events = require('../events');
 var MatterEvents = require('../lib/core/Events');
 
 /**
@@ -70,7 +71,7 @@ var Sleep = {
 
             MatterEvents.on(this.body, 'sleepStart', function (event)
             {
-                world.emit('sleepstart', event, this);
+                world.emit(Events.SLEEP_START, event, this);
             });
         }
         else
@@ -99,7 +100,7 @@ var Sleep = {
 
             MatterEvents.on(this.body, 'sleepEnd', function (event)
             {
-                world.emit('sleepend', event, this);
+                world.emit(Events.SLEEP_END, event, this);
             });
         }
         else

src/physics/matter-js/events/AFTER_UPDATE_EVENT.js

@@ -0,0 +1,26 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * @typedef {object} Phaser.Physics.Matter.Events.AfterUpdateEvent
+ *
+ * @property {number} timestamp - The Matter Engine `timing.timestamp` value for the event.
+ * @property {any} source - The source object of the event.
+ * @property {string} name - The name of the event.
+ */
+
+/**
+ * The Matter Physics After Update Event.
+ * 
+ * This event is dispatched by a Matter Physics World instance after the engine has updated and all collision events have resolved.
+ * 
+ * Listen to it from a Scene using: `this.matter.world.on('afterupdate', listener)`.
+ *
+ * @event Phaser.Physics.Matter.Events#AFTER_UPDATE
+ * 
+ * @param {Phaser.Physics.Matter.Events.AfterUpdateEvent} event - The Update Event object.
+ */
+module.exports = 'afterupdate';

src/physics/matter-js/events/BEFORE_UPDATE_EVENT.js

@@ -0,0 +1,26 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * @typedef {object} Phaser.Physics.Matter.Events.BeforeUpdateEvent
+ *
+ * @property {number} timestamp - The Matter Engine `timing.timestamp` value for the event.
+ * @property {any} source - The source object of the event.
+ * @property {string} name - The name of the event.
+ */
+
+/**
+ * The Matter Physics Before Update Event.
+ * 
+ * This event is dispatched by a Matter Physics World instance right before all the collision processing takes place.
+ * 
+ * Listen to it from a Scene using: `this.matter.world.on('beforeupdate', listener)`.
+ *
+ * @event Phaser.Physics.Matter.Events#BEFORE_UPDATE
+ * 
+ * @param {Phaser.Physics.Matter.Events.BeforeUpdateEvent} event - The Update Event object.
+ */
+module.exports = 'beforeupdate';

src/physics/matter-js/events/COLLISION_ACTIVE_EVENT.js

@@ -0,0 +1,30 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * @typedef {object} Phaser.Physics.Matter.Events.CollisionActiveEvent
+ *
+ * @property {array} pairs - A list of all affected pairs in the collision.
+ * @property {number} timestamp - The Matter Engine `timing.timestamp` value for the event.
+ * @property {any} source - The source object of the event.
+ * @property {string} name - The name of the event.
+ */
+
+/**
+ * The Matter Physics Collision Active Event.
+ * 
+ * This event is dispatched by a Matter Physics World instance after the engine has updated.
+ * It provides a list of all pairs that are colliding in the current tick (if any).
+ * 
+ * Listen to it from a Scene using: `this.matter.world.on('collisionactive', listener)`.
+ *
+ * @event Phaser.Physics.Matter.Events#COLLISION_ACTIVE
+ * 
+ * @param {Phaser.Physics.Matter.Events.CollisionActiveEvent} event - The Collision Event object.
+ * @param {MatterJS.Body} bodyA - The first body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.
+ * @param {MatterJS.Body} bodyB - The second body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.
+ */
+module.exports = 'collisionactive';

src/physics/matter-js/events/COLLISION_END_EVENT.js

@@ -0,0 +1,30 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * @typedef {object} Phaser.Physics.Matter.Events.CollisionEndEvent
+ *
+ * @property {array} pairs - A list of all affected pairs in the collision.
+ * @property {number} timestamp - The Matter Engine `timing.timestamp` value for the event.
+ * @property {any} source - The source object of the event.
+ * @property {string} name - The name of the event.
+ */
+
+/**
+ * The Matter Physics Collision End Event.
+ * 
+ * This event is dispatched by a Matter Physics World instance after the engine has updated.
+ * It provides a list of all pairs that have finished colliding in the current tick (if any).
+ * 
+ * Listen to it from a Scene using: `this.matter.world.on('collisionend', listener)`.
+ *
+ * @event Phaser.Physics.Matter.Events#COLLISION_END
+ * 
+ * @param {Phaser.Physics.Matter.Events.CollisionEndEvent} event - The Collision Event object.
+ * @param {MatterJS.Body} bodyA - The first body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.
+ * @param {MatterJS.Body} bodyB - The second body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.
+ */
+module.exports = 'collisionend';

src/physics/matter-js/events/COLLISION_START_EVENT.js

@@ -0,0 +1,30 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * @typedef {object} Phaser.Physics.Matter.Events.CollisionStartEvent
+ *
+ * @property {array} pairs - A list of all affected pairs in the collision.
+ * @property {number} timestamp - The Matter Engine `timing.timestamp` value for the event.
+ * @property {any} source - The source object of the event.
+ * @property {string} name - The name of the event.
+ */
+
+/**
+ * The Matter Physics Collision Start Event.
+ * 
+ * This event is dispatched by a Matter Physics World instance after the engine has updated.
+ * It provides a list of all pairs that have started to collide in the current tick (if any).
+ * 
+ * Listen to it from a Scene using: `this.matter.world.on('collisionstart', listener)`.
+ *
+ * @event Phaser.Physics.Matter.Events#COLLISION_START
+ * 
+ * @param {Phaser.Physics.Matter.Events.CollisionStartEvent} event - The Collision Event object.
+ * @param {MatterJS.Body} bodyA - The first body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.
+ * @param {MatterJS.Body} bodyB - The second body of the first colliding pair. The `event.pairs` array may contain more colliding bodies.
+ */
+module.exports = 'collisionstart';

src/physics/matter-js/events/PAUSE_EVENT.js

@@ -0,0 +1,16 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * The Matter Physics World Pause Event.
+ * 
+ * This event is dispatched by an Matter Physics World instance when it is paused.
+ * 
+ * Listen to it from a Scene using: `this.matter.world.on('pause', listener)`.
+ *
+ * @event Phaser.Physics.Matter.Events#PAUSE
+ */
+module.exports = 'pause';

src/physics/matter-js/events/RESUME_EVENT.js

@@ -0,0 +1,16 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * The Matter Physics World Resume Event.
+ * 
+ * This event is dispatched by an Matter Physics World instance when it resumes from a paused state.
+ * 
+ * Listen to it from a Scene using: `this.matter.world.on('resume', listener)`.
+ *
+ * @event Phaser.Physics.Matter.Events#RESUME
+ */
+module.exports = 'resume';

src/physics/matter-js/events/SLEEP_END_EVENT.js

@@ -0,0 +1,26 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * @typedef {object} Phaser.Physics.Matter.Events.SleepEndEvent
+ *
+ * @property {any} source - The source object of the event.
+ * @property {string} name - The name of the event.
+ */
+
+/**
+ * The Matter Physics Sleep End Event.
+ * 
+ * This event is dispatched by a Matter Physics World instance when a Body stop sleeping.
+ * 
+ * Listen to it from a Scene using: `this.matter.world.on('sleepend', listener)`.
+ *
+ * @event Phaser.Physics.Matter.Events#SLEEP_END
+ * 
+ * @param {Phaser.Physics.Matter.Events.SleepEndEvent} event - The Sleep Event object.
+ * @param {MatterJS.Body} body - The body that has stopped sleeping.
+ */
+module.exports = 'sleepend';