Difference between revisions of "PulleyJoint:getRatio"

m (1 revision: Importing from potato (again).)
(add detail)
Line 1: Line 1:
 
  
 
== Function ==
 
== Function ==
 +
Get the pulley ratio.
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
PulleyJoint:getRatio( )
+
ratio = PulleyJoint:getRatio( )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
Nothing.
+
{{param|number|ratio|The pulley ratio of the joint.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::PulleyJoint]]
 
* [[parent::PulleyJoint]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Get the pulley ratio.}}

Revision as of 18:13, 6 March 2010

Function

Get the pulley ratio.

Synopsis

ratio = PulleyJoint:getRatio( )

Arguments

None.

Returns

number ratio
The pulley ratio of the joint.

See Also