The Keyboard Plugin instance that owns this Key object.
The keycode of this key.
The down state of the ALT key, if pressed at the same time as this key.
The down state of the CTRL key, if pressed at the same time as this key.
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.
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.
Can this Key be processed?
The "down" state of the key. This will remain true for as long as the keyboard thinks this key is held down.
The "up" state of the key. This will remain true for as long as the keyboard thinks this key is up.
The keycode of this key.
The location of the modifier key. 0 for standard (or unknown), 1 for left, 2 for right, 3 for numpad.
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.
The original DOM event.
The Keyboard Plugin instance that owns this Key object.
If a key is held down this holds the number of times the key has 'repeated'.
The down state of the SHIFT key, if pressed at the same time as this key.
The timestamp when the key was last pressed down.
The timestamp when the key was last released.
Add a listener for a given event.
The event name.
The listener function.
Optionalcontext: any
The context to invoke the listener with. Default this.
this.
Removes any bound event handlers and removes local references.
Calls each of the listeners registered for a given event.
The event name.
Additional arguments that will be passed to the event handler.
true if the event had listeners, else false.
Return an array listing the events for which the emitter has registered listeners.undefined
undefined
Returns the duration, in ms, that the Key has been held down for.
If the key is not currently down it will return zero.
To get the duration the Key was held down for in the previous up-down cycle,
use the Key.duration property value instead.undefined
The duration, in ms, that the Key has been held down for if currently down.
Return the number of listeners listening to a given event.
The event name.
The number of listeners.
Return the listeners registered for a given event.
The event name.
The registered listeners.
Remove the listeners of a given event.
The event name.
Optionalfn: Function
Only remove the listeners that match this function.
Optionalcontext: any
Only remove the listeners that have this context.
Optionalonce: boolean
Only remove one-time listeners.
this.
Add a listener for a given event.
The event name.
The listener function.
Optionalcontext: any
The context to invoke the listener with. Default this.
this.
Add a one-time listener for a given event. The listener is automatically removed the first time the event is emitted, so it will never be called more than once.
The event name.
The listener function.
Optionalcontext: any
The context to invoke the listener with. Default this.
this.
Processes the Key Down action for this Key. Called automatically by the Keyboard Plugin.
The native DOM Keyboard event.
Processes the Key Up action for this Key. Called automatically by the Keyboard Plugin.
The native DOM Keyboard event.
Remove all listeners, or those of the specified event.
Optionalevent: string | symbol
The event name.
this.
Remove the listeners of a given event.
The event name.
Optionalfn: Function
Only remove the listeners that match this function.
Optionalcontext: any
Only remove the listeners that have this context.
Optionalonce: boolean
Only remove one-time listeners.
this.
Resets this Key object back to its default un-pressed state.
As of version 3.60.0 it no longer resets the enabled or preventDefault flags.undefined
This Key instance.
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).
Emit down events on repeated key down actions, or just once?
This Key instance.
Removes all listeners from this EventEmitter. This method is called automatically by the Scene Systems when the parent Scene shuts down, ensuring that all event bindings are cleared and no stale references remain.
Represents a single key on the keyboard. Key objects are created by the Keyboard Plugin via
addKey()and track the state of a specific key, including whether it is currently held down, the duration it has been held, timestamps for press and release events, and repeat counts. You can poll Key objects directly in your game loop using properties likeisDownandisUp, or listen for events via theonmethod. The keyCode must be an integer corresponding to aPhaser.Input.Keyboard.KeyCodesvalue.