diff options
| author | Andreas Haas <liu.gam3@gmail.com> | 2016-09-16 11:08:32 +0200 |
|---|---|---|
| committer | Andreas Haas <liu.gam3@gmail.com> | 2016-09-16 11:08:32 +0200 |
| commit | cef70a5f8b87caa00723cfb600c4ccd83305a322 (patch) | |
| tree | 416b8b6ae1449c1b9aae37d0a0451570c7311709 /doc/base | |
| parent | 4613cb7874a7a6beb3195bebf06d7ecfbd2454c3 (diff) | |
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.
Diffstat (limited to 'doc/base')
| -rw-r--r-- | doc/base/classes.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 916ca09c92..6865bb1378 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -16640,7 +16640,8 @@ <argument index="3" name="duration" type="float" default="0"> </argument> <description> - 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. </description> </method> <method name="stop_joy_vibration"> |