diff options
| author | Andreas Haas | 2016-09-16 11:08:32 +0200 |
|---|---|---|
| committer | Rémi Verschelde | 2016-09-18 23:22:14 +0200 |
| commit | 521b5bd90f5cbe5f069c6835be2438d91e530c1a (patch) | |
| tree | d61c43c8e9a0797004226a3b6e42d580bc11a4e2 | |
| parent | 8dca3f3f42540cf801379e76abc48c8cf4476aa0 (diff) | |
| download | godot-521b5bd90f5cbe5f069c6835be2438d91e530c1a.tar.gz godot-521b5bd90f5cbe5f069c6835be2438d91e530c1a.tar.zst godot-521b5bd90f5cbe5f069c6835be2438d91e530c1a.zip | |
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)
| -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 b4d01120d..7790ae555 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -16131,7 +16131,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"> |