Namespace: Settings

Phaser.Scenes. Settings

Methods


<static> create(config)

Takes a Scene configuration object and returns a fully formed Systems object.

Parameters:
Name Type Description
config string | Phaser.Scenes.Settings.Config

[description]

Since: 3.0.0
Source: src/scene/Settings.js (Line 54)
Returns:

[description]

Type
Phaser.Scenes.Settings.Object

Type Definitions


Config

Type:
  • object
Properties:
Name Type Argument Default Description
key string <optional>

[description]

active boolean <optional>
false

[description]

visible boolean <optional>
true

[description]

pack false | Phaser.Loader.FileTypes.PackFileConfig <optional>
false

[description]

cameras InputJSONCameraObject | Array.<InputJSONCameraObject> <optional>
<nullable>
null

[description]

map Object.<string, string> <optional>

Overwrites the default injection map for a scene.

mapAdd Object.<string, string> <optional>

Extends the injection map for a scene.

physics object <optional>
{}

[description]

loader object <optional>
{}

[description]

plugins false | * <optional>
false

[description]

Source: src/scene/Settings.js (Line 16)

Object

Type:
  • object
Properties:
Name Type Argument Description
status number

[description]

key string

[description]

active boolean

[description]

visible boolean

[description]

isBooted boolean

[description]

isTransition boolean

[description]

transitionFrom Phaser.Scene <nullable>

[description]

transitionDuration integer

[description]

transitionAllowInput boolean

[description]

data object

[description]

pack false | Phaser.Loader.FileTypes.PackFileConfig

[description]

cameras InputJSONCameraObject | Array.<InputJSONCameraObject> <nullable>

[description]

map Object.<string, string>

[description]

physics object

[description]

loader object

[description]

plugins false | *

[description]

Source: src/scene/Settings.js (Line 31)