summaryrefslogtreecommitdiff
path: root/doc/classes/VehicleWheel3D.xml
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2020-07-14 16:16:08 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2020-07-14 16:16:08 +0200
commit0493e7c106811e94ad8dbebb0b97c43b19e4023a (patch)
tree70e44e49536f268337e396c0bb39c58b050ba066 /doc/classes/VehicleWheel3D.xml
parent2921827387b339fef98cb761f9571dd0f1dd1986 (diff)
Document VehicleBody3D and VehicleWheel3D limitations
These classes have dozens of open bugs and missing features which may not be fixed anytime soon. It's probably better to document it upfront at this point.
Diffstat (limited to 'doc/classes/VehicleWheel3D.xml')
-rw-r--r--doc/classes/VehicleWheel3D.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/VehicleWheel3D.xml b/doc/classes/VehicleWheel3D.xml
index c71d797eff..97b2abfa92 100644
--- a/doc/classes/VehicleWheel3D.xml
+++ b/doc/classes/VehicleWheel3D.xml
@@ -5,6 +5,7 @@
</brief_description>
<description>
This node needs to be used as a child node of [VehicleBody3D] and simulates the behavior of one of its wheels. This node also acts as a collider to detect if the wheel is touching a surface.
+ [b]Note:[/b] This class has known issues and isn't designed to provide realistic 3D vehicle physics. If you want advanced vehicle physics, you will probably have to write your own physics integration using another [PhysicsBody3D] class.
</description>
<tutorials>
</tutorials>