lovr.headset.vibrate
Causes the device to vibrate with a custom strength, duration, and frequency, if possible.
vibrated = lovr.headset.vibrate(device, strength, duration, frequency)Arguments
| Name | Type | Default | Description |
| device | Device | 'head' | The device to vibrate. |
| strength | number | 1 | The strength of the vibration (amplitude), between 0 and 1. |
| duration | number | .5 | The duration of the vibration, in seconds. |
| frequency | number | 0 | The frequency of the vibration, in hertz. 0 will use a default frequency. |
Returns
| Name | Type | Description |
| vibrated | boolean | Whether the vibration was successfully triggered by an active headset driver. |
Notes
When using the openvr headset driver on an HTC Vive, the value for the duration currently must be less than .004 seconds. Call this function several frames in a row for stronger or prolonged vibration patterns.
On the Oculus Quest, devices can only be vibrated once per frame. Any attempts after the first will return false.
See also
lovr.headset