Phaser.Scenes

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

Phaser.Scenes.Settings

create

<static> create(config)

Description:

Takes a Scene configuration object and returns a fully formed System Settings object.

Parameters:

name	type	optional	description
config	string | Phaser.Types.Scenes.SettingsConfig	No	The Scene configuration object used to create this Scene Settings.

Returns: Phaser.Types.Scenes.SettingsObject - The Scene Settings object created as a result of the config and default settings.

Source: src/scene/Settings.js#L18
Since: 3.0.0