W3cubDocs

/Web APIs

GamepadEvent

Baseline Widely available *

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨March 2017⁩.

* Some parts of this feature may have varying levels of support.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The GamepadEvent interface of the Gamepad API contains references to gamepads connected to the system, which is what the gamepad events gamepadconnected and gamepaddisconnected are fired in response to.

Constructor

GamepadEvent(): Returns a new GamepadEvent object.

Instance properties

GamepadEvent.gamepad Read only: Returns a Gamepad object, providing access to the associated gamepad data for the event fired.

Examples

The gamepad property being called on a fired gamepadconnected event.

window.addEventListener("gamepadconnected", (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,
  );
});

And on a gamepaddisconnected event.

window.addEventListener("gamepaddisconnected", (e) => {
  console.log(
    "Gamepad disconnected from index %d: %s",
    e.gamepad.index,
    e.gamepad.id,
  );
});

Specifications

Specification
Gamepad> # gamepadevent-interface>

Browser compatibility