Difference between revisions of "PulleyJoint:setConstant"

m (1 revision: Importing from potato (again).)
(add detail)
Line 1: Line 1:
 +
== Function ==
 +
Set the total length of the rope.
  
 
+
Setting a new length for the rope updates the maximum length values of the joint.
== Function ==
 
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
PulleyJoint:setConstant( )
+
PulleyJoint:setConstant( length )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
None.
+
{{param|number|length|The new length of the rope in the joint.}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 
== See Also ==
 
== See Also ==
 
* [[parent::PulleyJoint]]
 
* [[parent::PulleyJoint]]
 +
* [[PulleyJoint:getMaxLengths]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Set the total length of the rope.}}

Revision as of 18:17, 6 March 2010

Function

Set the total length of the rope.

Setting a new length for the rope updates the maximum length values of the joint.

Synopsis

PulleyJoint:setConstant( length )

Arguments

number length
The new length of the rope in the joint.

Returns

Nothing.

See Also