asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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

Browse source
This commit is contained in:
Tiger C 2018-08-29 18:44:24 -04:00
parent 7b7f4b20cb
commit 74aa104607
2 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/classes/PhysicsDirectBodyState.xml
View file

@ -15,6 +15,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">
@ -25,6 +27,7 @@
<argument index="1" name="position" type="Vector3">
</argument>
<description>
Adds a constant force (i.e. acceleration).
</description>
</method>
<method name="add_torque">
@ -33,6 +36,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">
@ -41,6 +45,8 @@
<argument index="0" name="j" 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">
@ -51,6 +57,7 @@
<argument index="1" name="j" type="Vector3">
</argument>
<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>
</method>
<method name="apply_torque_impulse">
@ -59,6 +66,7 @@
<argument index="0" name="j" type="Vector3">
</argument>
<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>
</method>
<method name="get_contact_collider" qualifiers="const">

6
doc/classes/RigidBody.xml
View file

@ -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">