Add callbacks on Physics

Author: orblazer

src/physics/arcade/ArcadePhysics.js

@@ -144,8 +144,8 @@ var ArcadePhysics = new Class({
      *
      * @param {Phaser.GameObjects.GameObject|array} object1 - The first object or array of objects to check. Can be any Game Object that has an Arcade Physics Body.
      * @param {Phaser.GameObjects.GameObject|array} object2 - The second object or array of objects to check. Can be any Game Object that has an Arcade Physics Body.
-     * @param {function} [overlapCallback=null] - An optional callback function that is called if the objects overlap. The two objects will be passed to this function in the same order in which you specified them, unless you are checking Group vs. Sprite, in which case Sprite will always be the first parameter.
-     * @param {function} [processCallback=null] - A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then `overlapCallback` will only be called if this callback returns `true`.
+     * @param {ArcadePhysicsCallback} [overlapCallback=null] - An optional callback function that is called if the objects overlap. The two objects will be passed to this function in the same order in which you specified them, unless you are checking Group vs. Sprite, in which case Sprite will always be the first parameter.
+     * @param {ArcadePhysicsCallback} [processCallback=null] - A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then `overlapCallback` will only be called if this callback returns `true`.
      * @param {object} [callbackContext] - The context in which to run the callbacks.
      *
      * @return {boolean} True if an overlap occurred otherwise false.
@@ -167,8 +167,8 @@ var ArcadePhysics = new Class({
      *
      * @param {Phaser.GameObjects.GameObject|array} object1 - The first object or array of objects to check. Can be any Game Object that has an Arcade Physics Body.
      * @param {Phaser.GameObjects.GameObject|array} object2 - The second object or array of objects to check. Can be any Game Object that has an Arcade Physics Body.
-     * @param {function} [collideCallback=null] - An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them, unless you are checking Group vs. Sprite, in which case Sprite will always be the first parameter.
-     * @param {function} [processCallback=null] - A callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.
+     * @param {ArcadePhysicsCallback} [collideCallback=null] - An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them, unless you are checking Group vs. Sprite, in which case Sprite will always be the first parameter.
+     * @param {ArcadePhysicsCallback} [processCallback=null] - A callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.
      * @param {object} [callbackContext] - The context in which to run the callbacks.
      *
      * @return {boolean} True if a collision occurred otherwise false.

src/physics/arcade/Collider.js

@@ -19,8 +19,8 @@ var Class = require('../../utils/Class');
  * @param {boolean} overlapOnly - [description]
  * @param {Phaser.Physics.Arcade.Body} object1 - The first object to check for collision.
  * @param {Phaser.Physics.Arcade.Body} object2 - The second object to check for collision.
- * @param {function} collideCallback - The callback to invoke when the two objects collide.
- * @param {function} processCallback - The callback to invoke when the two objects collide. Must return a boolean.
+ * @param {ArcadePhysicsCallback} collideCallback - The callback to invoke when the two objects collide.
+ * @param {ArcadePhysicsCallback} processCallback - The callback to invoke when the two objects collide. Must return a boolean.
  * @param {object} callbackContext - The scope in which to call the callbacks.
  */
 var Collider = new Class({
@@ -88,7 +88,7 @@ var Collider = new Class({
          * [description]
          *
          * @name Phaser.Physics.Arcade.Collider#collideCallback
-         * @type {function}
+         * @type {ArcadePhysicsCallback}
          * @since 3.0.0
          */
         this.collideCallback = collideCallback;
@@ -97,7 +97,7 @@ var Collider = new Class({
          * [description]
          *
          * @name Phaser.Physics.Arcade.Collider#processCallback
-         * @type {function}
+         * @type {ArcadePhysicsCallback}
          * @since 3.0.0
          */
         this.processCallback = processCallback;

src/physics/arcade/Factory.js

@@ -65,8 +65,8 @@ var Factory = new Class({
      *
      * @param {Phaser.Physics.Arcade.Body} object1 - The first object to check for collision.
      * @param {Phaser.Physics.Arcade.Body} object2 - The second object to check for collision.
-     * @param {function} collideCallback - The callback to invoke when the two objects collide.
-     * @param {function} processCallback - The callback to invoke when the two objects collide. Must return a boolean.
+     * @param {ArcadePhysicsCallback} collideCallback - The callback to invoke when the two objects collide.
+     * @param {ArcadePhysicsCallback} processCallback - The callback to invoke when the two objects collide. Must return a boolean.
      * @param {object} callbackContext - The scope in which to call the callbacks.
      *
      * @return {Phaser.Physics.Arcade.Collider} The Collider that was created.
@@ -84,8 +84,8 @@ var Factory = new Class({
      *
      * @param {Phaser.Physics.Arcade.Body} object1 - The first object to check for overlap.
      * @param {Phaser.Physics.Arcade.Body} object2 - The second object to check for overlap.
-     * @param {function} collideCallback - The callback to invoke when the two objects collide.
-     * @param {function} processCallback - The callback to invoke when the two objects collide. Must return a boolean.
+     * @param {ArcadePhysicsCallback} collideCallback - The callback to invoke when the two objects collide.
+     * @param {ArcadePhysicsCallback} processCallback - The callback to invoke when the two objects collide. Must return a boolean.
      * @param {object} callbackContext - The scope in which to call the callbacks.
      *
      * @return {Phaser.Physics.Arcade.Collider} The Collider that was created.

src/physics/arcade/World.js

@@ -565,9 +565,9 @@ var World = new Class({
      *
      * @param {Phaser.Physics.Arcade.Body} object1 - The first object to check for collision.
      * @param {Phaser.Physics.Arcade.Body} object2 - The second object to check for collision.
-     * @param {function} collideCallback - The callback to invoke when the two objects collide.
-     * @param {function} processCallback - The callback to invoke when the two objects collide. Must return a boolean.
-     * @param {object} callbackContext - The scope in which to call the callbacks.
+     * @param {ArcadePhysicsCallback} [collideCallback] - The callback to invoke when the two objects collide.
+     * @param {ArcadePhysicsCallback} [processCallback] - The callback to invoke when the two objects collide. Must return a boolean.
+     * @param {object} [callbackContext] - The scope in which to call the callbacks.
      *
      * @return {Phaser.Physics.Arcade.Collider} The Collider that was created.
      */
@@ -592,9 +592,9 @@ var World = new Class({
      *
      * @param {Phaser.Physics.Arcade.Body} object1 - The first object to check for overlap.
      * @param {Phaser.Physics.Arcade.Body} object2 - The second object to check for overlap.
-     * @param {function} collideCallback - The callback to invoke when the two objects overlap.
-     * @param {function} processCallback - The callback to invoke when the two objects overlap. Must return a boolean.
-     * @param {object} callbackContext - The scope in which to call the callbacks.
+     * @param {ArcadePhysicsCallback} [collideCallback] - The callback to invoke when the two objects overlap.
+     * @param {ArcadePhysicsCallback} [processCallback] - The callback to invoke when the two objects overlap. Must return a boolean.
+     * @param {object} [callbackContext] - The scope in which to call the callbacks.
      *
      * @return {Phaser.Physics.Arcade.Collider} The Collider that was created.
      */
@@ -865,7 +865,7 @@ var World = new Class({
      *
      * @param {Phaser.Physics.Arcade.Body} body1 - [description]
      * @param {Phaser.Physics.Arcade.Body} body2 - [description]
-     * @param {function} processCallback - [description]
+     * @param {ArcadePhysicsCallback} processCallback - [description]
      * @param {object} callbackContext - [description]
      * @param {boolean} overlapOnly - [description]
      *
@@ -1249,9 +1249,9 @@ var World = new Class({
      *
      * @param {Phaser.GameObjects.GameObject} object1 - [description]
      * @param {Phaser.GameObjects.GameObject} object2 - [description]
-     * @param {function} overlapCallback - [description]
-     * @param {function} processCallback - [description]
-     * @param {object} callbackContext - [description]
+     * @param {ArcadePhysicsCallback} [overlapCallback] - [description]
+     * @param {ArcadePhysicsCallback} [processCallback] - [description]
+     * @param {object} [callbackContext] - [description]
      *
      * @return {boolean} [description]
      */
@@ -1272,9 +1272,9 @@ var World = new Class({
      *
      * @param {Phaser.GameObjects.GameObject} object1 - [description]
      * @param {Phaser.GameObjects.GameObject} object2 - [description]
-     * @param {function} collideCallback - [description]
-     * @param {function} processCallback - [description]
-     * @param {object} callbackContext - [description]
+     * @param {ArcadePhysicsCallback} [collideCallback] - [description]
+     * @param {ArcadePhysicsCallback} [processCallback] - [description]
+     * @param {object} [callbackContext] - [description]
      *
      * @return {boolean} [description]
      */
@@ -1295,8 +1295,8 @@ var World = new Class({
      *
      * @param {Phaser.GameObjects.GameObject} object1 - [description]
      * @param {Phaser.GameObjects.GameObject} object2 - [description]
-     * @param {function} collideCallback - [description]
-     * @param {function} processCallback - [description]
+     * @param {ArcadePhysicsCallback} collideCallback - [description]
+     * @param {ArcadePhysicsCallback} processCallback - [description]
      * @param {object} callbackContext - [description]
      * @param {boolean} overlapOnly - [description]
      *
@@ -1356,8 +1356,8 @@ var World = new Class({
      *
      * @param {Phaser.GameObjects.GameObject} object1 - [description]
      * @param {Phaser.GameObjects.GameObject} object2 - [description]
-     * @param {function} collideCallback - [description]
-     * @param {function} processCallback - [description]
+     * @param {ArcadePhysicsCallback} collideCallback - [description]
+     * @param {ArcadePhysicsCallback} processCallback - [description]
      * @param {object} callbackContext - [description]
      * @param {boolean} overlapOnly - [description]
      *
@@ -1434,8 +1434,8 @@ var World = new Class({
      *
      * @param {Phaser.GameObjects.GameObject} sprite1 - [description]
      * @param {Phaser.GameObjects.GameObject} sprite2 - [description]
-     * @param {function} collideCallback - [description]
-     * @param {function} processCallback - [description]
+     * @param {ArcadePhysicsCallback} collideCallback - [description]
+     * @param {ArcadePhysicsCallback} processCallback - [description]
      * @param {object} callbackContext - [description]
      * @param {boolean} overlapOnly - [description]
      *
@@ -1469,8 +1469,8 @@ var World = new Class({
      *
      * @param {Phaser.GameObjects.GameObject} sprite - [description]
      * @param {Phaser.GameObjects.Group} group - [description]
-     * @param {function} collideCallback - [description]
-     * @param {function} processCallback - [description]
+     * @param {ArcadePhysicsCallback} collideCallback - [description]
+     * @param {ArcadePhysicsCallback} processCallback - [description]
      * @param {object} callbackContext - [description]
      * @param {boolean} overlapOnly - [description]
      *
@@ -1532,8 +1532,8 @@ var World = new Class({
      *
      * @param {Phaser.GameObjects.Group} group - [description]
      * @param {Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer} tilemapLayer - [description]
-     * @param {function} collideCallback - [description]
-     * @param {function} processCallback - [description]
+     * @param {ArcadePhysicsCallback} collideCallback - [description]
+     * @param {ArcadePhysicsCallback} processCallback - [description]
      * @param {object} callbackContext - [description]
      * @param {boolean} overlapOnly - [description]
      *
@@ -1572,8 +1572,8 @@ var World = new Class({
      *
      * @param {Phaser.GameObjects.GameObject} sprite - [description]
      * @param {Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer} tilemapLayer - [description]
-     * @param {function} collideCallback - [description]
-     * @param {function} processCallback - [description]
+     * @param {ArcadePhysicsCallback} collideCallback - [description]
+     * @param {ArcadePhysicsCallback} processCallback - [description]
      * @param {object} callbackContext - [description]
      * @param {boolean} overlapOnly - [description]
      *
@@ -1671,8 +1671,8 @@ var World = new Class({
      *
      * @param {Phaser.GameObjects.Group} group1 - [description]
      * @param {Phaser.GameObjects.Group} group2 - [description]
-     * @param {function} collideCallback - [description]
-     * @param {function} processCallback - [description]
+     * @param {ArcadePhysicsCallback} collideCallback - [description]
+     * @param {ArcadePhysicsCallback} processCallback - [description]
      * @param {object} callbackContext - [description]
      * @param {boolean} overlapOnly - [description]
      *

src/physics/arcade/index.js

@@ -7,6 +7,13 @@
 var CONST = require('./const');
 var Extend = require('../../utils/object/Extend');
 
+/**
+ * @callback ArcadePhysicsCallback
+ *
+ * @param {Phaser.GameObjects.GameObject} object1 - [description]
+ * @param {Phaser.GameObjects.GameObject} object2 - [description]
+ */
+
 /**
  * @namespace Phaser.Physics.Arcade
  */
@@ -23,7 +30,7 @@ var Arcade = {
     StaticBody: require('./StaticBody'),
     StaticGroup: require('./StaticPhysicsGroup'),
     World: require('./World')
-  
+
 };
 
 //   Merge in the consts

src/physics/impact/Body.js

@@ -10,6 +10,12 @@ var GetVelocity = require('./GetVelocity');
 var TYPE = require('./TYPE');
 var UpdateMotion = require('./UpdateMotion');
 
+/**
+ * @callback BodyUpdateCallback
+ *
+ * @param {Phaser.Physics.Impact.Body} body - [description]
+ */
+
 /**
  * @classdesc
  * An Impact.js compatible physics body.
@@ -289,7 +295,7 @@ var Body = new Class({
          * [description]
          *
          * @name Phaser.Physics.Impact.Body#updateCallback
-         * @type {function}
+         * @type {?BodyUpdateCallback}
          * @since 3.0.0
          */
         this.updateCallback;