Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-24 05:33:35 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #5172 from lozzajp/quick-doc-fix

Browse source 
Add info to the scene manager method headers where optional data goes.
This commit is contained in:
Richard Davey 2020-07-13 12:36:51 +01:00 committed by GitHub
commit 56084dfa89
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/scene/SceneManager.js
View file

@ -314,7 +314,7 @@ var SceneManager = new Class({
* @param {string} key - A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.
* @param {(Phaser.Scene|Phaser.Types.Scenes.SettingsConfig|Phaser.Types.Scenes.CreateSceneFromObjectConfig|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`.
* @param {object} [data] - Optional data object. This will be set as `Scene.settings.data` and passed to `Scene.init`, and `Scene.create`.
*
* @return {?Phaser.Scene} The added Scene, if it was added immediately, otherwise `null`.
*/
@ -1135,7 +1135,7 @@ var SceneManager = new Class({
* @since 3.0.0
*
* @param {string} key - The Scene to start.
* @param {object} [data] - Optional data object to pass to Scene.Settings and Scene.init.
* @param {object} [data] - Optional data object to pass to `Scene.Settings` and `Scene.init`, and `Scene.create`.
*
* @return {Phaser.Scenes.SceneManager} This SceneManager.
*/