Filter
A generic Key object which can be passed to the Process functions (and so on) keycode must be an integer
Constructor:
new Key(plugin, keyCode)
Parameters:
| name | type | description |
|---|---|---|
| plugin | Phaser.Input.Keyboard.KeyboardPlugin |
The Keyboard Plugin instance that owns this Key object. |
| keyCode | number |
The keycode of this key. |
Extends
Members
Description:
The down state of the ALT key, if pressed at the same time as this key.
Type:
Description:
The down state of the CTRL key, if pressed at the same time as this key.
Type:
Description:
The number of milliseconds this key was held down for in the previous down - up sequence.
This value isn't updated every game step, only when the Key changes state.
To get the current duration use the getDuration method.
Type:
Description:
When a key is held down should it continuously fire the down event each time it repeats?
By default it will emit the down event just once, but if you wish to receive the event
for each repeat as well, enable this property.
Type:
Description:
Can this Key be processed?
Type:
Description:
The "down" state of the key. This will remain true for as long as the keyboard thinks this key is held down.
Type:
Description:
The "up" state of the key. This will remain true for as long as the keyboard thinks this key is up.
Type:
Description:
The keycode of this key.
Type:
Description:
The location of the modifier key. 0 for standard (or unknown), 1 for left, 2 for right, 3 for numpad.
Type:
Description:
The down state of the Meta key, if pressed at the same time as this key. On a Mac the Meta Key is the Command key. On Windows keyboards, it's the Windows key.
Type:
Description:
The original DOM event.
Type:
Description:
The Keyboard Plugin instance that owns this Key object.
Description:
If a key is held down this holds down the number of times the key has 'repeated'.
Type:
Description:
The down state of the SHIFT key, if pressed at the same time as this key.
Type:
Description:
The timestamp when the key was last pressed down.
Type:
Description:
The timestamp when the key was last released.
Type:
Methods
Description:
Add a listener for a given event.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| event | string | symbol |
The event name. |
||
| fn | function |
The listener function. |
||
| context | * | <optional> | this |
The context to invoke the listener with. |
Returns:
Description:
this.
Description:
Removes any bound event handlers and removes local references.
Description:
Calls each of the listeners registered for a given event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol |
The event name. |
|
| args | * | <optional> |
Additional arguments that will be passed to the event handler. |
Returns:
Description:
true if the event had listeners, else false.
Type:
- boolean
Description:
Return an array listing the events for which the emitter has registered listeners.
Type:
- Array.<(string
- symbol)>
Description:
Returns the duration, in ms, that the Key has been held down for.
If the key is not currently down it will return zero.
The get the duration the Key was held down for in the previous up-down cycle,
use the Key.duration property value instead.
Returns:
Description:
The duration, in ms, that the Key has been held down for if currently down.
Type:
- number
Description:
Return the number of listeners listening to a given event.
Parameters:
| name | type | description |
|---|---|---|
| event | string | symbol |
The event name. |
Returns:
Description:
The number of listeners.
Type:
- number
Description:
Return the listeners registered for a given event.
Parameters:
| name | type | description |
|---|---|---|
| event | string | symbol |
The event name. |
Returns:
Description:
The registered listeners.
Type:
- Array.<function()>
Description:
Remove the listeners of a given event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol |
The event name. |
|
| fn | function | <optional> |
Only remove the listeners that match this function. |
| context | * | <optional> |
Only remove the listeners that have this context. |
| once | boolean | <optional> |
Only remove one-time listeners. |
Returns:
Description:
this.
Description:
Add a listener for a given event.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| event | string | symbol |
The event name. |
||
| fn | function |
The listener function. |
||
| context | * | <optional> | this |
The context to invoke the listener with. |
Returns:
Description:
this.
Description:
Processes the Key Down action for this Key. Called automatically by the Keyboard Plugin.
Parameters:
| name | type | description |
|---|---|---|
| event | KeyboardEvent |
The native DOM Keyboard event. |
Description:
Processes the Key Up action for this Key. Called automatically by the Keyboard Plugin.
Parameters:
| name | type | description |
|---|---|---|
| event | KeyboardEvent |
The native DOM Keyboard event. |
Description:
Add a one-time listener for a given event.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| event | string | symbol |
The event name. |
||
| fn | function |
The listener function. |
||
| context | * | <optional> | this |
The context to invoke the listener with. |
Returns:
Description:
this.
Description:
Remove all listeners, or those of the specified event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol | <optional> |
The event name. |
Returns:
Description:
this.
Description:
Remove the listeners of a given event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol |
The event name. |
|
| fn | function | <optional> |
Only remove the listeners that match this function. |
| context | * | <optional> |
Only remove the listeners that have this context. |
| once | boolean | <optional> |
Only remove one-time listeners. |
Returns:
Description:
this.
Description:
Resets this Key object back to its default un-pressed state.
Returns:
Description:
This Key instance.
Description:
Controls if this Key will continuously emit a down event while being held down (true),
or emit the event just once, on first press, and then skip future events (false).
Parameters:
| name | type | description |
|---|---|---|
| value | boolean |
Emit |
Returns:
Description:
This Key instance.
Description:
Removes all listeners.