W3cubDocs

/Web APIs

GamepadButton

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

The GamepadButton interface defines an individual button of a gamepad or other controller, allowing access to the current state of different types of buttons available on the control device.

A GamepadButton object is returned by querying any value of the array returned by the buttons property of the Gamepad interface.

Instance properties

GamepadButton.pressed Read only

A boolean value indicating whether the button is currently pressed (true) or unpressed (false).

GamepadButton.touched Read only

A boolean value indicating whether the button is currently touched (true) or not touched (false).

GamepadButton.value Read only

A double value used to represent the current state of analog buttons, such as the triggers on many modern gamepads. The values are normalized to the range 0.0 —1.0, with 0.0 representing a button that is not pressed, and 1.0 representing a button that is fully pressed.

Example

The button values in the following example are stored as an array of GamepadButton objects. This simple example checks to see if the GamepadButton.value of a button is greater than 0, or if the GamepadButton.pressed property indicates the button has been pressed.

js

function gameLoop() {
  const gp = navigator.getGamepads()[0];

  if (gp.buttons[0].value > 0 || gp.buttons[0].pressed) {
    b--;
  } else if (gp.buttons[1].value > 0 || gp.buttons[1].pressed) {
    a++;
  } else if (gp.buttons[2].value > 0 || gp.buttons[2].pressed) {
    b++;
  } else if (gp.buttons[3].value > 0 || gp.buttons[3].pressed) {
    a--;
  }

  ball.style.left = `${a * 2}px`; // ball is a UI widget
  ball.style.top = `${b * 2}px`;

  requestAnimationFrame(gameLoop);
}

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
GamepadButton 21 12 29 No 15 10.1 4.4 25 32 14 10.3 1.5
pressed 21 12 29 No 15 10.1 4.4 25 32 14 10.3 1.5
secure_context_required 86 86 91 No 72 No No 86 91 No No No
touched 73 15 55 No 60 No No 73 55 52 No 11.0
value 21 12 29 No 15 10.1 4.4 25 32 14 10.3 1.5

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/GamepadButton