Skip to content

Commit cef70a5

Browse files
committed
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.
1 parent 4613cb7 commit cef70a5

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/base/classes.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -16640,7 +16640,8 @@
1664016640
<argument index="3" name="duration" type="float" default="0">
1664116641
</argument>
1664216642
<description>
16643-
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).
16643+
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).
16644+
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.
1664416645
</description>
1664516646
</method>
1664616647
<method name="stop_joy_vibration">

0 commit comments

Comments
 (0)