Navigator: getGamepads() method
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.
Syntax
js
getGamepads()
Parameters
None.
Return value
Exceptions
SecurityErrorDOMException-
Use of this feature was blocked by a Permissions Policy.
Examples
js
window.addEventListener("gamepadconnected", (e) => {
const gp = navigator.getGamepads()[e.gamepad.index];
console.log(
`Gamepad connected at index ${gp.index}: ${gp.id} with ${gp.buttons.length} buttons, ${gp.axes.length} axes.`
);
});
Specifications
| Specification |
|---|
| Gamepad # dom-navigator-getgamepads |
Browser compatibility
BCD tables only load in the browser