summaryrefslogtreecommitdiff
path: root/doc/base/classes.xml
diff options
context:
space:
mode:
authorJosh Grams <josh@qualdan.com>2016-04-26 08:15:15 -0400
committerJosh Grams <josh@qualdan.com>2016-04-26 08:15:15 -0400
commita7b4127481d1f377a50ac5f62ec3f20e2ba71dff (patch)
tree011eb32b9e34b29d1a7c9011c33f501a51658302 /doc/base/classes.xml
parentffaced87a652109bf150f2680b666a8602d04103 (diff)
RigidBody2D (add_force, set_inertia): new methods.
Diffstat (limited to 'doc/base/classes.xml')
-rw-r--r--doc/base/classes.xml33
1 files changed, 30 insertions, 3 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 6aebbabea9..24ea481f02 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -24580,6 +24580,17 @@ This method controls whether the position between two cached points is interpola
<description>
</description>
</method>
+ <method name="body_add_force">
+ <argument index="0" name="body" type="RID">
+ </argument>
+ <argument index="1" name="offset" type="Vector2">
+ </argument>
+ <argument index="2" name="force" type="Vector2">
+ </argument>
+ <description>
+ Add a positioned force to the applied force and torque. As with [method body_apply_impulse], both the force and the offset from the body origin are in global coordinates.
+ </description>
+ </method>
<method name="body_set_axis_velocity">
<argument index="0" name="body" type="RID">
</argument>
@@ -30041,7 +30052,14 @@ This method controls whether the position between two cached points is interpola
<return type="float">
</return>
<description>
- Return the body's moment of inertia. This is automatically computed from the mass and the shapes, so you can't set it. But at least you can find out what it's current value is...
+ Return the body's moment of inertia. This is usually automatically computed from the mass and the shapes. Note that this doesn't seem to work in a [code]_ready[/code] function: it apparently has not been auto-computed yet.
+ </description>
+ </method>
+ <method name="set_inertia">
+ <argument index="0" name="inertia" type="float">
+ </argument>
+ <description>
+ Set the body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it.
</description>
</method>
<method name="set_weight">
@@ -30221,12 +30239,12 @@ This method controls whether the position between two cached points is interpola
</description>
</method>
<method name="apply_impulse">
- <argument index="0" name="pos" type="Vector2">
+ <argument index="0" name="offset" type="Vector2">
</argument>
<argument index="1" name="impulse" type="Vector2">
</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.
+ 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 offset from the body origin are in global coordinates.
</description>
</method>
<method name="set_applied_force">
@@ -30257,6 +30275,15 @@ This method controls whether the position between two cached points is interpola
Return the torque which is being applied to this body.
</description>
</method>
+ <method name="add_force">
+ <argument index="0" name="offset" type="Vector2">
+ </argument>
+ <argument index="1" name="force" type="Vector2">
+ </argument>
+ <description>
+ Add a positioned force to the applied force and torque. As with [method apply_impulse], both the force and the offset from the body origin are in global coordinates.
+ </description>
+ </method>
<method name="set_sleeping">
<argument index="0" name="sleeping" type="bool">
</argument>