Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Namespace: Collision
Phaser.Physics.Matter.Components.Collision

Methods

setCollisionCategory(value)
Focus
Focus

Description:

Sets the collision category of this Game Object's Matter Body. This number must be a power of two between 2^0 (= 1) and 2^31. Two bodies with different collision groups (see #setCollisionGroup) will only collide if their collision categories are included in their collision masks (see #setCollidesWith).

Parameters:

name type description
value number

Unique category bitfield.

Returns:
Description:

This Game Object.

Examples:
Focus
Focus
setCollisionGroup(value)
Focus
Focus

Description:

Sets the collision group of this Game Object's Matter Body. If this is zero or two Matter Bodies have different values, they will collide according to the usual rules (see #setCollisionCategory and #setCollisionGroup). If two Matter Bodies have the same positive value, they will always collide; if they have the same negative value, they will never collide.

Parameters:

name type description
value number

Unique group index.

Returns:
Description:

This Game Object.

Examples:
Focus
Focus
setCollidesWith(categories)
Focus
Focus

Description:

Sets the collision mask for this Game Object's Matter Body. Two Matter Bodies with different collision groups will only collide if each one includes the other's category in its mask based on a bitwise AND, i.e. (categoryA & maskB) !== 0 and (categoryB & maskA) !== 0 are both true.

Parameters:

name type description
categories number | Array.<number>

A unique category bitfield, or an array of them.

Returns:
Description:

This Game Object.

Examples:
Focus
Focus
setOnCollide(callback)
Focus
Focus

Description:

The callback is sent a Phaser.Types.Physics.Matter.MatterCollisionData object.

This does not change the bodies collision category, group or filter. Those must be set in addition to the callback.

Parameters:

name type description
callback function

The callback to invoke when this body starts colliding with another.

Returns:
Description:

This Game Object.

Examples:
Since: 3.22.0
Focus
Focus
setOnCollideEnd(callback)
Focus
Focus

Description:

The callback is sent a Phaser.Types.Physics.Matter.MatterCollisionData object.

This does not change the bodies collision category, group or filter. Those must be set in addition to the callback.

Parameters:

name type description
callback function

The callback to invoke when this body stops colliding with another.

Returns:
Description:

This Game Object.

Examples:
Since: 3.22.0
Focus
Focus
setOnCollideActive(callback)
Focus
Focus

Description:

The callback is sent a Phaser.Types.Physics.Matter.MatterCollisionData object.

This does not change the bodies collision category, group or filter. Those must be set in addition to the callback.

Parameters:

name type description
callback function

The callback to invoke for the duration of this body colliding with another.

Returns:
Description:

This Game Object.

Examples:
Since: 3.22.0
Focus
Focus
setOnCollideWith(body, callback)
Focus
Focus

Description:

The callback is sent a reference to the other body, along with a Phaser.Types.Physics.Matter.MatterCollisionData object.

This does not change the bodies collision category, group or filter. Those must be set in addition to the callback.

Parameters:

name type description
body MatterJS.Body | Array.<MatterJS.Body>

The body, or an array of bodies, to test for collisions with.

callback function

The callback to invoke when this body collides with the given body or bodies.

Returns:
Description:

This Game Object.

Examples:
Since: 3.22.0
Focus
Focus