Types.Scenes

init

Phaser.Types.Scenes.SceneInitCallback

Yes

The scene's init callback.

preload

Phaser.Types.Scenes.ScenePreloadCallback

Yes

The scene's preload callback.

create

Phaser.Types.Scenes.SceneCreateCallback

Yes

The scene's create callback.

update

Phaser.Types.Scenes.SceneUpdateCallback

Yes

The scene's update callback. See {@link Phaser.Scene#update}.

extend

any

Yes

Any additional properties, which will be copied to the Scene after it's created (except data or sys).

extend.data

any

Yes

Any values, which will be merged into the Scene's Data Manager store.

target

string

No

The Scene key to transition to.

duration

number

Yes

1000

The duration, in ms, for the transition to last.

sleep

boolean

Yes

false

Will the Scene responsible for the transition be sent to sleep on completion (true), or stopped? (false)

remove

boolean

Yes

false

Will the Scene responsible for the transition be removed from the Scene Manager after the transition completes?

allowInput

boolean

Yes

false

Will the Scenes Input system be able to process events while it is transitioning in or out?

moveAbove

boolean

Yes

Move the target Scene to be above this one before the transition starts.

moveBelow

boolean

Yes

Move the target Scene to be below this one before the transition starts.

onUpdate

function

Yes

This callback is invoked every frame for the duration of the transition.

onUpdateScope

any

Yes

The context in which the callback is invoked.

onStart

Phaser.Types.Scenes.SceneTransitionOnStartCallback

Yes

This callback is invoked when transition starting.

onStartScope

any

Yes

The context in which the callback is invoked.

data

any

Yes

An object containing any data you wish to be passed to the target scene's init / create methods (if sleep is false) or to the target scene's wake event callback (if sleep is true).

duration

number

Yes

1000

The duration, in ms, for the transition to last.

key

string

Yes

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

active

boolean

Yes

false

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

visible

boolean

Yes

true

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

pack

false | Phaser.Types.Loader.FileTypes.PackFileSection

Yes

false

Files to be loaded before the Scene begins.

cameras

Phaser.Types.Cameras.Scene2D.CameraConfig | Array.<Phaser.Types.Cameras.Scene2D.CameraConfig>

Yes

null

An optional Camera configuration object.

map

Object.<string, string>

Yes

Overwrites the default injection map for a scene.

mapAdd

Object.<string, string>

Yes

Extends the injection map for a scene.

physics

Phaser.Types.Core.PhysicsConfig

Yes

"{}"

The physics configuration object for the Scene.

loader

Phaser.Types.Core.LoaderConfig

Yes

"{}"

The loader configuration object for the Scene.

plugins

false | *

Yes

false

The plugin configuration object for the Scene.

status

number

No

The current status of the Scene. Maps to the Scene constants.

key

string

No

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

active

boolean

No

The active state of this Scene. An active Scene updates each step.

visible

boolean

No

The visible state of this Scene. A visible Scene renders each step.

isBooted

boolean

No

Has the Scene finished booting?

isTransition

boolean

No

Is the Scene in a state of transition?

transitionFrom

Phaser.Scene

No

The Scene this Scene is transitioning from, if set.

transitionDuration

number

No

The duration of the transition, if set.

transitionAllowInput

boolean

No

Is this Scene allowed to receive input during transitions?

data

object

No

a data bundle passed to this Scene from the Scene Manager.

pack

false | Phaser.Types.Loader.FileTypes.PackFileSection

No

Files to be loaded before the Scene begins.

cameras

Phaser.Types.Cameras.Scene2D.CameraConfig | Array.<Phaser.Types.Cameras.Scene2D.CameraConfig>

No

The Camera configuration object.

map

Object.<string, string>

No

The Scene's Injection Map.

physics

Phaser.Types.Core.PhysicsConfig

No

The physics configuration object for the Scene.

loader

Phaser.Types.Core.LoaderConfig

No

The loader configuration object for the Scene.

plugins

false | *

No

The plugin configuration object for the Scene.