GamepadHapticActuator
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The GamepadHapticActuator
interface of the Gamepad API represents hardware in the controller designed to provide haptic feedback to the user (if available), most commonly vibration hardware.
This interface is accessible through the Gamepad.hapticActuators
property.
Instance properties
GamepadHapticActuator.effects
Read only Experimental-
Returns an array of enumerated values representing the different haptic effects that the actuator supports.
GamepadHapticActuator.type
Deprecated Read only Non-standard-
Returns an enumerated value representing the type of the haptic hardware. This property is deprecated: use
GamepadHapticActuator.effects
to detect effect support.
Instance methods
GamepadHapticActuator.playEffect()
Read only-
Causes the hardware to play a specific vibration effect.
GamepadHapticActuator.pulse()
Read only-
Makes the hardware pulse at a certain intensity for a specified duration.
GamepadHapticActuator.reset()
Read only-
Stops the hardware from playing an active vibration effect.
Examples
const gamepad = navigator.getGamepads()[0];
gamepad.hapticActuators[0].pulse(1.0, 200);
gamepad.vibrationActuator.playEffect("dual-rumble", {
startDelay: 0,
duration: 200,
weakMagnitude: 1.0,
strongMagnitude: 1.0,
});
Specifications
Specification |
---|
Gamepad # gamepadhapticactuator-interface |
Browser compatibility
BCD tables only load in the browser