Camera Types

photonstorm · photonstorm · commit e556cd9c6839 · 2019-05-09T11:49:44.000+01:00
diff --git a/src/cameras/2d/BaseCamera.js b/src/cameras/2d/BaseCamera.js
@@ -1491,7 +1491,7 @@ var BaseCamera = new Class({
      * @method Phaser.Cameras.Scene2D.BaseCamera#toJSON
      * @since 3.0.0
      *
-     * @return {Phaser.Cameras.Scene2D.Types.JSONCamera} A well-formed object suitable for conversion to JSON.
+     * @return {Phaser.Types.Cameras.Scene2D.JSONCamera} A well-formed object suitable for conversion to JSON.
      */
     toJSON: function ()
     {
diff --git a/src/cameras/2d/CameraManager.js b/src/cameras/2d/CameraManager.js
@@ -385,12 +385,12 @@ var CameraManager = new Class({
     /**
      * Populates this Camera Manager based on the given configuration object, or an array of config objects.
      * 
-     * See the `Phaser.Cameras.Scene2D.Types.CameraConfig` documentation for details of the object structure.
+     * See the `Phaser.Types.Cameras.Scene2D.CameraConfig` documentation for details of the object structure.
      *
      * @method Phaser.Cameras.Scene2D.CameraManager#fromJSON
      * @since 3.0.0
      *
-     * @param {(Phaser.Cameras.Scene2D.Types.CameraConfig|Phaser.Cameras.Scene2D.Types.CameraConfig[])} config - A Camera configuration object, or an array of them, to be added to this Camera Manager.
+     * @param {(Phaser.Types.Cameras.Scene2D.CameraConfig|Phaser.Types.Cameras.Scene2D.CameraConfig[])} config - A Camera configuration object, or an array of them, to be added to this Camera Manager.
      *
      * @return {Phaser.Cameras.Scene2D.CameraManager} This Camera Manager instance.
      */
diff --git a/src/cameras/2d/effects/Fade.js b/src/cameras/2d/effects/Fade.js
@@ -157,7 +157,7 @@ var Fade = new Class({
          * This callback is invoked every frame for the duration of the effect.
          *
          * @name Phaser.Cameras.Scene2D.Effects.Fade#_onUpdate
-         * @type {?Phaser.Cameras.Scene2D.Types.CameraFadeCallback}
+         * @type {?Phaser.Types.Cameras.Scene2D.CameraFadeCallback}
          * @private
          * @default null
          * @since 3.5.0
@@ -189,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 {Phaser.Cameras.Scene2D.Types.CameraFadeCallback} [callback] - This callback will be invoked every frame for the duration of the effect.
+     * @param {Phaser.Types.Cameras.Scene2D.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.
      *
diff --git a/src/cameras/2d/effects/Flash.js b/src/cameras/2d/effects/Flash.js
@@ -132,7 +132,7 @@ var Flash = new Class({
          * This callback is invoked every frame for the duration of the effect.
          *
          * @name Phaser.Cameras.Scene2D.Effects.Flash#_onUpdate
-         * @type {?Phaser.Cameras.Scene2D.Types.CameraFlashCallback}
+         * @type {?Phaser.Types.Cameras.Scene2D.CameraFlashCallback}
          * @private
          * @default null
          * @since 3.5.0
@@ -163,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 {Phaser.Cameras.Scene2D.Types.CameraFlashCallback} [callback] - This callback will be invoked every frame for the duration of the effect.
+     * @param {Phaser.Types.Cameras.Scene2D.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.
      *
diff --git a/src/cameras/2d/effects/Pan.js b/src/cameras/2d/effects/Pan.js
@@ -127,7 +127,7 @@ var Pan = new Class({
          * This callback is invoked every frame for the duration of the effect.
          *
          * @name Phaser.Cameras.Scene2D.Effects.Pan#_onUpdate
-         * @type {?Phaser.Cameras.Scene2D.Types.CameraPanCallback}
+         * @type {?Phaser.Types.Cameras.Scene2D.CameraPanCallback}
          * @private
          * @default null
          * @since 3.11.0
@@ -159,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 {Phaser.Cameras.Scene2D.Types.CameraPanCallback} [callback] - This callback will be invoked every frame for the duration of the effect.
+     * @param {Phaser.Types.Cameras.Scene2D.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.
diff --git a/src/cameras/2d/effects/Shake.js b/src/cameras/2d/effects/Shake.js
@@ -122,7 +122,7 @@ var Shake = new Class({
          * This callback is invoked every frame for the duration of the effect.
          *
          * @name Phaser.Cameras.Scene2D.Effects.Shake#_onUpdate
-         * @type {?Phaser.Cameras.Scene2D.Types.CameraShakeCallback}
+         * @type {?Phaser.Types.Cameras.Scene2D.CameraShakeCallback}
          * @private
          * @default null
          * @since 3.5.0
@@ -151,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 {Phaser.Cameras.Scene2D.Types.CameraShakeCallback} [callback] - This callback will be invoked every frame for the duration of the effect.
+     * @param {Phaser.Types.Cameras.Scene2D.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.
      *
diff --git a/src/cameras/2d/effects/Zoom.js b/src/cameras/2d/effects/Zoom.js
@@ -113,7 +113,7 @@ var Zoom = new Class({
          * This callback is invoked every frame for the duration of the effect.
          *
          * @name Phaser.Cameras.Scene2D.Effects.Zoom#_onUpdate
-         * @type {?Phaser.Cameras.Scene2D.Types.CameraZoomCallback}
+         * @type {?Phaser.Types.Cameras.Scene2D.CameraZoomCallback}
          * @private
          * @default null
          * @since 3.11.0
@@ -143,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 {Phaser.Cameras.Scene2D.Types.CameraZoomCallback} [callback] - This callback will be invoked every frame for the duration of the effect.
+     * @param {Phaser.Types.Cameras.Scene2D.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.
diff --git a/src/cameras/2d/typedefs/CameraConfig.js b/src/cameras/2d/typedefs/CameraConfig.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {object} Phaser.Cameras.Scene2D.Types.CameraConfig
+ * @typedef {object} Phaser.Types.Cameras.Scene2D.CameraConfig
  * @since 3.0.0
  *
  * @property {string} [name=''] - The name of the Camera.
diff --git a/src/cameras/2d/typedefs/CameraFadeCallback.js b/src/cameras/2d/typedefs/CameraFadeCallback.js
@@ -1,5 +1,5 @@
 /**
- * @callback Phaser.Cameras.Scene2D.Types.CameraFadeCallback
+ * @callback Phaser.Types.Cameras.Scene2D.CameraFadeCallback
  * @since 3.5.0
  *
  * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.
diff --git a/src/cameras/2d/typedefs/CameraFlashCallback.js b/src/cameras/2d/typedefs/CameraFlashCallback.js
@@ -1,5 +1,5 @@
 /**
- * @callback Phaser.Cameras.Scene2D.Types.CameraFlashCallback
+ * @callback Phaser.Types.Cameras.Scene2D.CameraFlashCallback
  * @since 3.5.0
  *
  * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.
diff --git a/src/cameras/2d/typedefs/CameraPanCallback.js b/src/cameras/2d/typedefs/CameraPanCallback.js
@@ -1,5 +1,5 @@
 /**
- * @callback Phaser.Cameras.Scene2D.Types.CameraPanCallback
+ * @callback Phaser.Types.Cameras.Scene2D.CameraPanCallback
  * @since 3.5.0
  *
  * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.
diff --git a/src/cameras/2d/typedefs/CameraShakeCallback.js b/src/cameras/2d/typedefs/CameraShakeCallback.js
@@ -1,5 +1,5 @@
 /**
- * @callback Phaser.Cameras.Scene2D.Types.CameraShakeCallback
+ * @callback Phaser.Types.Cameras.Scene2D.CameraShakeCallback
  * @since 3.5.0
  *
  * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.
diff --git a/src/cameras/2d/typedefs/CameraZoomCallback.js b/src/cameras/2d/typedefs/CameraZoomCallback.js
@@ -1,5 +1,5 @@
 /**
- * @callback Phaser.Cameras.Scene2D.Types.CameraZoomCallback
+ * @callback Phaser.Types.Cameras.Scene2D.CameraZoomCallback
  * @since 3.11.0
  *
  * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.
diff --git a/src/cameras/2d/typedefs/JSONCamera.js b/src/cameras/2d/typedefs/JSONCamera.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {object} Phaser.Cameras.Scene2D.Types.JSONCamera
+ * @typedef {object} Phaser.Types.Cameras.Scene2D.JSONCamera
  * @since 3.0.0
  *
  * @property {string} name - The name of the camera
@@ -13,5 +13,5 @@
  * @property {number} scrollX - The horizontal scroll of camera
  * @property {number} scrollY - The vertical scroll of camera
  * @property {string} backgroundColor - The background color of camera
- * @property {(Phaser.Cameras.Scene2D.Types.JSONCameraBounds|undefined)} [bounds] - The bounds of camera
+ * @property {(Phaser.Types.Cameras.Scene2D.JSONCameraBounds|undefined)} [bounds] - The bounds of camera
  */
diff --git a/src/cameras/2d/typedefs/JSONCameraBounds.js b/src/cameras/2d/typedefs/JSONCameraBounds.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {object} Phaser.Cameras.Scene2D.Types.JSONCameraBounds
+ * @typedef {object} Phaser.Types.Cameras.Scene2D.JSONCameraBounds
  * @since 3.0.0
  * 
  * @property {number} x - The horizontal position of camera
diff --git a/src/cameras/2d/typedefs/index.js b/src/cameras/2d/typedefs/index.js
@@ -5,5 +5,5 @@
  */
 
 /**
- * @namespace Phaser.Cameras.Scene2D.Types
+ * @namespace Phaser.Types.Cameras.Scene2D
  */
diff --git a/src/cameras/controls/FixedKeyControl.js b/src/cameras/controls/FixedKeyControl.js
@@ -31,7 +31,7 @@ var GetValue = require('../../utils/object/GetValue');
  * @constructor
  * @since 3.0.0
  *
- * @param {Phaser.Cameras.Controls.Types.FixedKeyControlConfig} config - The Fixed Key Control configuration object.
+ * @param {Phaser.Types.Cameras.Controls.FixedKeyControlConfig} config - The Fixed Key Control configuration object.
  */
 var FixedKeyControl = new Class({
 
diff --git a/src/cameras/controls/SmoothedKeyControl.js b/src/cameras/controls/SmoothedKeyControl.js
@@ -37,7 +37,7 @@ var GetValue = require('../../utils/object/GetValue');
  * @constructor
  * @since 3.0.0
  *
- * @param {Phaser.Cameras.Controls.Types.SmoothedKeyControlConfig} config - The Smoothed Key Control configuration object.
+ * @param {Phaser.Types.Cameras.Controls.SmoothedKeyControlConfig} config - The Smoothed Key Control configuration object.
  */
 var SmoothedKeyControl = new Class({
 
diff --git a/src/cameras/controls/typedefs/FixedKeyControlConfig.js b/src/cameras/controls/typedefs/FixedKeyControlConfig.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {object} Phaser.Cameras.Controls.Types.FixedKeyControlConfig
+ * @typedef {object} Phaser.Types.Cameras.Controls.FixedKeyControlConfig
  * @since 3.0.0
  *
  * @property {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera that this Control will update.
diff --git a/src/cameras/controls/typedefs/SmoothedKeyControlConfig.js b/src/cameras/controls/typedefs/SmoothedKeyControlConfig.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {object} Phaser.Cameras.Controls.Types.SmoothedKeyControlConfig
+ * @typedef {object} Phaser.Types.Cameras.Controls.SmoothedKeyControlConfig
  * @since 3.0.0
  *
  * @property {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera that this Control will update.
diff --git a/src/cameras/controls/typedefs/index.js b/src/cameras/controls/typedefs/index.js
@@ -5,5 +5,5 @@
  */
 
 /**
- * @namespace Phaser.Cameras.Controls.Types
+ * @namespace Phaser.Types.Cameras.Controls
  */
diff --git a/src/cameras/index.js b/src/cameras/index.js
@@ -8,6 +8,10 @@
  * @namespace Phaser.Cameras
  */
 
+/**
+ * @namespace Phaser.Types.Cameras
+ */
+
 module.exports = {
 
     Controls: require('./controls'),
diff --git a/src/scene/typedefs/SettingsObject.js b/src/scene/typedefs/SettingsObject.js
@@ -13,7 +13,7 @@
  * @property {boolean} transitionAllowInput - Is this Scene allowed to receive input during transitions?
  * @property {object} data - a data bundle passed to this Scene from the Scene Manager.
  * @property {(false|Phaser.Loader.FileTypes.PackFileConfig)} pack - The Loader Packfile to be loaded before the Scene begins.
- * @property {?(Phaser.Cameras.Scene2D.Types.JSONCamera|Phaser.Cameras.Scene2D.Types.JSONCamera[])} cameras - The Camera configuration object.
+ * @property {?(Phaser.Types.Cameras.Scene2D.JSONCamera|Phaser.Types.Cameras.Scene2D.JSONCamera[])} cameras - The Camera configuration object.
  * @property {Object.<string, string>} map - The Scene's Injection Map.
  * @property {object} physics - The physics configuration object for the Scene.
  * @property {object} loader - The loader configuration object for the Scene.

Original file line number	Diff line number	Diff line change
`@@ -1491,7 +1491,7 @@ var BaseCamera = new Class({`
`1491`	`1491`	`* @method Phaser.Cameras.Scene2D.BaseCamera#toJSON`
`1492`	`1492`	`* @since 3.0.0`
`1493`	`1493`	`*`
`1494`		`- * @return {Phaser.Cameras.Scene2D.Types.JSONCamera} A well-formed object suitable for conversion to JSON.`
	`1494`	`+ * @return {Phaser.Types.Cameras.Scene2D.JSONCamera} A well-formed object suitable for conversion to JSON.`
`1495`	`1495`	`*/`
`1496`	`1496`	`toJSON: function ()`
`1497`	`1497`	`{`
Original file line number	Diff line number	Diff line change
`@@ -385,12 +385,12 @@ var CameraManager = new Class({`
`385`	`385`	`/**`
`386`	`386`	`* Populates this Camera Manager based on the given configuration object, or an array of config objects.`
`387`	`387`	`*`
`388`		- * See the `Phaser.Cameras.Scene2D.Types.CameraConfig` documentation for details of the object structure.
	`388`	+ * See the `Phaser.Types.Cameras.Scene2D.CameraConfig` documentation for details of the object structure.
`389`	`389`	`*`
`390`	`390`	`* @method Phaser.Cameras.Scene2D.CameraManager#fromJSON`
`391`	`391`	`* @since 3.0.0`
`392`	`392`	`*`
`393`		`- * @param {(Phaser.Cameras.Scene2D.Types.CameraConfig\|Phaser.Cameras.Scene2D.Types.CameraConfig[])} config - A Camera configuration object, or an array of them, to be added to this Camera Manager.`
	`393`	`+ * @param {(Phaser.Types.Cameras.Scene2D.CameraConfig\|Phaser.Types.Cameras.Scene2D.CameraConfig[])} config - A Camera configuration object, or an array of them, to be added to this Camera Manager.`
`394`	`394`	`*`
`395`	`395`	`* @return {Phaser.Cameras.Scene2D.CameraManager} This Camera Manager instance.`
`396`	`396`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/**`
`2`		`- * @typedef {object} Phaser.Cameras.Scene2D.Types.CameraConfig`
	`2`	`+ * @typedef {object} Phaser.Types.Cameras.Scene2D.CameraConfig`
`3`	`3`	`* @since 3.0.0`
`4`	`4`	`*`
`5`	`5`	`* @property {string} [name=''] - The name of the Camera.`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/**`
`2`		`- * @callback Phaser.Cameras.Scene2D.Types.CameraFadeCallback`
	`2`	`+ * @callback Phaser.Types.Cameras.Scene2D.CameraFadeCallback`
`3`	`3`	`* @since 3.5.0`
`4`	`4`	`*`
`5`	`5`	`* @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.`