GamepadEvent.gamepad

The GamepadEvent.gamepad property of the GamepadEvent interface returns a Gamepad object, providing access to the associated gamepad data for fired gamepadconnected and gamepaddisconnected events.

Syntax

readonly    attribute Gamepad gamepad;

Example

The gamepad property being called on a fired Window.gamepadconnected event.

window.addEventListener("gamepadconnected", function(e) {
  console.log("Gamepad connected at index %d: %s. %d buttons, %d axes.",
  e.gamepad.index, e.gamepad.id,
  e.gamepad.buttons.length, e.gamepad.axes.length);
});

Value

A Gamepad object.

Specifications

Specification Status Comment
Gamepad
The definition of 'GamepadEvent.gamepad' in that specification.
Working Draft Initial definition

Browser compatibility

BCD tables only load in the browser

See also

Using the Gamepad API