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

Description:

The Gamepad Button Up Event.

This event is dispatched by a Gamepad instance when a button has been released on it.

Listen to this event from a Gamepad instance. Once way to get this is from the pad1, pad2, etc properties on the Gamepad Plugin: this.input.gamepad.pad1.on('up', listener).

Note that you will not receive any Gamepad button events until the browser considers the Gamepad as being 'connected'.

You can also listen for an UP event from the Gamepad Plugin. See the BUTTON_UP event for details.

Parameters:

name type description
index number

The index of the button that was released.

value number

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

button Phaser.Input.Gamepad.Button

A reference to the Button which was released.