Phaser API Documentation

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
Event: DOWN


The Key Down Event.

This event is dispatched by a Key object when it is pressed.

Listen for this event from the Key object instance directly:

var spaceBar = this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.SPACE);

spaceBar.on('down', listener)

You can also create a generic 'global' listener. See Keyboard.Events.ANY_KEY_DOWN for details.


name type description
key Phaser.Input.Keyboard.Key

The Key object that was pressed.

event KeyboardEvent

The native DOM Keyboard Event. You can inspect this to learn more about any modifiers, etc.

Since: 3.0.0