Phaser.Scenes
Scope: static
Source: src/scene/index.js#L10
Static functions
Static functions
GetPhysicsPlugins
<static> GetPhysicsPlugins(sys)
Description:
Builds an array of which physics plugins should be activated for the given Scene.
It checks both the global default physics system defined in the Game configuration and any scene-specific physics settings. Each unique physics plugin key is formatted as a title-cased string with 'Physics' appended (e.g. 'arcade' becomes 'ArcadePhysics'). Returns undefined if neither a default system nor scene-level physics settings are found.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| sys | Phaser.Scenes.Systems | No | The Scene Systems instance for which to resolve active physics plugins. |
Returns: array - An array of physics plugin keys to start for this Scene, or undefined if none are configured.
Source: src/scene/GetPhysicsPlugins.js#L10
Since: 3.0.0
GetScenePlugins
<static> GetScenePlugins(sys)
Description:
Builds an array of which plugins (not including physics plugins) should be activated for the given Scene.
The function checks the Scene's own settings for a plugins array first. If one is defined, it takes priority and is returned immediately. Otherwise, the global default Scene plugins registered with the Plugin Manager are returned. If neither is available, an empty array is returned.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| sys | Phaser.Scenes.Systems | No | The Scene Systems object to check for plugins. |
Returns: array - An array of plugin keys to activate for the Scene. Scene-level plugins take priority over global defaults. Returns an empty array if no plugins are configured.
Source: src/scene/GetScenePlugins.js#L9
Since: 3.0.0
Static functions
Static functions
CREATING
CREATING: number
Description:
Scene is executing its create method.
Source: src/scene/const.js#L55
Since: 3.0.0
DESTROYED
DESTROYED: number
Description:
Scene has been fully destroyed. It can no longer be started or used.
Source: src/scene/const.js#L105
Since: 3.0.0
INIT
INIT: number
Description:
Scene is currently being initialized by the Scene Manager. The init method is being called.
Source: src/scene/const.js#L25
Since: 3.0.0
LOADING
LOADING: number
Description:
Scene is loading assets via its Loader Plugin. The create method will be called after loading completes.
Source: src/scene/const.js#L45
Since: 3.0.0
PAUSED
PAUSED: number
Description:
Scene has been paused via the Scene Manager or Scene Plugin. The update method is not being called, but the scene is still rendering.
Source: src/scene/const.js#L75
Since: 3.0.0
PENDING
PENDING: number
Description:
Scene has been added to the Scene Manager but has not yet been started or initialized.
Source: src/scene/const.js#L15
Since: 3.0.0
RUNNING
RUNNING: number
Description:
Scene is fully running. Both the update and render methods are being called each frame.
Source: src/scene/const.js#L65
Since: 3.0.0
SHUTDOWN
SHUTDOWN: number
Description:
Scene is being shut down. All Game Objects and plugins belonging to it are being destroyed.
Source: src/scene/const.js#L95
Since: 3.0.0
SLEEPING
SLEEPING: number
Description:
Scene has been put to sleep. Neither the update nor the render methods are being called, but the scene is not shut down.
Source: src/scene/const.js#L85
Since: 3.0.0
START
START: number
Description:
Scene is starting up. The create method has not yet been called.
Source: src/scene/const.js#L35
Since: 3.0.0