Added documentation for some RigidBody methods, and copied the descriptions to matching PhysicsDirectBodyState methods.

(cherry picked from commit 74aa104607)
This commit is contained in:
Tiger C 2018-08-29 18:44:24 -04:00 committed by Rémi Verschelde
parent fdc2bb1952
commit 6faa928979
1 changed files with 3 additions and 0 deletions

View File

@ -17,6 +17,7 @@
<argument index="1" name="position" type="Vector3"> <argument index="1" name="position" type="Vector3">
</argument> </argument>
<description> <description>
Adds a constant force (i.e. acceleration).
</description> </description>
</method> </method>
<method name="apply_impulse"> <method name="apply_impulse">
@ -27,6 +28,7 @@
<argument index="1" name="j" type="Vector3"> <argument index="1" name="j" type="Vector3">
</argument> </argument>
<description> <description>
Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the position are in global coordinates, and the position is relative to the object's origin.
</description> </description>
</method> </method>
<method name="apply_torqe_impulse"> <method name="apply_torqe_impulse">
@ -44,6 +46,7 @@
<argument index="0" name="j" type="Vector3"> <argument index="0" name="j" type="Vector3">
</argument> </argument>
<description> <description>
Apply a torque impulse (which will be affected by the body mass and shape). This will rotate the body around the passed in vector.
</description> </description>
</method> </method>
<method name="get_contact_collider" qualifiers="const"> <method name="get_contact_collider" qualifiers="const">