Add callbacks on Input and Geom

Author: orblazer

src/actions/SetHitArea.js

@@ -9,10 +9,10 @@
  *
  * @function Phaser.Actions.SetHitArea
  * @since 3.0.0
- * 
+ *
  * @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
  * @param {any} hitArea - [description]
- * @param {function} hitAreaCallback - [description]
+ * @param {HitAreaCallback} hitAreaCallback - [description]
  *
  * @return {array} The array of Game Objects that was passed to this Action.
  */

src/geom/triangle/CenterOn.js

@@ -7,6 +7,14 @@
 var Centroid = require('./Centroid');
 var Offset = require('./Offset');
 
+/**
+ * @callback CenterFunction
+ *
+ * @param {Phaser.Geom.Triangle} triangle - [description]
+ *
+ * @return {Phaser.Math.Vector2} [description]
+ */
+
 /**
  * [description]
  *
@@ -16,7 +24,7 @@ var Offset = require('./Offset');
  * @param {Phaser.Geom.Triangle} triangle - [description]
  * @param {number} x - [description]
  * @param {number} y - [description]
- * @param {function} [centerFunc] - [description]
+ * @param {CenterFunction} [centerFunc] - [description]
  *
  * @return {Phaser.Geom.Triangle} [description]
  */

src/input/InputPlugin.js

