From 521b5bd90f5cbe5f069c6835be2438d91e530c1a Mon Sep 17 00:00:00 2001 From: Andreas Haas Date: Fri, 16 Sep 2016 11:08:32 +0200 Subject: [PATCH] Update documentation on joystick vibration. Added a note that long vibration durations are not recommended because of hardware limitations. For example, my ps4 controller can only vibrate for ~3s on linux. (cherry picked from commit cef70a5f8b87caa00723cfb600c4ccd83305a322) --- doc/base/classes.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index b4d01120d96..7790ae55531 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -16131,7 +16131,8 @@ - Starts to vibrate the joystick. Joysticks usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will play the vibration indefinitely). + Starts to vibrate the joystick. Joysticks usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). + Note that not every hardware is compatible with long effect durations, it is recommended to restart an effect if in need to play it for more than a few seconds.