Adding callback typedefs

Author: photonstorm

src/actions/Call.js

@@ -4,12 +4,6 @@
  * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
  */
 
-/**
- * @callback CallCallback
- *
- * @param {Phaser.GameObjects.GameObject} item - The Game Object to run the callback on.
- */
-
 /**
  * Takes an array of objects and passes each of them to the given callback.
  *
@@ -19,7 +13,7 @@
  * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]
  *
  * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
- * @param {CallCallback} callback - The callback to be invoked. It will be passed just one argument: the item from the array.
+ * @param {Phaser.Actions.Types.CallCallback} callback - The callback to be invoked. It will be passed just one argument: the item from the array.
  * @param {*} context - The scope in which the callback will be invoked.
  *
  * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that was passed to this Action.

src/actions/typedefs/CallCallback.js

@@ -0,0 +1,6 @@
+/**
+ * @callback Phaser.Actions.Types.CallCallback
+ * @since 3.0.0
+ *
+ * @param {Phaser.GameObjects.GameObject} item - The Game Object to run the callback on.
+ */

src/cameras/2d/effects/Fade.js

@@ -153,18 +153,11 @@ var Fade = new Class({
          */
         this._elapsed = 0;
 
-        /**
-         * @callback CameraFadeCallback
-         *
-         * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.
-         * @param {number} progress - The progress of the effect. A value between 0 and 1.
-         */
-
         /**
          * This callback is invoked every frame for the duration of the effect.
          *
          * @name Phaser.Cameras.Scene2D.Effects.Fade#_onUpdate
-         * @type {?CameraFadeCallback}
+         * @type {?Phaser.Cameras.Scene2D.Types.CameraFadeCallback}
          * @private
          * @default null
          * @since 3.5.0
@@ -196,7 +189,7 @@ var Fade = new Class({
      * @param {integer} [green=0] - The amount to fade the green channel towards. A value between 0 and 255.
      * @param {integer} [blue=0] - The amount to fade the blue channel towards. A value between 0 and 255.
      * @param {boolean} [force=false] - Force the effect to start immediately, even if already running.
-     * @param {CameraFadeCallback} [callback] - This callback will be invoked every frame for the duration of the effect.
+     * @param {Phaser.Cameras.Scene2D.Types.CameraFadeCallback} [callback] - This callback will be invoked every frame for the duration of the effect.
      * It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.
      * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
      *

src/cameras/2d/effects/Flash.js

@@ -128,18 +128,11 @@ var Flash = new Class({
          */
         this._elapsed = 0;
 
-        /**
-         * @callback CameraFlashCallback
-         *
-         * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.
-         * @param {number} progress - The progress of the effect. A value between 0 and 1.
-         */
-
         /**
          * This callback is invoked every frame for the duration of the effect.
          *
          * @name Phaser.Cameras.Scene2D.Effects.Flash#_onUpdate
-         * @type {?CameraFlashCallback}
+         * @type {?Phaser.Cameras.Scene2D.Types.CameraFlashCallback}
          * @private
          * @default null
          * @since 3.5.0
@@ -170,7 +163,7 @@ var Flash = new Class({
      * @param {integer} [green=255] - The amount to fade the green channel towards. A value between 0 and 255.
      * @param {integer} [blue=255] - The amount to fade the blue channel towards. A value between 0 and 255.
      * @param {boolean} [force=false] - Force the effect to start immediately, even if already running.
-     * @param {CameraFlashCallback} [callback] - This callback will be invoked every frame for the duration of the effect.
+     * @param {Phaser.Cameras.Scene2D.Types.CameraFlashCallback} [callback] - This callback will be invoked every frame for the duration of the effect.
      * It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.
      * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
      *

src/cameras/2d/effects/Pan.js

@@ -123,20 +123,11 @@ var Pan = new Class({
          */
         this._elapsed = 0;
 
-        /**
-         * @callback CameraPanCallback
-         *
-         * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.
-         * @param {number} progress - The progress of the effect. A value between 0 and 1.
-         * @param {number} x - The Camera's new scrollX coordinate.
-         * @param {number} y - The Camera's new scrollY coordinate.
-         */
-
         /**
          * This callback is invoked every frame for the duration of the effect.
          *
          * @name Phaser.Cameras.Scene2D.Effects.Pan#_onUpdate
-         * @type {?CameraPanCallback}
+         * @type {?Phaser.Cameras.Scene2D.Types.CameraPanCallback}
          * @private
          * @default null
          * @since 3.11.0
@@ -168,7 +159,7 @@ var Pan = new Class({
      * @param {integer} [duration=1000] - The duration of the effect in milliseconds.
      * @param {(string|function)} [ease='Linear'] - The ease to use for the pan. Can be any of the Phaser Easing constants or a custom function.
      * @param {boolean} [force=false] - Force the pan effect to start immediately, even if already running.
-     * @param {CameraPanCallback} [callback] - This callback will be invoked every frame for the duration of the effect.
+     * @param {Phaser.Cameras.Scene2D.Types.CameraPanCallback} [callback] - This callback will be invoked every frame for the duration of the effect.
      * It is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,
      * the current camera scroll x coordinate and the current camera scroll y coordinate.
      * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.

src/cameras/2d/effects/Shake.js

@@ -118,18 +118,11 @@ var Shake = new Class({
          */
         this._offsetY = 0;
 
-        /**
-         * @callback CameraShakeCallback
-         *
-         * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.
-         * @param {number} progress - The progress of the effect. A value between 0 and 1.
-         */
-
         /**
          * This callback is invoked every frame for the duration of the effect.
          *
          * @name Phaser.Cameras.Scene2D.Effects.Shake#_onUpdate
-         * @type {?CameraShakeCallback}
+         * @type {?Phaser.Cameras.Scene2D.Types.CameraShakeCallback}
          * @private
          * @default null
          * @since 3.5.0
@@ -158,7 +151,7 @@ var Shake = new Class({
      * @param {integer} [duration=100] - The duration of the effect in milliseconds.
      * @param {number} [intensity=0.05] - The intensity of the shake.
      * @param {boolean} [force=false] - Force the shake effect to start immediately, even if already running.
-     * @param {CameraShakeCallback} [callback] - This callback will be invoked every frame for the duration of the effect.
+     * @param {Phaser.Cameras.Scene2D.Types.CameraShakeCallback} [callback] - This callback will be invoked every frame for the duration of the effect.
      * It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.
      * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
      *

src/cameras/2d/effects/Zoom.js

@@ -109,19 +109,11 @@ var Zoom = new Class({
          */
         this._elapsed = 0;
 
-        /**
-         * @callback CameraZoomCallback
-         *
-         * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.
-         * @param {number} progress - The progress of the effect. A value between 0 and 1.
-         * @param {number} zoom - The Camera's new zoom value.
-         */
-
         /**
          * This callback is invoked every frame for the duration of the effect.
          *
          * @name Phaser.Cameras.Scene2D.Effects.Zoom#_onUpdate
-         * @type {?CameraZoomCallback}
+         * @type {?Phaser.Cameras.Scene2D.Types.CameraZoomCallback}
          * @private
          * @default null
          * @since 3.11.0
@@ -151,7 +143,7 @@ var Zoom = new Class({
      * @param {integer} [duration=1000] - The duration of the effect in milliseconds.
      * @param {(string|function)} [ease='Linear'] - The ease to use for the Zoom. Can be any of the Phaser Easing constants or a custom function.
      * @param {boolean} [force=false] - Force the zoom effect to start immediately, even if already running.
-     * @param {CameraZoomCallback} [callback] - This callback will be invoked every frame for the duration of the effect.
+     * @param {Phaser.Cameras.Scene2D.Types.CameraZoomCallback} [callback] - This callback will be invoked every frame for the duration of the effect.
      * It is sent three arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,
      * and the current camera zoom value.
      * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.

src/cameras/2d/typedefs/CameraFadeCallback.js

@@ -0,0 +1,7 @@
+/**
+ * @callback Phaser.Cameras.Scene2D.Types.CameraFadeCallback
+ * @since 3.5.0
+ *
+ * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.
+ * @param {number} progress - The progress of the effect. A value between 0 and 1.
+ */

src/cameras/2d/typedefs/CameraFlashCallback.js

@@ -0,0 +1,7 @@
+/**
+ * @callback Phaser.Cameras.Scene2D.Types.CameraFlashCallback
+ * @since 3.5.0
+ *
+ * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.
+ * @param {number} progress - The progress of the effect. A value between 0 and 1.
+ */

src/cameras/2d/typedefs/CameraPanCallback.js

@@ -0,0 +1,9 @@
+/**
+ * @callback Phaser.Cameras.Scene2D.Types.CameraPanCallback
+ * @since 3.5.0
+ *
+ * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.
+ * @param {number} progress - The progress of the effect. A value between 0 and 1.
+ * @param {number} x - The Camera's new scrollX coordinate.
+ * @param {number} y - The Camera's new scrollY coordinate.
+ */