Phaser API Documentation

  Version: 
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: BUTTON_DOWN
Phaser.Input.Gamepad.Events.BUTTON_DOWN
BUTTON_DOWN

Description:

The Gamepad Button Down Event.

This event is dispatched by the Gamepad Plugin when a button has been pressed on any active Gamepad.

Listen to this event from within a Scene using: this.input.gamepad.on('down', listener).

You can also listen for a DOWN event from a Gamepad instance. See the GAMEPAD_BUTTON_DOWN event for details.

Parameters:

name type description
pad Phaser.Input.Gamepad

A reference to the Gamepad on which the button was pressed.

button Phaser.Input.Gamepad.Button

A reference to the Button which was pressed.

value number

The value of the button at the time it was pressed. Between 0 and 1. Some Gamepads have pressure-sensitive buttons.

Since: 3.10.0