Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-22 12:43:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #6450 from samme/docs/CameraConfig

Browse source 
Docs: correct types for SettingsConfig.cameras and SettingsObject.cameras
This commit is contained in:
Richard Davey 2023-04-04 15:08:59 +01:00 committed by GitHub
commit 26c90c4492
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/scene/typedefs/SettingsConfig.js
View file

@ -6,7 +6,7 @@
* @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.Types.Loader.FileTypes.PackFileSection)} [pack=false] - Files to be loaded before the Scene begins.
* @property {?(Phaser.Types.Cameras.Scene2D.JSONCamera|Phaser.Types.Cameras.Scene2D.JSONCamera[])} [cameras=null] - An optional Camera configuration object.
* @property {?(Phaser.Types.Cameras.Scene2D.CameraConfig|Phaser.Types.Cameras.Scene2D.CameraConfig[])} [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 {Phaser.Types.Core.PhysicsConfig} [physics={}] - The physics configuration object for the Scene.

2
src/scene/typedefs/SettingsObject.js
View file

@ -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.Types.Loader.FileTypes.PackFileSection)} pack - Files to be loaded before the Scene begins.
* @property {?(Phaser.Types.Cameras.Scene2D.JSONCamera|Phaser.Types.Cameras.Scene2D.JSONCamera[])} cameras - The Camera configuration object.
* @property {?(Phaser.Types.Cameras.Scene2D.CameraConfig|Phaser.Types.Cameras.Scene2D.CameraConfig[])} cameras - The Camera configuration object.
* @property {Object.<string, string>} map - The Scene's Injection Map.
* @property {Phaser.Types.Core.PhysicsConfig} physics - The physics configuration object for the Scene.
* @property {Phaser.Types.Core.LoaderConfig} loader - The loader configuration object for the Scene.