Browse Source

Merge pull request #6510 from Hinsbart/doc_vib

Update documentation on joystick vibration.

[ci skip]
Rémi Verschelde 9 years ago
parent
commit
c05ff0577f
1 changed files with 2 additions and 1 deletions
  1. 2 1
      doc/base/classes.xml

+ 2 - 1
doc/base/classes.xml

@@ -16640,7 +16640,8 @@
 			<argument index="3" name="duration" type="float" default="0">
 			<argument index="3" name="duration" type="float" default="0">
 			</argument>
 			</argument>
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="stop_joy_vibration">
 		<method name="stop_joy_vibration">