diff options
Diffstat (limited to 'doc/classes/RigidBody.xml')
| -rw-r--r-- | doc/classes/RigidBody.xml | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index 038464e127..f9e0f821a9 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"> @@ -82,7 +88,7 @@ <return type="Array"> </return> <description> - Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see [method set_max_contacts_reported] to increase it. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. + Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see [method set_max_contacts_reported] to increase it. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. </description> </method> <method name="set_axis_velocity"> @@ -162,14 +168,14 @@ </members> <signals> <signal name="body_entered"> - <argument index="0" name="body" type="Object"> + <argument index="0" name="body" type="Node"> </argument> <description> Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. </description> </signal> <signal name="body_exited"> - <argument index="0" name="body" type="Object"> + <argument index="0" name="body" type="Node"> </argument> <description> Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. @@ -178,7 +184,7 @@ <signal name="body_shape_entered"> <argument index="0" name="body_id" type="int"> </argument> - <argument index="1" name="body" type="Object"> + <argument index="1" name="body" type="Node"> </argument> <argument index="2" name="body_shape" type="int"> </argument> @@ -192,7 +198,7 @@ <signal name="body_shape_exited"> <argument index="0" name="body_id" type="int"> </argument> - <argument index="1" name="body" type="Object"> + <argument index="1" name="body" type="Node"> </argument> <argument index="2" name="body_shape" type="int"> </argument> |