Firefox Tomorrow

web api interface

Gamepad

View on MDN ↗

The Gamepad interface of the Gamepad API defines an individual gamepad or other controller, allowing access to information such as button presses, axis positions, and id.

A Gamepad object can be returned in one of two ways: via the gamepad property of the gamepadconnected and gamepaddisconnected events, or by grabbing any position in the array returned by the getGamepads() method.

[!NOTE] The support of gamepad features varies across different combinations of platforms and controllers. Even if the controller supports a certain feature (for example, haptic feedback), the platform may not support it for that controller.

Instance properties

  • axes Read only
    • : An array representing the controls with axes present on the device (e.g., analog thumb sticks).
  • buttons Read only
    • : An array of gamepadButton objects representing the buttons present on the device.
  • connected Read only
    • : A boolean indicating whether the gamepad is still connected to the system.
  • displayId Read only Deprecated
    • : Returns the displayId of an associated VRDisplay (if relevant) — the VRDisplay that the gamepad is controlling the displayed scene of.
  • hand Read only Experimental
    • : An enum defining what hand the controller is being held in, or is most likely to be held in.
  • hapticActuators Read only Experimental
    • : An array containing GamepadHapticActuator objects, each of which represents haptic feedback hardware available on the controller.
  • vibrationActuator Read only
    • : A GamepadHapticActuator object, which represents haptic feedback hardware available on the controller.
  • id Read only
    • : A string containing identifying information about the controller.
  • index Read only
    • : An integer that is auto-incremented to be unique for each device currently connected to the system.
  • mapping Read only
    • : A string indicating whether the browser has remapped the controls on the device to a known layout.
  • pose Read only Experimental
    • : A GamepadPose object representing the pose information associated with a WebVR controller (e.g., its position and orientation in 3D space).
  • timestamp Read only

Example

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

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.

See also