GamepadHapticActuator: effects property

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The effects read-only property of the GamepadHapticActuator interface returns an array of enumerated values representing the different haptic effects that the actuator supports.

Value

An array representing the supported haptic effects. Possible included values are:

"dual-rumble"

A positional rumbling effect created by dual vibration motors in each handle of a controller, which can be vibrated independently.

"trigger-rumble"

Localized rumbling effects on the surface of a controller's trigger buttons created by vibrational motors located in each button. These buttons most commonly take the form of spring-loaded triggers.

Note: If an effect is not listed that is known to be supported by the hardware, it may be that the browser does not support playing effects of that type.

Examples

js
const gamepad = navigator.getGamepads()[0];
// Logs "dual-rumble" or "trigger-rumble"
console.log(gamepad.hapticActuators[0].effects[0]);

Specifications

Specification
Gamepad
# dom-gamepadhapticactuator-effects

Browser compatibility

See also