diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2020-07-14 16:16:08 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2020-07-14 16:16:08 +0200 |
| commit | 0493e7c106811e94ad8dbebb0b97c43b19e4023a (patch) | |
| tree | 70e44e49536f268337e396c0bb39c58b050ba066 /doc/classes | |
| parent | 2921827387b339fef98cb761f9571dd0f1dd1986 (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')
| -rw-r--r-- | doc/classes/VehicleBody3D.xml | 1 | ||||
| -rw-r--r-- | doc/classes/VehicleWheel3D.xml | 1 |
2 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/VehicleBody3D.xml b/doc/classes/VehicleBody3D.xml index b8b85ff605..5a2cce376e 100644 --- a/doc/classes/VehicleBody3D.xml +++ b/doc/classes/VehicleBody3D.xml @@ -6,6 +6,7 @@ <description> This node implements all the physics logic needed to simulate a car. It is based on the raycast vehicle system commonly found in physics engines. You will need to add a [CollisionShape3D] for the main body of your vehicle and add [VehicleWheel3D] nodes for the wheels. You should also add a [MeshInstance3D] to this node for the 3D model of your car but this model should not include meshes for the wheels. You should control the vehicle by using the [member brake], [member engine_force], and [member steering] properties and not change the position or orientation of this node directly. [b]Note:[/b] The origin point of your VehicleBody3D will determine the center of gravity of your vehicle so it is better to keep this low and move the [CollisionShape3D] and [MeshInstance3D] upwards. + [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> 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> |