Navigator.getGamepads()

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

The Navigator.getGamepads() method returns an array of Gamepad objects, one for each gamepad connected to the device.

Elements in the array may be null if a gamepad disconnects during a session, so that the remaining gamepads retain the same index.

Calls to this method will throw a SecurityError DOMException if disallowed by the gamepad Feature Policy.

Syntax

getGamepads()

Parameters

None.

Return value

An Array of Gamepad objects, eventually empty.

Examples

window.addEventListener("gamepadconnected", (e) => {
  const gp = navigator.getGamepads()[e.gamepad.index];
  console.log(`Gamepad connected at index ${gp.index}: ${gpid} with ${gp.buttons.length} buttons, ${gp.axes.length} axes.`);
});

Specifications

Specification
Gamepad
# dom-navigator-getgamepads

Browser compatibility

BCD tables only load in the browser

See also