Add mobile sensors tutorial (WIP)#12089
Draft
Nintorch wants to merge 1 commit into
Draft
Conversation
Nintorch
added
area:manual
Cykyrios
reviewed
Jun 23, 2026
Cykyrios
left a comment
Cykyrios
left a comment
Contributor
There was a problem hiding this comment.
Just a few formatting remarks and a pitch/roll inversion.
The last code example mentions detecting opposite "movement", when in reality the sequence of events is acceleration in one direction -> maybe no acceleration for a short while -> acceleration ~opposite to initial acceleration -> device comes to a stop. The device has technically been moving in a single direction the entire time, but I understand you mean to say the reported value shows the deceleration as that "opposite movement".
Comment on lines
+27
to
+29
| - the X value of the gyroscope data shows the rotation around the X axis (roll). | ||
| - the Y value of the gyroscope data shows the rotation around the Y axis (yaw). | ||
| - the Z value of the gyroscope data shows the rotation around the Z axis (pitch). |
Contributor
There was a problem hiding this comment.
Suggested change
| - the X value of the gyroscope data shows the rotation around the X axis (roll). | |
| - the Y value of the gyroscope data shows the rotation around the Y axis (yaw). | |
| - the Z value of the gyroscope data shows the rotation around the Z axis (pitch). | |
| - the X value of the gyroscope data shows the rotation around the X axis (pitch). | |
| - the Y value of the gyroscope data shows the rotation around the Y axis (yaw). | |
| - the Z value of the gyroscope data shows the rotation around the Z axis (roll). |
Comment on lines
+60
to
+61
| .. note:: | ||
| For Android, |
Contributor
There was a problem hiding this comment.
Suggested change
| .. note:: | |
| For Android, | |
| .. note:: | |
| On Android, |
| .. warning:: | ||
|
|
||
| Do not use accelerometer data to find the controller's position in 3D space; | ||
| the accelerometers in general are not precise enough for this. |
Contributor
There was a problem hiding this comment.
Suggested change
| the accelerometers in general are not precise enough for this. | |
| accelerometers in general are not precise enough for this. |
Comment on lines
+91
to
+92
| .. note:: | ||
| For Android, |
Contributor
There was a problem hiding this comment.
Suggested change
| .. note:: | |
| For Android, | |
| .. note:: | |
| On Android, |
Calinou
reviewed
Jun 24, 2026
Comment on lines
+11
to
+15
| .. note:: | ||
|
|
||
| Controller motion sensors usage is explained in detail | ||
| on the :ref:`doc_controller_features_motion_sensors` page. | ||
| This page describes how to use the sensors found in mobile phones on Android and iOS. |
Member
There was a problem hiding this comment.
There should be a similar note on the Controller motion sensors section of that page, pointing to this page.
Comment on lines
+148
to
+149
| Magnetometer | ||
| ~~~~~~~~~~~~~ |
Member
There was a problem hiding this comment.
Suggested change
| Magnetometer | |
| ~~~~~~~~~~~~~ | |
| Magnetometer | |
| ~~~~~~~~~~~~ |
| With motion controls, games can track the device's physical rotation and movement. | ||
| This can be used to let the player turn the in-game camera by moving their device, or shaking their device to perform a special action. | ||
|
|
||
| The device in this case can be either a mobile phone or a controller. |
Member
There was a problem hiding this comment.
This seems to imply this applies to controllers, but below it says phones only?
| ~~~~~~~~~~~~~~~~ | ||
|
|
||
| Mobile sensor input methods, such as :ref:`Input.get_gyroscope()<class_Input_method_get_gyroscope>`, | ||
| return :ref:`Vector3<class_Vector3>`, which corresponds to X, Y, and Z axes of the reported data, |
Member
There was a problem hiding this comment.
Suggested change
| return :ref:`Vector3<class_Vector3>`, which corresponds to X, Y, and Z axes of the reported data, | |
| return :ref:`Vector3<class_Vector3>`, which corresponds to the X, Y, and Z axes of the reported data, |
| For Android, | ||
| :ref:`input_devices/sensors/enable_accelerometer<class_ProjectSettings_property_input_devices/sensors/enable_accelerometer>` | ||
| and :ref:`input_devices/sensors/enable_gravity<class_ProjectSettings_property_input_devices/sensors/enable_gravity>` | ||
| must be enabled for the accelerometer and the gravity sensors respectively to start reporting values. |
Member
There was a problem hiding this comment.
Suggested change
| must be enabled for the accelerometer and the gravity sensors respectively to start reporting values. | |
| must be enabled for the accelerometer and gravity sensors respectively to start reporting values. |
|
|
||
| The following example rotates an object using the mobile device's gyroscope sensor. | ||
|
|
||
| .. code-block:: |
Member
There was a problem hiding this comment.
Suggested change
| .. code-block:: | |
| .. code-block:: gdscript |
For all
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a mobile sensors tutorial. The mobile sensors include motion sensors (accelerometer and gyroscope), as well as the magnetometer sensor.
I'm creating this PR now so I won't forget about it in the future :D