summaryrefslogtreecommitdiff
path: root/doc/classes/RigidBody.xml
diff options
context:
space:
mode:
authorTiger C <tiger@caldwellfive.com>2018-08-29 18:44:24 -0400
committerTiger C <tiger@caldwellfive.com>2018-08-29 18:44:24 -0400
commit74aa104607ee48f07e21c20dd073c7d117b16886 (patch)
tree166ee09db9a5bee01fed532390c07ca00579ebca /doc/classes/RigidBody.xml
parent7b7f4b20cb6070b632824915033fca0d181b4c7f (diff)
Added documentation for some RigidBody methods, and copied the descriptions to matching PhysicsDirectBodyState methods.
Diffstat (limited to 'doc/classes/RigidBody.xml')
-rw-r--r--doc/classes/RigidBody.xml6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml
index 038464e127..4ae1ef8e94 100644
--- a/doc/classes/RigidBody.xml
+++ b/doc/classes/RigidBody.xml
@@ -30,6 +30,8 @@
<argument index="0" name="force" type="Vector3">
</argument>
<description>
+ Adds a constant directional force without affecting rotation.
+ This is equivalent to [code]add_force(force, Vector3(0,0,0))[/code].
</description>
</method>
<method name="add_force">
@@ -40,6 +42,7 @@
<argument index="1" name="position" type="Vector3">
</argument>
<description>
+ Adds a constant force (i.e. acceleration).
</description>
</method>
<method name="add_torque">
@@ -48,6 +51,7 @@
<argument index="0" name="torque" type="Vector3">
</argument>
<description>
+ Adds a constant rotational force (i.e. a motor) without affecting position.
</description>
</method>
<method name="apply_central_impulse">
@@ -56,6 +60,8 @@
<argument index="0" name="impulse" type="Vector3">
</argument>
<description>
+ Applies a single directional impulse without affecting rotation.
+ This is equivalent to ``apply_impulse(Vector3(0,0,0), impulse)``.
</description>
</method>
<method name="apply_impulse">