GamepadEvent: gamepad property

{{APIRef("Gamepad API")}}{{SecureContext_Header}}

The GamepadEvent.gamepad property of the {{domxref("GamepadEvent")}} interface returns a {{domxref("Gamepad")}} object, providing access to the associated gamepad data for fired {{domxref("Window.gamepadconnected_event", "gamepadconnected")}} and {{domxref("Window.gamepaddisconnected_event", "gamepaddisconnected")}} events.

Value

A {{domxref("Gamepad")}} object.

Examples

The gamepad property being called on a fired {{domxref("Window.gamepadconnected_event", "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,
  );
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

Using the Gamepad API