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
Namespace: Scenes
Phaser.Scenes
Source: src/scene/index.js (Line 10)

Classes

Namespace

Members

<static, readonly> CREATING: number
Focus
Focus

Description:

Scene state.

Type:
number
Since: 3.0.0
Source: src/scene/const.js (Line 55)
Focus
Focus
<static, readonly> DESTROYED: number
Focus
Focus

Description:

Scene state.

Type:
number
Since: 3.0.0
Source: src/scene/const.js (Line 105)
Focus
Focus
<static, readonly> INIT: number
Focus
Focus

Description:

Scene state.

Type:
number
Since: 3.0.0
Source: src/scene/const.js (Line 25)
Focus
Focus
<static, readonly> LOADING: number
Focus
Focus

Description:

Scene state.

Type:
number
Since: 3.0.0
Source: src/scene/const.js (Line 45)
Focus
Focus
<static, readonly> PAUSED: number
Focus
Focus

Description:

Scene state.

Type:
number
Since: 3.0.0
Source: src/scene/const.js (Line 75)
Focus
Focus
<static, readonly> PENDING: number
Focus
Focus

Description:

Scene state.

Type:
number
Since: 3.0.0
Source: src/scene/const.js (Line 15)
Focus
Focus
<static, readonly> RUNNING: number
Focus
Focus

Description:

Scene state.

Type:
number
Since: 3.0.0
Source: src/scene/const.js (Line 65)
Focus
Focus
<static, readonly> SHUTDOWN: number
Focus
Focus

Description:

Scene state.

Type:
number
Since: 3.0.0
Source: src/scene/const.js (Line 95)
Focus
Focus
<static, readonly> SLEEPING: number
Focus
Focus

Description:

Scene state.

Type:
number
Since: 3.0.0
Source: src/scene/const.js (Line 85)
Focus
Focus
<static, readonly> START: number
Focus
Focus

Description:

Scene state.

Type:
number
Since: 3.0.0
Source: src/scene/const.js (Line 35)
Focus
Focus

Methods

<static> GetPhysicsPlugins(sys)
Focus
Focus

Description:

Builds an array of which physics plugins should be activated for the given Scene.

Parameters:

name type description
sys Phaser.Scenes.Systems

The scene system to get the physics systems of.

Returns:
Description:

An array of Physics systems to start for this Scene.

Type:
  • array
Examples:
Since: 3.0.0
Focus
Focus
<static> GetScenePlugins(sys)
Focus
Focus

Description:

Builds an array of which plugins (not including physics plugins) should be activated for the given Scene.

Parameters:

name type description
sys Phaser.Scenes.Systems

The Scene Systems object to check for plugins.

Returns:
Description:

An array of all plugins which should be activated, either the default ones or the ones configured in the Scene Systems object.

Type:
  • array
Examples:
Since: 3.0.0
Focus
Focus