Gamepad trigger-rumble and associated updates #34442
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| --- | ||
| title: "GamepadHapticActuator: effects property" | ||
| short-title: effects | ||
| slug: Web/API/GamepadHapticActuator/effects | ||
| page-type: web-api-instance-property | ||
| browser-compat: api.GamepadHapticActuator.effects | ||
| --- | ||
|
|
||
| {{APIRef("Gamepad API")}} | ||
|
|
||
| The **`effects`** read-only property of the {{domxref("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 | ||
|
|
||
| {{Specifications}} | ||
|
|
||
| ## Browser compatibility | ||
|
|
||
| {{Compat}} | ||
|
|
||
| ## See also | ||
|
|
||
| - [Gamepad API](/en-US/docs/Web/API/Gamepad_API) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| --- | ||
| title: "GamepadHapticActuator: reset() method" | ||
| short-title: reset() | ||
| slug: Web/API/GamepadHapticActuator/reset | ||
| page-type: web-api-instance-method | ||
| browser-compat: api.GamepadHapticActuator.reset | ||
| --- | ||
|
|
||
| {{APIRef("Gamepad API")}} | ||
|
|
||
| The **`reset()`** method of the {{domxref("GamepadHapticActuator")}} interface stops the hardware from playing an active vibration effect. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ```js-nolint | ||
| 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. | ||
|
|
||
| ## Examples | ||
|
|
||
| ```js | ||
| const gamepad = navigator.getGamepads()[0]; | ||
|
|
||
| gamepad.vibrationActuator.playEffect("dual-rumble", { | ||
| startDelay: 0, | ||
| duration: 200, | ||
| weakMagnitude: 1.0, | ||
| strongMagnitude: 1.0, | ||
| }); | ||
|
|
||
| gamepad.vibrationActuator.reset(); | ||
|
There was a problem hiding this comment. Not sure if you want to There was a problem hiding this comment. Thanks @tomayac! I wasn't 100% sure what you meant, but I've tried to update both pages as suggested. Let me know what you think! There was a problem hiding this comment. In the There was a problem hiding this comment. I've swapped the order as you suggested, and converted both examples to use |
||
| ``` | ||
|
|
||
| ## Specifications | ||
|
|
||
| {{Specifications}} | ||
|
|
||
| ## Browser compatibility | ||
|
|
||
| {{Compat}} | ||
|
|
||
| ## See also | ||
|
|
||
| - [Gamepad API](/en-US/docs/Web/API/Gamepad_API) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
highly subjective, but I think this is overly repetitive, and in this situation I just say:
I wish we had a consistent way to write default values for optional items.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, mine is wordier, but it is also a bit more intuitive. Saying that, I don't think it really adds much, so I've updated it to your suggestion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is, and if this were the only place we document a default I would prefer it. But there are (obviously) thousands of places we document defaults, and if every one says "If omitted,
thingdefaults tovalue" then it is very repetitive: "if omitted" essentially repeats the definition of "default" every time. IMO MDN really misses a structured consistent way to represent "default", that's not just in prose at all.