Difference between revisions of "Contact:getSeparation"
m (1 revision: Importing from potato (again).) |
(add detail) |
||
| Line 1: | Line 1: | ||
| + | == Function == | ||
| + | Get the separation between two shapes that are in contact. | ||
| − | + | The return value of this function is always zero or negative, with a negative value indicating overlap between the two shapes. | |
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| − | Contact:getSeparation( ) | + | distance = Contact:getSeparation( ) |
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
None. | None. | ||
=== Returns === | === Returns === | ||
| − | + | {{param|number|distance|The separation between the two shapes.}} | |
== See Also == | == See Also == | ||
* [[parent::Contact]] | * [[parent::Contact]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
| − | {{#set:Description=}} | + | {{#set:Description=Get the separation between two shapes that are in contact.}} |
Revision as of 17:58, 6 March 2010
Function
Get the separation between two shapes that are in contact.
The return value of this function is always zero or negative, with a negative value indicating overlap between the two shapes.
Synopsis
distance = Contact:getSeparation( )
Arguments
None.
Returns
number distance- The separation between the two shapes.
