Difference between revisions of "Shape:getMask"

m (1 revision: Imported docs from potato.)
m
 
(8 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 +
{{oldin|[[0.8.0]]|080|type=function|text=Use [[Fixture:getMask]] instead}}
  
 
+
Gets which categories this shape should '''NOT''' collide with.
 +
The number of masked categories is the number of return values.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 9: Line 11:
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
{{param|numbers|...|Numbers from 1-16}}
+
{{param|number|...|Numbers from 1-16}}
 +
== Examples ==
 +
=== With how many categories does this shape collide? ===
 +
<source lang="lua">
 +
print('shape collides with', select('#', shape:getMask()), 'categories')
 +
</source>
 
== See Also ==
 
== See Also ==
 
* [[parent::Shape]]
 
* [[parent::Shape]]
 +
* [[Shape:setMask]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Gets which categories this shape should '''NOT''' collide with.}}
 +
{{#set:Since=000}}
 +
== Other Languages ==
 +
{{i18n|Shape:getMask}}

Latest revision as of 17:54, 29 May 2013

Removed in LÖVE 0.8.0
Use Fixture:getMask instead.


Gets which categories this shape should NOT collide with. The number of masked categories is the number of return values.

Function

Synopsis

... = Shape:getMask( )

Arguments

None.

Returns

number ...
Numbers from 1-16

Examples

With how many categories does this shape collide?

print('shape collides with', select('#', shape:getMask()), 'categories')

See Also


Other Languages