Difference between revisions of "Contact:getFriction"

m (1 revision: Importing from potato (again).)
(describe return value)
Line 1: Line 1:
 
  
 
== Function ==
 
== Function ==
 +
Get the friction between two shapes that are in contact.
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Contact:getFriction( )
+
friction = Contact:getFriction( )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
Nothing.
+
{{param|number|friction|The friction of the contact.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::Contact]]
 
* [[parent::Contact]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Get the friction between two shapes that are in contact.}}

Revision as of 17:50, 6 March 2010

Function

Get the friction between two shapes that are in contact.

Synopsis

friction = Contact:getFriction( )

Arguments

None.

Returns

number friction
The friction of the contact.

See Also