Browse Source

Merge pull request #3741 from JoshuaGrams/master

doc: explain DampedSpringJoint2D parameters.
Rémi Verschelde 9 years ago
parent
commit
39f69cbfc3
1 changed files with 5 additions and 5 deletions
  1. 5 5
      doc/base/classes.xml

+ 5 - 5
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.
 	Damped spring constraint for 2D physics.
 	</brief_description>
 	</brief_description>
 	<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>
 	</description>
 	<methods>
 	<methods>
 		<method name="set_length">
 		<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 index="0" name="stiffness" type="float">
 			</argument>
 			</argument>
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="get_stiffness" qualifiers="const">
 		<method name="get_stiffness" qualifiers="const">
 			<return type="float">
 			<return type="float">
 			</return>
 			</return>
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="set_damping">
 		<method name="set_damping">
 			<argument index="0" name="damping" type="float">
 			<argument index="0" name="damping" type="float">
 			</argument>
 			</argument>
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="get_damping" qualifiers="const">
 		<method name="get_damping" qualifiers="const">
 			<return type="float">
 			<return type="float">
 			</return>
 			</return>
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 	</methods>
 	</methods>