Interface: GamepadPluginEventsMap

Phaser.Types.Input.Gamepad. GamepadPluginEventsMap

Methods


connected(pad, event)

The Gamepad Connected Event.

This event is dispatched by the Gamepad Plugin when a Gamepad has been connected.

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

Note that the browser may require you to press a button on a gamepad before it will allow you to access it, this is for security reasons. However, it may also trust the page already, in which case you won't get the 'connected' event and instead should check GamepadPlugin.total to see if it thinks there are any gamepads already connected.

Parameters:
Name Type Description
pad Phaser.Input.Gamepad

A reference to the Gamepad which was connected.

event Event

The native DOM Event that triggered the connection.

Since: 3.0.0
Source: src/input/gamepad/events/CONNECTED_EVENT.js (Line 27)

disconnected(pad, event)

The Gamepad Disconnected Event.

This event is dispatched by the Gamepad Plugin when a Gamepad has been disconnected.

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

Parameters:
Name Type Description
pad Phaser.Input.Gamepad

A reference to the Gamepad which was disconnected.

event Event

The native DOM Event that triggered the disconnection.

Since: 3.0.0
Source: src/input/gamepad/events/DISCONNECTED_EVENT.js (Line 22)

down(pad, button, value)

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
Source: src/input/gamepad/events/BUTTON_DOWN_EVENT.js (Line 25)

up(pad, button, value)

The Gamepad Button Up Event.

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

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

You can also listen for an UP event from a Gamepad instance. See the GAMEPAD_BUTTON_UP event for details.

Parameters:
Name Type Description
pad Phaser.Input.Gamepad

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

button Phaser.Input.Gamepad.Button

A reference to the Button which 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.

Since: 3.10.0
Source: src/input/gamepad/events/BUTTON_UP_EVENT.js (Line 25)