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: InputPluginCache
Phaser.Input.InputPluginCache

Methods

<static> register(key, plugin, mapping, settingsKey, configKey)
Focus
Focus

Description:

Static method called directly by the Core internal Plugins. Key is a reference used to get the plugin from the plugins object (i.e. InputPlugin) Plugin is the object to instantiate to create the plugin Mapping is what the plugin is injected into the Scene.Systems as (i.e. input)

Parameters:

name type description
key string

A reference used to get this plugin from the plugin cache.

plugin function

The plugin to be stored. Should be the core object, not instantiated.

mapping string

If this plugin is to be injected into the Input Plugin, this is the property key used.

settingsKey string

The key in the Scene Settings to check to see if this plugin should install or not.

configKey string

The key in the Game Config to check to see if this plugin should install or not.

Examples:
Since: 3.10.0
Focus
Focus
<static> getPlugin(key)
Focus
Focus

Description:

Returns the input plugin object from the cache based on the given key.

Parameters:

name type description
key string

The key of the input plugin to get.

Returns:
Description:

The input plugin object.

Examples:
Since: 3.10.0
Focus
Focus
<static> install(target)
Focus
Focus

Description:

Installs all of the registered Input Plugins into the given target.

Parameters:

name type description
target Phaser.Input.InputPlugin

The target InputPlugin to install the plugins into.

Examples:
Since: 3.10.0
Focus
Focus
<static> remove(key)
Focus
Focus

Description:

Removes an input plugin based on the given key.

Parameters:

name type description
key string

The key of the input plugin to remove.

Examples:
Since: 3.10.0
Focus
Focus