Phaser.Plugins.PluginCache
register
<static> register(key, plugin, mapping, [custom])
Description:
Registers a core plugin with the PluginCache. This is called directly by Phaser's internal core plugins during setup. The plugin is stored as the source constructor and is not instantiated at this stage.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| key | string | No | A reference used to get this plugin from the plugin cache. | |
| plugin | function | No | The plugin to be stored. Should be the core object, not instantiated. | |
| mapping | string | No | If this plugin is to be injected into the Scene Systems, this is the property key map used. | |
| custom | boolean | Yes | false | Core Scene plugin or a Custom Scene plugin? |
Source: src/plugins/PluginCache.js#L21
Since: 3.8.0
registerCustom
<static> registerCustom(key, plugin, mapping, data)
Description:
Stores a custom plugin in the global plugin cache. The key must be unique, within the scope of the cache.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| key | string | No | A reference used to get this plugin from the plugin cache. |
| plugin | function | No | The plugin to be stored. Should be the core object, not instantiated. |
| mapping | string | No | If this plugin is to be injected into the Scene Systems, this is the property key map used. |
| data | any | No | A value to be passed to the plugin's init method. |
Source: src/plugins/PluginCache.js#L41
Since: 3.8.0
hasCore
<static> hasCore(key)
Description:
Checks if the given key is already being used in the core plugin cache.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| key | string | No | The key to check for. |
Returns: boolean - true if the key is already in use in the core cache, otherwise false.
Source: src/plugins/PluginCache.js#L58
Since: 3.8.0
hasCustom
<static> hasCustom(key)
Description:
Checks if the given key is already being used in the custom plugin cache.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| key | string | No | The key to check for. |
Returns: boolean - true if the key is already in use in the custom cache, otherwise false.
Source: src/plugins/PluginCache.js#L73
Since: 3.8.0
getCore
<static> getCore(key)
Description:
Returns the core plugin object from the cache based on the given key.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| key | string | No | The key of the core plugin to get. |
Returns: Phaser.Types.Plugins.CorePluginContainer - The core plugin object.
Source: src/plugins/PluginCache.js#L88
Since: 3.8.0
getCustom
<static> getCustom(key)
Description:
Returns the custom plugin object from the cache based on the given key.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| key | string | No | The key of the custom plugin to get. |
Returns: Phaser.Types.Plugins.CustomPluginContainer - The custom plugin object.
Source: src/plugins/PluginCache.js#L103
Since: 3.8.0
getCustomClass
<static> getCustomClass(key)
Description:
Returns the plugin constructor function from the custom plugin cache based on the given key, or null if no entry for that key exists.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| key | string | No | The key of the custom plugin to get. |
Returns: function - The custom plugin object.
Source: src/plugins/PluginCache.js#L118
Since: 3.8.0
remove
<static> remove(key)
Description:
Removes a core plugin based on the given key.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| key | string | No | The key of the core plugin to remove. |
Source: src/plugins/PluginCache.js#L134
Since: 3.8.0
removeCustom
<static> removeCustom(key)
Description:
Removes a custom plugin based on the given key.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| key | string | No | The key of the custom plugin to remove. |
Source: src/plugins/PluginCache.js#L150
Since: 3.8.0
destroyCorePlugins
<static> destroyCorePlugins()
Description:
Removes all Core Plugins.
This includes all of the internal system plugins that Phaser needs, like the Input Plugin and Loader Plugin. So be sure you only call this if you do not wish to run Phaser again.
Source: src/plugins/PluginCache.js#L166
Since: 3.12.0
destroyCustomPlugins
<static> destroyCustomPlugins()
Description:
Removes all Custom Plugins.
This removes any plugins that were registered by the developer via the Plugin Manager, but does not affect the core internal plugins that Phaser requires to run.
Source: src/plugins/PluginCache.js#L186
Since: 3.12.0