diff options
| author | James Westman <flyingpimonster@gmail.com> | 2019-12-05 15:58:58 -0600 |
|---|---|---|
| committer | James Westman <flyingpimonster@gmail.com> | 2019-12-05 18:10:11 -0600 |
| commit | 5978e6afacdaefbfef1785475be1a83bfb7935ab (patch) | |
| tree | 1c247d1bbf940b81eac6b834451f4228175e80ce /doc/classes/ARVRController.xml | |
| parent | 1b40a95b6f34d4024c732ef68b3ba96e4bd6e6f1 (diff) | |
Docs: ARVRController and ARVRInterface
This commit clarifies a few methods and members in the AR/VR docs. It
also updates some wording according to the style guide and fixes a
couple typos.
Diffstat (limited to 'doc/classes/ARVRController.xml')
| -rw-r--r-- | doc/classes/ARVRController.xml | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/classes/ARVRController.xml b/doc/classes/ARVRController.xml index 9c6cfc1d7d..24d8b48077 100644 --- a/doc/classes/ARVRController.xml +++ b/doc/classes/ARVRController.xml @@ -22,7 +22,7 @@ <return type="int" enum="ARVRPositionalTracker.TrackerHand"> </return> <description> - Returns the hand holding this controller, if known. See [code]TRACKER_*[/code] constants in [ARVRPositionalTracker]. + Returns the hand holding this controller, if known. See [enum ARVRPositionalTracker.TrackerHand]. </description> </method> <method name="get_is_active" qualifiers="const"> @@ -61,7 +61,7 @@ <argument index="0" name="button" type="int"> </argument> <description> - Returns [code]true[/code] if the button at index [code]button[/code] is pressed. + Returns [code]true[/code] if the button at index [code]button[/code] is pressed. See [enum JoystickList], in particular the [code]JOY_VR_*[/code] constants. </description> </method> </methods> @@ -73,7 +73,8 @@ When a controller is turned off, its slot is freed. This ensures controllers will keep the same ID even when controllers with lower IDs are turned off. </member> <member name="rumble" type="float" setter="set_rumble" getter="get_rumble" default="0.0"> - The degree to which the tracker rumbles. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code]. If changed, updates [member ARVRPositionalTracker.rumble] accordingly. + The degree to which the controller vibrates. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code]. If changed, updates [member ARVRPositionalTracker.rumble] accordingly. + This is a useful property to animate if you want the controller to vibrate for a limited duration. </member> </members> <signals> |