GamepadHapticActuator: reset() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
The reset()
method of the GamepadHapticActuator
interface stops the hardware from playing an active vibration effect.
Syntax
js
reset()
Parameters
None.
Return value
A promise that resolves with "complete"
if the effect is successfully reset, or "preempted"
if the effect was stopped or replaced by another effect.
The promise may reject with the following exception types:
InvalidStateError
DOMException
-
Promise rejects with
InvalidStateError
if the current document is not active or hidden.
Examples
js
const gamepad = navigator.getGamepads()[0];
setTimeout(() => {
gamepad.vibrationActuator.reset();
}, 150);
gamepad.vibrationActuator
.playEffect("dual-rumble", {
startDelay: 0,
duration: 200,
weakMagnitude: 1.0,
strongMagnitude: 1.0,
})
.then((result) => console.log(result));
// Should log "preempted" because reset() will run before the effect ends
Specifications
Specification |
---|
Gamepad # dom-gamepadhapticactuator-reset |
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
reset |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.