More typedefs

Author: photonstorm

src/input/InputPlugin.js

@@ -89,7 +89,7 @@ var InputPlugin = new Class({
          * A reference to the Scene Systems Settings.
          *
          * @name Phaser.Input.InputPlugin#settings
-         * @type {Phaser.Scenes.Settings.Object}
+         * @type {Phaser.Scenes.Types.SettingsObject}
          * @since 3.5.0
          */
         this.settings = scene.sys.settings;

src/input/gamepad/GamepadPlugin.js

@@ -78,7 +78,7 @@ var GamepadPlugin = new Class({
          * A reference to the Scene Systems Settings.
          *
          * @name Phaser.Input.Gamepad.GamepadPlugin#settings
-         * @type {Phaser.Scenes.Settings.Object}
+         * @type {Phaser.Scenes.Types.SettingsObject}
          * @since 3.10.0
          */
         this.settings = this.scene.sys.settings;

src/input/keyboard/KeyboardPlugin.js

@@ -94,7 +94,7 @@ var KeyboardPlugin = new Class({
          * A reference to the Scene Systems Settings.
          *
          * @name Phaser.Input.Keyboard.KeyboardPlugin#settings
-         * @type {Phaser.Scenes.Settings.Object}
+         * @type {Phaser.Scenes.Types.SettingsObject}
          * @since 3.10.0
          */
         this.settings = this.scene.sys.settings;

src/scene/Scene.js

@@ -16,7 +16,7 @@ var Systems = require('./Systems');
  * @constructor
  * @since 3.0.0
  *
- * @param {(string|Phaser.Scenes.Settings.Config)} config - Scene specific configuration settings.
+ * @param {(string|Phaser.Scenes.Types.SettingsConfig)} config - Scene specific configuration settings.
  */
 var Scene = new Class({
 

src/scene/SceneManager.js

@@ -312,7 +312,7 @@ var SceneManager = new Class({
      * @since 3.0.0
      *
      * @param {string} key - A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.
-     * @param {(Phaser.Scene|Phaser.Scenes.Settings.Config|function)} sceneConfig - The config for the Scene
+     * @param {(Phaser.Scene|Phaser.Scenes.Types.SettingsConfig|function)} sceneConfig - The config for the Scene
      * @param {boolean} [autoStart=false] - If `true` the Scene will be started immediately after being added.
      * @param {object} [data] - Optional data object. This will be set as Scene.settings.data and passed to `Scene.init`.
      *
@@ -706,7 +706,7 @@ var SceneManager = new Class({
      * @since 3.0.0
      *
      * @param {string} key - The key of the Scene.
-     * @param {(string|Phaser.Scenes.Settings.Config)} sceneConfig - The Scene config.
+     * @param {(string|Phaser.Scenes.Types.SettingsConfig)} sceneConfig - The Scene config.
      *
      * @return {Phaser.Scene} The created Scene.
      */
@@ -784,7 +784,7 @@ var SceneManager = new Class({
      * @since 3.0.0
      *
      * @param {string} key - The key to check in the Scene config.
-     * @param {(Phaser.Scene|Phaser.Scenes.Settings.Config|function)} sceneConfig - The Scene config.
+     * @param {(Phaser.Scene|Phaser.Scenes.Types.SettingsConfig|function)} sceneConfig - The Scene config.
      *
      * @return {string} The Scene key.
      */

src/scene/ScenePlugin.js

@@ -49,7 +49,7 @@ var ScenePlugin = new Class({
          * The settings of the Scene this ScenePlugin belongs to.
          *
          * @name Phaser.Scenes.ScenePlugin#settings
-         * @type {Phaser.Scenes.Settings.Object}
+         * @type {Phaser.Scenes.Types.SettingsObject}
          * @since 3.0.0
          */
         this.settings = scene.sys.settings;
@@ -226,20 +226,6 @@ var ScenePlugin = new Class({
         return this;
     },
 
-    /**
-     * @typedef {object} SceneTransitionConfig
-     *
-     * @property {string} target - The Scene key to transition to.
-     * @property {integer} [duration=1000] - The duration, in ms, for the transition to last.
-     * @property {boolean} [sleep=false] - Will the Scene responsible for the transition be sent to sleep on completion (`true`), or stopped? (`false`)
-     * @property {boolean} [allowInput=false] - Will the Scenes Input system be able to process events while it is transitioning in or out?
-     * @property {boolean} [moveAbove] - Move the target Scene to be above this one before the transition starts.
-     * @property {boolean} [moveBelow] - Move the target Scene to be below this one before the transition starts.
-     * @property {function} [onUpdate] - This callback is invoked every frame for the duration of the transition.
-     * @property {any} [onUpdateScope] - The context in which the callback is invoked.
-     * @property {any} [data] - An object containing any data you wish to be passed to the target Scenes init / create methods.
-     */
-
     /**
      * This will start a transition from the current Scene to the target Scene given.
      *
@@ -274,7 +260,7 @@ var ScenePlugin = new Class({
      * @fires Phaser.Scenes.Events#TRANSITION_OUT
      * @since 3.5.0
      *
-     * @param {SceneTransitionConfig} config - The transition configuration object.
+     * @param {Phaser.Scenes.Types.SceneTransitionConfig} config - The transition configuration object.
      *
      * @return {boolean} `true` is the transition was started, otherwise `false`.
      */
@@ -444,7 +430,7 @@ var ScenePlugin = new Class({
      * @since 3.0.0
      *
      * @param {string} key - The Scene key.
-     * @param {(Phaser.Scene|Phaser.Scenes.Settings.Config|function)} sceneConfig - The config for the Scene.
+     * @param {(Phaser.Scene|Phaser.Scenes.Types.SettingsConfig|function)} sceneConfig - The config for the Scene.
      * @param {boolean} autoStart - Whether to start the Scene after it's added.
      * @param {object} [data] - Optional data object. This will be set as Scene.settings.data and passed to `Scene.init`.
      *

src/scene/Settings.js

@@ -13,42 +13,6 @@ var InjectionMap = require('./InjectionMap');
  * @namespace Phaser.Scenes.Settings
  */
 
-/**
- * @typedef {object} Phaser.Scenes.Settings.Config
- *
- * @property {string} [key] - The unique key of this Scene. Must be unique within the entire Game instance.
- * @property {boolean} [active=false] - Does the Scene start as active or not? An active Scene updates each step.
- * @property {boolean} [visible=true] - Does the Scene start as visible or not? A visible Scene renders each step.
- * @property {(false|Phaser.Loader.FileTypes.PackFileConfig)} [pack=false] - An optional Loader Packfile to be loaded before the Scene begins.
- * @property {?(InputJSONCameraObject|InputJSONCameraObject[])} [cameras=null] - An optional Camera configuration object.
- * @property {Object.<string, string>} [map] - Overwrites the default injection map for a scene.
- * @property {Object.<string, string>} [mapAdd] - Extends the injection map for a scene.
- * @property {object} [physics={}] - The physics configuration object for the Scene.
- * @property {object} [loader={}] - The loader configuration object for the Scene.
- * @property {(false|*)} [plugins=false] - The plugin configuration object for the Scene.
- */
-
-/**
- * @typedef {object} Phaser.Scenes.Settings.Object
- *
- * @property {number} status - The current status of the Scene. Maps to the Scene constants.
- * @property {string} key - The unique key of this Scene. Unique within the entire Game instance.
- * @property {boolean} active - The active state of this Scene. An active Scene updates each step.
- * @property {boolean} visible - The visible state of this Scene. A visible Scene renders each step.
- * @property {boolean} isBooted - Has the Scene finished booting?
- * @property {boolean} isTransition - Is the Scene in a state of transition?
- * @property {?Phaser.Scene} transitionFrom - The Scene this Scene is transitioning from, if set.
- * @property {integer} transitionDuration - The duration of the transition, if set.
- * @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 {?(InputJSONCameraObject|InputJSONCameraObject[])} 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.
- * @property {(false|*)} plugins - The plugin configuration object for the Scene.
- */
-
 var Settings = {
 
     /**
@@ -57,9 +21,9 @@ var Settings = {
      * @function Phaser.Scenes.Settings.create
      * @since 3.0.0
      *
-     * @param {(string|Phaser.Scenes.Settings.Config)} config - The Scene configuration object used to create this Scene Settings.
+     * @param {(string|Phaser.Scenes.Types.SettingsConfig)} config - The Scene configuration object used to create this Scene Settings.
      *
-     * @return {Phaser.Scenes.Settings.Object} The Scene Settings object created as a result of the config and default settings.
+     * @return {Phaser.Scenes.Types.SettingsObject} The Scene Settings object created as a result of the config and default settings.
      */
     create: function (config)
     {

src/scene/Systems.js

@@ -27,7 +27,7 @@ var Settings = require('./Settings');
  * @since 3.0.0
  *
  * @param {Phaser.Scene} scene - The Scene that owns this Systems instance.
- * @param {(string|Phaser.Scenes.Settings.Config)} config - Scene specific configuration settings.
+ * @param {(string|Phaser.Scenes.Types.SettingsConfig)} config - Scene specific configuration settings.
  */
 var Systems = new Class({
 
@@ -69,7 +69,7 @@ var Systems = new Class({
          * The Scene Configuration object, as passed in when creating the Scene.
          *
          * @name Phaser.Scenes.Systems#config
-         * @type {(string|Phaser.Scenes.Settings.Config)}
+         * @type {(string|Phaser.Scenes.Types.SettingsConfig)}
          * @since 3.0.0
          */
         this.config = config;
@@ -78,7 +78,7 @@ var Systems = new Class({
          * The Scene Settings. This is the parsed output based on the Scene configuration.
          *
          * @name Phaser.Scenes.Systems#settings
-         * @type {Phaser.Scenes.Settings.Object}
+         * @type {Phaser.Scenes.Types.SettingsObject}
          * @since 3.0.0
          */
         this.settings = Settings.create(config);

src/scene/typedefs/SceneTransitionConfig.js

@@ -0,0 +1,14 @@
+/**
+ * @typedef {object} Phaser.Scenes.Types.SceneTransitionConfig
+ * @since 3.5.0
+ *
+ * @property {string} target - The Scene key to transition to.
+ * @property {integer} [duration=1000] - The duration, in ms, for the transition to last.
+ * @property {boolean} [sleep=false] - Will the Scene responsible for the transition be sent to sleep on completion (`true`), or stopped? (`false`)
+ * @property {boolean} [allowInput=false] - Will the Scenes Input system be able to process events while it is transitioning in or out?
+ * @property {boolean} [moveAbove] - Move the target Scene to be above this one before the transition starts.
+ * @property {boolean} [moveBelow] - Move the target Scene to be below this one before the transition starts.
+ * @property {function} [onUpdate] - This callback is invoked every frame for the duration of the transition.
+ * @property {any} [onUpdateScope] - The context in which the callback is invoked.
+ * @property {any} [data] - An object containing any data you wish to be passed to the target Scenes init / create methods.
+ */

src/scene/typedefs/SettingsConfig.js

@@ -0,0 +1,15 @@
+/**
+ * @typedef {object} Phaser.Scenes.Types.SettingsConfig
+ * @since 3.0.0
+ *
+ * @property {string} [key] - The unique key of this Scene. Must be unique within the entire Game instance.
+ * @property {boolean} [active=false] - Does the Scene start as active or not? An active Scene updates each step.
+ * @property {boolean} [visible=true] - Does the Scene start as visible or not? A visible Scene renders each step.
+ * @property {(false|Phaser.Loader.FileTypes.PackFileConfig)} [pack=false] - An optional Loader Packfile to be loaded before the Scene begins.
+ * @property {?(InputJSONCameraObject|InputJSONCameraObject[])} [cameras=null] - An optional Camera configuration object.
+ * @property {Object.<string, string>} [map] - Overwrites the default injection map for a scene.
+ * @property {Object.<string, string>} [mapAdd] - Extends the injection map for a scene.
+ * @property {object} [physics={}] - The physics configuration object for the Scene.
+ * @property {object} [loader={}] - The loader configuration object for the Scene.
+ * @property {(false|*)} [plugins=false] - The plugin configuration object for the Scene.
+ */