Phaser API Documentation

  Version: 
SettingsConfig
Properties:
name type arguments Default description
key string <optional>

The unique key of this Scene. Must be unique within the entire Game instance.

active boolean <optional> false

Does the Scene start as active or not? An active Scene updates each step.

visible boolean <optional> true

Does the Scene start as visible or not? A visible Scene renders each step.

pack false | Phaser.Types.Loader.FileTypes.PackFileSection <optional> false

Files to be loaded before the Scene begins.

cameras Phaser.Types.Cameras.Scene2D.JSONCamera | Array.<Phaser.Types.Cameras.Scene2D.JSONCamera> <optional> null

An optional Camera configuration object.

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 Phaser.Types.Core.PhysicsConfig <optional> {}

The physics configuration object for the Scene.

loader Phaser.Types.Core.LoaderConfig <optional> {}

The loader configuration object for the Scene.

plugins false | * <optional> false

The plugin configuration object for the Scene.

Type:
object
Since: 3.0.0