Namespace: Keyboard

Phaser.Types.Input. Keyboard

Type Definitions


CursorKeys

Type:
  • object
Properties:
Name Type Argument Description
up Phaser.Input.Keyboard.Key <optional>

A Key object mapping to the UP arrow key.

down Phaser.Input.Keyboard.Key <optional>

A Key object mapping to the DOWN arrow key.

left Phaser.Input.Keyboard.Key <optional>

A Key object mapping to the LEFT arrow key.

right Phaser.Input.Keyboard.Key <optional>

A Key object mapping to the RIGHT arrow key.

space Phaser.Input.Keyboard.Key <optional>

A Key object mapping to the SPACE BAR key.

shift Phaser.Input.Keyboard.Key <optional>

A Key object mapping to the SHIFT key.

Since: 3.0.0
Source: src/input/keyboard/typedefs/CursorKeys.js (Line 1)

KeyboardKeydownCallback(event)

Parameters:
Name Type Description
event KeyboardEvent

The Keyboard Event.

Since: 3.0.0
Source: src/input/keyboard/typedefs/KeyboardKeydownCallback.js (Line 1)

KeyComboConfig

Type:
  • object
Properties:
Name Type Argument Default Description
resetOnWrongKey boolean <optional>
true

If they press the wrong key do we reset the combo?

maxKeyDelay number <optional>
0

The max delay in ms between each key press. Above this the combo is reset. 0 means disabled.

resetOnMatch boolean <optional>
false

If previously matched and they press the first key of the combo again, will it reset?

deleteOnMatch boolean <optional>
false

If the combo matches, will it delete itself?

Since: 3.0.0
Source: src/input/keyboard/typedefs/KeyComboConfig.js (Line 1)