aboutsummaryrefslogtreecommitdiff
path: root/doc/classes/DampedSpringJoint2D.xml
diff options
context:
space:
mode:
authorGrosskopf2017-10-16 14:11:43 +0200
committerGrosskopf2017-10-21 17:55:45 +0200
commit7a6246a0bd79b4961fc51680898e118c498618af (patch)
tree6f609f383000e1442f4cc882679c95263cd90e4f /doc/classes/DampedSpringJoint2D.xml
parent8de1dc7e9a1d137d9904122e775c270b03f4e049 (diff)
downloadgodot-7a6246a0bd79b4961fc51680898e118c498618af.tar.gz
godot-7a6246a0bd79b4961fc51680898e118c498618af.tar.zst
godot-7a6246a0bd79b4961fc51680898e118c498618af.zip
Added the 2D Joint docs
Diffstat (limited to 'doc/classes/DampedSpringJoint2D.xml')
-rw-r--r--doc/classes/DampedSpringJoint2D.xml4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/classes/DampedSpringJoint2D.xml b/doc/classes/DampedSpringJoint2D.xml
index 18554820f..36c556451 100644
--- a/doc/classes/DampedSpringJoint2D.xml
+++ b/doc/classes/DampedSpringJoint2D.xml
@@ -78,12 +78,16 @@
</methods>
<members>
<member name="damping" type="float" setter="set_damping" getter="get_damping">
+ The spring joint's damping ratio. A value between [code]0[/code] and [code]1[/code]. When the two bodies move into different directions the system tries to align them to the spring axis again. A high [code]damping[/code] value forces the attached bodies to align faster. Default value: [code]1[/code]
</member>
<member name="length" type="float" setter="set_length" getter="get_length">
+ The spring joint's maximum length. The two attached bodies cannot stretch it past this value. Default value: [code]50[/code]
</member>
<member name="rest_length" type="float" setter="set_rest_length" getter="get_rest_length">
+ When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length. Default value: [code]0[/code]
</member>
<member name="stiffness" type="float" setter="set_stiffness" getter="get_stiffness">
+ The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length. Default value: [code]20[/code]
</member>
</members>
<constants>