@@ -402,7 +402,7 @@ var InputPlugin = new Class({
      *
      * @param {Phaser.GameObjects.GameObject} gameObject - [description]
      * @param {object} shape - [description]
-     * @param {function} callback - [description]
+     * @param {HitAreaCallback} callback - [description]
      * @param {boolean} [dropZone=false] - [description]
      *
      * @return {Phaser.Input.InputPlugin} This Input Plugin.
@@ -1053,7 +1053,7 @@ var InputPlugin = new Class({
      *
      * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} gameObjects - An array of Game Objects to set the hit area on.
      * @param {object} [shape] - The shape or object to check if the pointer is within for hit area checks.
-     * @param {function} [callback] - The 'contains' function to invoke to check if the pointer is within the hit area.
+     * @param {HitAreaCallback} [callback] - The 'contains' function to invoke to check if the pointer is within the hit area.
      *
      * @return {Phaser.Input.InputPlugin} This InputPlugin object.
      */
@@ -1091,7 +1091,7 @@ var InputPlugin = new Class({
      * @param {number} x - The center of the circle.
      * @param {number} y - The center of the circle.
      * @param {number} radius - The radius of the circle.
-     * @param {function} [callback] - The hit area callback. If undefined it uses Circle.Contains.
+     * @param {HitAreaCallback} [callback] - The hit area callback. If undefined it uses Circle.Contains.
      *
      * @return {Phaser.Input.InputPlugin} This InputPlugin object.
      */
@@ -1115,7 +1115,7 @@ var InputPlugin = new Class({
      * @param {number} y - The center of the ellipse.
      * @param {number} width - The width of the ellipse.
      * @param {number} height - The height of the ellipse.
-     * @param {function} [callback] - The hit area callback. If undefined it uses Ellipse.Contains.
+     * @param {HitAreaCallback} [callback] - The hit area callback. If undefined it uses Ellipse.Contains.
      *
      * @return {Phaser.Input.InputPlugin} This InputPlugin object.
      */
@@ -1135,7 +1135,7 @@ var InputPlugin = new Class({
      * @since 3.0.0
      *
      * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} gameObjects - An array of Game Objects to set as having an ellipse hit area.
-     * @param {function} [callback] - The hit area callback. If undefined it uses Rectangle.Contains.
+     * @param {HitAreaCallback} [callback] - The hit area callback. If undefined it uses Rectangle.Contains.
      *
      * @return {Phaser.Input.InputPlugin} This InputPlugin object.
      */
@@ -1189,7 +1189,7 @@ var InputPlugin = new Class({
      * @param {number} y - The top-left of the rectangle.
      * @param {number} width - The width of the rectangle.
      * @param {number} height - The height of the rectangle.
-     * @param {function} [callback] - The hit area callback. If undefined it uses Rectangle.Contains.
+     * @param {HitAreaCallback} [callback] - The hit area callback. If undefined it uses Rectangle.Contains.
      *
      * @return {Phaser.Input.InputPlugin} This InputPlugin object.
      */
@@ -1215,7 +1215,7 @@ var InputPlugin = new Class({
      * @param {number} y2 - The y coordinate of the second point of the triangle.
      * @param {number} x3 - The x coordinate of the third point of the triangle.
      * @param {number} y3 - The y coordinate of the third point of the triangle.
-     * @param {function} [callback] - The hit area callback. If undefined it uses Triangle.Contains.
+     * @param {HitAreaCallback} [callback] - The hit area callback. If undefined it uses Triangle.Contains.
      *
      * @return {Phaser.Input.InputPlugin} This InputPlugin object.
      */

src/input/InteractiveObject.js

@@ -6,6 +6,47 @@
 
 //  Phaser.Input.InteractiveObject
 
+/**
+ * @callback HitAreaCallback
+ *
+ * @param {any} hitArea - [description]
+ * @param {number} x - [description]
+ * @param {number} y - [description]
+ * @param {Phaser.GameObjects.GameObject} gameObject - [description]
+ */
+
+/**
+ * @typedef {object} InteractiveObject
+ *
+ * @property {Phaser.GameObjects.GameObject} gameObject - [description]
+ * @property {boolean} enabled - [description]
+ * @property {boolean} draggable - [description]
+ * @property {boolean} dropZone - [description]
+ * @property {[type]} target - [description]
+ * @property {Phaser.Cameras.Scene2D.Camera} camera - [description]
+ * @property {any} hitArea - [description]
+ * @property {HitAreaCallback} hitAreaCallback - [description]
+ * @property {number} localX - [description]
+ * @property {number} localY - [description]
+ * @property {(0|1|2)} dragState - [description]
+ * @property {number} dragStartX - [description]
+ * @property {number} dragStartY - [description]
+ * @property {number} dragX - [description]
+ * @property {number} dragY - [description]
+ */
+
+/**
+ * [description]
+ *
+ * @method Phaser.Input.Pointer#positionToCamera
+ * @since 3.0.0
+ *
+ * @param {Phaser.GameObjects.GameObject} gameObject - [description]
+ * @param {any} hitArea - [description]
+ * @param {HitAreaCallback} hitAreaCallback - [description]
+ *
+ * @return {InteractiveObject} [description]
+ */
 var InteractiveObject = function (gameObject, hitArea, hitAreaCallback)
 {
     return {

src/input/keyboard/combo/KeyCombo.js

@@ -9,6 +9,12 @@ var GetFastValue = require('../../../utils/object/GetFastValue');
 var ProcessKeyCombo = require('./ProcessKeyCombo');
 var ResetKeyCombo = require('./ResetKeyCombo');
 
+/**
+ * @callback KeyboardKeydownCallback
+ *
+ * @param {KeyboardEvent} event - [description]
+ */
+
 /**
  * @classdesc
  * [description]
@@ -219,7 +225,7 @@ var KeyCombo = new Class({
          * [description]
          *
          * @name Phaser.Input.Keyboard.KeyCombo#onKeyDown
-         * @type {function}
+         * @type {KeyboardKeydownCallback}
          * @since 3.0.0
          */
         this.onKeyDown = onKeyDownHandler;

src/input/touch/TouchManager.js

@@ -10,6 +10,12 @@ var Class = require('../../utils/Class');
 // https://patrickhlauke.github.io/touch/tests/results/
 // https://www.html5rocks.com/en/mobile/touch/
 
+/**
+ * @callback TouchHandler
+ *
+ * @param {TouchEvent} event - [description]
+ */
+
 /**
  * @classdesc
  * [description]
@@ -69,7 +75,7 @@ var TouchManager = new Class({
          * [description]
          *
          * @name Phaser.Input.Touch.TouchManager#handler
-         * @type {function}
+         * @type {TouchHandler}
          * @since 3.0.0
          */
         this.handler;
@@ -154,7 +160,7 @@ var TouchManager = new Class({
             target.addEventListener('touchmove', handler, passive);
             target.addEventListener('touchend', handler, passive);
         }
-        
+
         this.handler = handler;
     },