Difference between revisions of "Fixture:setFilterData"

m (typo)
(Specify values of default filter)
Line 7: Line 7:
  
 
There can be up to 16 categories. Categories and masks are encoded as the bits of a 16-bit integer.
 
There can be up to 16 categories. Categories and masks are encoded as the bits of a 16-bit integer.
 +
 +
When created, prior to calling this function, all fixtures have category set to 1, mask set to 65535 (all categories) and group set to 0.
  
 
== Function ==
 
== Function ==

Revision as of 13:34, 24 June 2018

Available since LÖVE 0.8.0
This method is not supported in earlier versions.

Sets the filter data of the fixture.

Groups, categories, and mask can be used to define the collision behaviour of the fixture.

If two fixtures are in the same group they either always collide if the group is positive, or never collide if it's negative. If the group is zero or they do not match, then the contact filter checks if the fixtures select a category of the other fixture with their masks. The fixtures do not collide if that's not the case. If they do have each other's categories selected, the return value of the custom contact filter will be used. They always collide if none was set.

There can be up to 16 categories. Categories and masks are encoded as the bits of a 16-bit integer.

When created, prior to calling this function, all fixtures have category set to 1, mask set to 65535 (all categories) and group set to 0.

Function

Synopsis

Fixture:setFilterData( categories, mask, group )

Arguments

number categories
The categories as an integer from 0 to 65535.
number mask
The mask as an integer from 0 to 65535.
number group
The group as an integer from -32768 to 32767.

Returns

Nothing.

See Also


Other Languages