diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-08-29 13:04:20 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-29 13:04:20 +0200 |
| commit | 6ae83b64ef29c9eaf853d0ed0e7dafca8e7ea580 (patch) | |
| tree | f7b5037a7fc5e199b63fc534e68e26a5b85ce022 /doc/classes | |
| parent | 7d6c5c90b54877bc668fc3af4cb7bc78eb219395 (diff) | |
| parent | eee704e6f602440be1e0007201a1eab534b0a9b1 (diff) | |
Merge pull request #41521 from Calinou/doc-accelerometer-platforms
Document supported platforms for `Input.get_accelerometer()` and related
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Input.xml | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index fbc9dfa564..a3079a12a9 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -47,8 +47,9 @@ <return type="Vector3"> </return> <description> - If the device has an accelerometer, this will return the acceleration. Otherwise, it returns an empty [Vector3]. + Returns the acceleration of the device's accelerometer, if the device has one. Otherwise, the method returns [constant Vector3.ZERO]. Note this method returns an empty [Vector3] when running from the editor even when your device has an accelerometer. You must export your project to a supported device to read values from the accelerometer. + [b]Note:[/b] This method only works on iOS, Android, and UWP. On other platforms, it always returns [constant Vector3.ZERO]. </description> </method> <method name="get_action_strength" qualifiers="const"> @@ -78,14 +79,16 @@ <return type="Vector3"> </return> <description> - If the device has an accelerometer, this will return the gravity. Otherwise, it returns an empty [Vector3]. + Returns the gravity of the device's accelerometer, if the device has one. Otherwise, the method returns [constant Vector3.ZERO]. + [b]Note:[/b] This method only works on Android and iOS. On other platforms, it always returns [constant Vector3.ZERO]. </description> </method> <method name="get_gyroscope" qualifiers="const"> <return type="Vector3"> </return> <description> - If the device has a gyroscope, this will return the rate of rotation in rad/s around a device's X, Y, and Z axes. Otherwise, it returns an empty [Vector3]. + Returns the rotation rate in rad/s around a device's X, Y, and Z axes of the gyroscope, if the device has one. Otherwise, the method returns [constant Vector3.ZERO]. + [b]Note:[/b] This method only works on Android. On other platforms, it always returns [constant Vector3.ZERO]. </description> </method> <method name="get_joy_axis" qualifiers="const"> @@ -182,7 +185,8 @@ <return type="Vector3"> </return> <description> - If the device has a magnetometer, this will return the magnetic field strength in micro-Tesla for all axes. + Returns the the magnetic field strength in micro-Tesla for all axes of the device's magnetometer, if the device has one. Otherwise, the method returns [constant Vector3.ZERO]. + [b]Note:[/b] This method only works on Android and UWP. On other platforms, it always returns [constant Vector3.ZERO]. </description> </method> <method name="get_mouse_button_mask" qualifiers="const"> |