Skip to content

Commit 1dca2c2

Browse files
photonstormphotonstorm
committed
Scenes Types
1 parent 11d6f2e commit 1dca2c2

14 files changed

Lines changed: 21 additions & 21 deletions

‎src/core/typedefs/GameConfig.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
* @property {HTMLCanvasElement} [canvas=null] - Provide your own Canvas element for Phaser to use instead of creating one.
1212
* @property {string} [canvasStyle=null] - CSS styles to apply to the game canvas instead of Phaser's default styles.
1313
* @property {CanvasRenderingContext2D} [context] - Provide your own Canvas Context for Phaser to use, instead of creating one.
14-
* @property {(Phaser.Scene|Phaser.Scene[]|Phaser.Scenes.Types.SettingsConfig|Phaser.Scenes.Types.SettingsConfig[]|Phaser.Scenes.Types.CreateSceneFromObjectConfig|Phaser.Scenes.Types.CreateSceneFromObjectConfig[]|function|function[])} [scene=null] - A scene or scenes to add to the game. If several are given, the first is started; the remainder are started only if they have `{ active: true }`. See the `sceneConfig` argument in {@link Phaser.Scenes.SceneManager#add}.
14+
* @property {(Phaser.Scene|Phaser.Scene[]|Phaser.Types.Scenes.SettingsConfig|Phaser.Types.Scenes.SettingsConfig[]|Phaser.Types.Scenes.CreateSceneFromObjectConfig|Phaser.Types.Scenes.CreateSceneFromObjectConfig[]|function|function[])} [scene=null] - A scene or scenes to add to the game. If several are given, the first is started; the remainder are started only if they have `{ active: true }`. See the `sceneConfig` argument in {@link Phaser.Scenes.SceneManager#add}.
1515
* @property {string[]} [seed] - Seed for the random number generator.
1616
* @property {string} [title=''] - The title of the game. Shown in the browser console.
1717
* @property {string} [url='http://phaser.io'] - The URL of the game. Shown in the browser console.

‎src/input/InputPlugin.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ var InputPlugin = new Class({
8989
* A reference to the Scene Systems Settings.
9090
*
9191
* @name Phaser.Input.InputPlugin#settings
92-
* @type {Phaser.Scenes.Types.SettingsObject}
92+
* @type {Phaser.Types.Scenes.SettingsObject}
9393
* @since 3.5.0
9494
*/
9595
this.settings = scene.sys.settings;

‎src/input/gamepad/GamepadPlugin.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ var GamepadPlugin = new Class({
7878
* A reference to the Scene Systems Settings.
7979
*
8080
* @name Phaser.Input.Gamepad.GamepadPlugin#settings
81-
* @type {Phaser.Scenes.Types.SettingsObject}
81+
* @type {Phaser.Types.Scenes.SettingsObject}
8282
* @since 3.10.0
8383
*/
8484
this.settings = this.scene.sys.settings;

‎src/input/keyboard/KeyboardPlugin.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ var KeyboardPlugin = new Class({
9494
* A reference to the Scene Systems Settings.
9595
*
9696
* @name Phaser.Input.Keyboard.KeyboardPlugin#settings
97-
* @type {Phaser.Scenes.Types.SettingsObject}
97+
* @type {Phaser.Types.Scenes.SettingsObject}
9898
* @since 3.10.0
9999
*/
100100
this.settings = this.scene.sys.settings;

‎src/scene/Scene.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ var Systems = require('./Systems');
1616
* @constructor
1717
* @since 3.0.0
1818
*
19-
* @param {(string|Phaser.Scenes.Types.SettingsConfig)} config - Scene specific configuration settings.
19+
* @param {(string|Phaser.Types.Scenes.SettingsConfig)} config - Scene specific configuration settings.
2020
*/
2121
var Scene = new Class({
2222

‎src/scene/SceneManager.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ var SceneManager = new Class({
312312
* @since 3.0.0
313313
*
314314
* @param {string} key - A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.
315-
* @param {(Phaser.Scene|Phaser.Scenes.Types.SettingsConfig|Phaser.Scenes.Types.CreateSceneFromObjectConfig|function)} sceneConfig - The config for the Scene
315+
* @param {(Phaser.Scene|Phaser.Types.Scenes.SettingsConfig|Phaser.Types.Scenes.CreateSceneFromObjectConfig|function)} sceneConfig - The config for the Scene
316316
* @param {boolean} [autoStart=false] - If `true` the Scene will be started immediately after being added.
317317
* @param {object} [data] - Optional data object. This will be set as Scene.settings.data and passed to `Scene.init`.
318318
*
@@ -710,7 +710,7 @@ var SceneManager = new Class({
710710
* @since 3.0.0
711711
*
712712
* @param {string} key - The key of the Scene.
713-
* @param {(string|Phaser.Scenes.Types.SettingsConfig|Phaser.Scenes.Types.CreateSceneFromObjectConfig)} sceneConfig - The Scene config.
713+
* @param {(string|Phaser.Types.Scenes.SettingsConfig|Phaser.Types.Scenes.CreateSceneFromObjectConfig)} sceneConfig - The Scene config.
714714
*
715715
* @return {Phaser.Scene} The created Scene.
716716
*/
@@ -788,7 +788,7 @@ var SceneManager = new Class({
788788
* @since 3.0.0
789789
*
790790
* @param {string} key - The key to check in the Scene config.
791-
* @param {(Phaser.Scene|Phaser.Scenes.Types.SettingsConfig|function)} sceneConfig - The Scene config.
791+
* @param {(Phaser.Scene|Phaser.Types.Scenes.SettingsConfig|function)} sceneConfig - The Scene config.
792792
*
793793
* @return {string} The Scene key.
794794
*/

‎src/scene/ScenePlugin.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ var ScenePlugin = new Class({
4949
* The settings of the Scene this ScenePlugin belongs to.
5050
*
5151
* @name Phaser.Scenes.ScenePlugin#settings
52-
* @type {Phaser.Scenes.Types.SettingsObject}
52+
* @type {Phaser.Types.Scenes.SettingsObject}
5353
* @since 3.0.0
5454
*/
5555
this.settings = scene.sys.settings;
@@ -260,7 +260,7 @@ var ScenePlugin = new Class({
260260
* @fires Phaser.Scenes.Events#TRANSITION_OUT
261261
* @since 3.5.0
262262
*
263-
* @param {Phaser.Scenes.Types.SceneTransitionConfig} config - The transition configuration object.
263+
* @param {Phaser.Types.Scenes.SceneTransitionConfig} config - The transition configuration object.
264264
*
265265
* @return {boolean} `true` is the transition was started, otherwise `false`.
266266
*/
@@ -430,7 +430,7 @@ var ScenePlugin = new Class({
430430
* @since 3.0.0
431431
*
432432
* @param {string} key - The Scene key.
433-
* @param {(Phaser.Scene|Phaser.Scenes.Types.SettingsConfig|Phaser.Scenes.Types.CreateSceneFromObjectConfig|function)} sceneConfig - The config for the Scene.
433+
* @param {(Phaser.Scene|Phaser.Types.Scenes.SettingsConfig|Phaser.Types.Scenes.CreateSceneFromObjectConfig|function)} sceneConfig - The config for the Scene.
434434
* @param {boolean} autoStart - Whether to start the Scene after it's added.
435435
* @param {object} [data] - Optional data object. This will be set as Scene.settings.data and passed to `Scene.init`.
436436
*

‎src/scene/Settings.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ var Settings = {
2121
* @function Phaser.Scenes.Settings.create
2222
* @since 3.0.0
2323
*
24-
* @param {(string|Phaser.Scenes.Types.SettingsConfig)} config - The Scene configuration object used to create this Scene Settings.
24+
* @param {(string|Phaser.Types.Scenes.SettingsConfig)} config - The Scene configuration object used to create this Scene Settings.
2525
*
26-
* @return {Phaser.Scenes.Types.SettingsObject} The Scene Settings object created as a result of the config and default settings.
26+
* @return {Phaser.Types.Scenes.SettingsObject} The Scene Settings object created as a result of the config and default settings.
2727
*/
2828
create: function (config)
2929
{

‎src/scene/Systems.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ var Settings = require('./Settings');
2727
* @since 3.0.0
2828
*
2929
* @param {Phaser.Scene} scene - The Scene that owns this Systems instance.
30-
* @param {(string|Phaser.Scenes.Types.SettingsConfig)} config - Scene specific configuration settings.
30+
* @param {(string|Phaser.Types.Scenes.SettingsConfig)} config - Scene specific configuration settings.
3131
*/
3232
var Systems = new Class({
3333

@@ -78,7 +78,7 @@ var Systems = new Class({
7878
* The Scene Configuration object, as passed in when creating the Scene.
7979
*
8080
* @name Phaser.Scenes.Systems#config
81-
* @type {(string|Phaser.Scenes.Types.SettingsConfig)}
81+
* @type {(string|Phaser.Types.Scenes.SettingsConfig)}
8282
* @since 3.0.0
8383
*/
8484
this.config = config;
@@ -87,7 +87,7 @@ var Systems = new Class({
8787
* The Scene Settings. This is the parsed output based on the Scene configuration.
8888
*
8989
* @name Phaser.Scenes.Systems#settings
90-
* @type {Phaser.Scenes.Types.SettingsObject}
90+
* @type {Phaser.Types.Scenes.SettingsObject}
9191
* @since 3.0.0
9292
*/
9393
this.settings = Settings.create(config);

‎src/scene/typedefs/CreateSceneFromObjectConfig.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* @typedef {object} Phaser.Scenes.Types.CreateSceneFromObjectConfig
2+
* @typedef {object} Phaser.Types.Scenes.CreateSceneFromObjectConfig
33
* @since 3.17.0
44
*
55
* @property {function} [init] - See {@link Phaser.Scene#init}.

0 commit comments

Comments
 (0)