From 073c49027136a04b87fdde46aae7c8bfef1ab88e Mon Sep 17 00:00:00 2001 From: bjorn Date: Sat, 25 Nov 2017 03:39:35 -0800 Subject: [PATCH] Document Controller:vibrate power argument; --- docs/Controller:vibrate.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/Controller:vibrate.md b/docs/Controller:vibrate.md index c5aaf05..de01fa2 100644 --- a/docs/Controller:vibrate.md +++ b/docs/Controller:vibrate.md @@ -7,11 +7,12 @@ Controller:vibrate Causes the Controller to vibrate. - controller:vibrate(duration) + controller:vibrate(duration, power) ### Arguments - `number duration` The amount of time to vibrate the Controller, in seconds. +- `number power (1)` The strength of the vibration, between 0 and 1. ### Returns @@ -20,5 +21,6 @@ Nothing Notes --- -On the HTC Vive, the value for `duration` currently must be less than .004 seconds. Call this -function several frames in a row for stronger or prolonged vibration patterns. +On the HTC Vive, the value for `duration` currently must be less than .004 seconds, and the `power` +is always set to 1.0. Call this function several frames in a row over several frames for stronger +or prolonged vibration patterns.