Difference between revisions of "Contact:getSeparation"

(add detail)
m (included link to other languages)
Line 1: Line 1:
 
== Function ==
 
 
Get the separation between two shapes that are in contact.
 
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.
 
The return value of this function is always zero or negative, with a negative value indicating overlap between the two shapes.
 +
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 16: Line 15:
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Get the separation between two shapes that are in contact.}}
 
{{#set:Description=Get the separation between two shapes that are in contact.}}
 +
== Other Languages ==
 +
{{i18n|Contact:getSeparation}}

Revision as of 20:14, 22 January 2011

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.

Function

Synopsis

distance = Contact:getSeparation( )

Arguments

None.

Returns

number distance
The separation between the two shapes.

See Also

Other Languages