Difference between revisions of "Contact:getSeparation"

m
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
{{oldin|[[0.8.0]]|080|type=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.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Contact:getSeparation( )
+
distance = Contact:getSeparation( )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
Nothing.
+
{{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.}}
 +
{{#set:Since=000}}
 +
== Other Languages ==
 +
{{i18n|Contact:getSeparation}}

Latest revision as of 21:12, 29 May 2013

Removed in LÖVE 0.8.0
This function is not supported in that and later versions.

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