summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRémi Verschelde <remi@verschelde.fr>2016-02-17 16:31:30 +0100
committerRémi Verschelde <remi@verschelde.fr>2016-02-17 16:31:30 +0100
commit39f69cbfc33255edc3067372fa31fb2e8fa6f356 (patch)
tree804859802c1ba4531d2c4cf4992833068552dfdb
parent55008bba77f2b3d23fb36932b7f8debfe0c0904d (diff)
parenta0cffd625bb7c1de99696a58426a6f441438eeb7 (diff)
Merge pull request #3741 from JoshuaGrams/master
doc: explain DampedSpringJoint2D parameters.
-rw-r--r--doc/base/classes.xml10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index a11297789c..1dff307959 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -9412,7 +9412,7 @@ This approximation makes straight segments between each point, then subdivides t
Damped spring constraint for 2D physics.
</brief_description>
<description>
- Damped spring constraint for 2D physics. This resembles a spring joint that always want to go back to a given length.
+ Damped spring constraint for 2D physics. This resembles a spring joint that always wants to go back to a given length.
</description>
<methods>
<method name="set_length">
@@ -9447,28 +9447,28 @@ This approximation makes straight segments between each point, then subdivides t
<argument index="0" name="stiffness" type="float">
</argument>
<description>
- Set the stiffness of the spring joint.
+ Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
</description>
</method>
<method name="get_stiffness" qualifiers="const">
<return type="float">
</return>
<description>
- Return the stiffness of the spring joint.
+ Return the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
</description>
</method>
<method name="set_damping">
<argument index="0" name="damping" type="float">
</argument>
<description>
- Set the damping of the spring joint.
+ Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
</description>
</method>
<method name="get_damping" qualifiers="const">
<return type="float">
</return>
<description>
- Return the damping of the spring joint.
+ Return the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
</description>
</method>
</methods>