diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-03-16 23:21:55 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-16 23:21:55 +0100 |
| commit | fbba496db5bf904d54993145f5bb52a1709f7364 (patch) | |
| tree | 179ab337bae476c9edd7e32427d265c98f4c3828 | |
| parent | bc7e105821cc1a7b1173bc997aa61b3f5b58430a (diff) | |
| parent | d1798b235cbfc9036b3e47f19187c70225defa2a (diff) | |
Merge pull request #47070 from mbrlabs/docs-sensor-units
Document different unit of measurements for sensor data on iOS and Android
| -rw-r--r-- | doc/classes/Input.xml | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 1f872db6c6..50a675e8db 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -51,7 +51,7 @@ <description> Returns the acceleration of the device's accelerometer sensor, 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]. + [b]Note:[/b] This method only works on iOS, Android, and UWP. On other platforms, it always returns [constant Vector3.ZERO]. On Android the unit of measurement for each axis is m/s² while on iOS and UWP it's a multiple of the Earth's gravitational acceleration [code]g[/code] (~9.81 m/s²). </description> </method> <method name="get_action_raw_strength" qualifiers="const"> @@ -107,7 +107,7 @@ </return> <description> Returns the gravity of the device's accelerometer sensor, 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]. + [b]Note:[/b] This method only works on Android and iOS. On other platforms, it always returns [constant Vector3.ZERO]. On Android the unit of measurement for each axis is m/s² while on iOS it's a multiple of the Earth's gravitational acceleration [code]g[/code] (~9.81 m/s²). </description> </method> <method name="get_gyroscope" qualifiers="const"> |