Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Scene

This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Scene

A base Phaser.Scene class which can be extended for your own use.

You can also define the optional methods init(), preload(), and create().

Constructor:

new Scene(config)

Parameters:

name type description
config string | Phaser.Types.Scenes.SettingsConfig

Scene specific configuration settings.

Since: 3.0.0
Source: src/scene/Scene.js (Line 10)

Members

Description:

A scene level Game Object Factory. This property will only be available if defined in the Scene Injection Map.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 118)
Focus
Focus

Description:

A reference to the global Animation Manager. This property will only be available if defined in the Scene Injection Map.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 48)
Focus
Focus

Description:

A reference to the global Cache. This property will only be available if defined in the Scene Injection Map.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 58)
Focus
Focus

Description:

A scene level Camera System. This property will only be available if defined in the Scene Injection Map.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 108)
Focus
Focus

Description:

A scene level Game Object Display List. This property will only be available if defined in the Scene Injection Map.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 148)
Focus
Focus

Description:

A scene level Data Manager Plugin. This property will only be available if defined in the Scene Injection Map and the plugin is installed.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 168)
Focus
Focus

Description:

A scene level Event Emitter. This property will only be available if defined in the Scene Injection Map.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 98)
Focus
Focus

Description:

A scene level Facebook Instant Games Plugin. This property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.

Type:
Since: 3.12.0
Source: src/scene/Scene.js (Line 240)
Focus
Focus
game: Phaser.Game
Focus
Focus

Description:

A reference to the Phaser.Game instance. This property will only be available if defined in the Scene Injection Map.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 38)
Focus
Focus

Description:

A scene level Input Manager Plugin. This property will only be available if defined in the Scene Injection Map and the plugin is installed.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 178)
Focus
Focus

Description:

A scene level Lights Manager Plugin. This property will only be available if defined in the Scene Injection Map and the plugin is installed.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 158)
Focus
Focus

Description:

A scene level Loader Plugin. This property will only be available if defined in the Scene Injection Map and the plugin is installed.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 188)
Focus
Focus

Description:

A scene level Game Object Creator. This property will only be available if defined in the Scene Injection Map.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 128)
Focus
Focus

Description:

A scene level Matter Physics Plugin. This property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 228)
Focus
Focus

Description:

A scene level Arcade Physics Plugin. This property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 218)
Focus
Focus

Description:

A reference to the Plugin Manager.

The Plugin Manager is a global system that allows plugins to register themselves with it, and can then install those plugins into Scenes as required.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 261)
Focus
Focus

Description:

A reference to the game level Data Manager. This property will only be available if defined in the Scene Injection Map.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 68)
Focus
Focus

Description:

A reference to the renderer instance Phaser is using, either Canvas or WebGL.

Type:
Since: 3.50.0
Source: src/scene/Scene.js (Line 273)
Focus
Focus

Description:

A reference to the global Scale Manager. This property will only be available if defined in the Scene Injection Map.

Type:
Since: 3.16.2
Source: src/scene/Scene.js (Line 251)
Focus
Focus

Description:

A reference to the Scene Manager Plugin. This property will only be available if defined in the Scene Injection Map.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 138)
Focus
Focus

Description:

A reference to the Sound Manager. This property will only be available if defined in the Scene Injection Map and the plugin is installed.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 78)
Focus
Focus

Description:

The Scene Systems. You must never overwrite this property, or all hell will break lose.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 29)
Focus
Focus

Description:

A reference to the Texture Manager. This property will only be available if defined in the Scene Injection Map.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 88)
Focus
Focus

Description:

A scene level Time and Clock Plugin. This property will only be available if defined in the Scene Injection Map and the plugin is installed.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 198)
Focus
Focus

Description:

A scene level Tween Manager Plugin. This property will only be available if defined in the Scene Injection Map and the plugin is installed.

Type:
Since: 3.0.0
Source: src/scene/Scene.js (Line 208)
Focus
Focus

Methods

update(time, delta)
Focus
Focus

Description:

Should be overridden by your own Scenes. This method is called once per game step while the scene is running.

Parameters:

name type description
time number

The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.

delta number

The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.

Examples:
Since: 3.0.0
Source: src/scene/Scene.js (Line 283)
Focus
Focus