Phaser API Documentation

  Version: 
Filter
Namespace: Collision
Phaser.Physics.Arcade.Components.Collision

Methods

setCollisionCategory(category)
Focus
Focus

Description:

Sets the Collision Category that this Arcade Physics Body will use in order to determine what it can collide with.

It can only have one single category assigned to it.

If you wish to reset the collision category and mask, call the resetCollisionCategory method.

Parameters:

name type description
category number

The collision category.

Returns:
Description:

This Game Object.

Since: 3.70.0
Focus
Focus
willCollideWith(category)
Focus
Focus

Description:

Checks to see if the given Collision Category will collide with this Arcade Physics object or not.

Parameters:

name type description
category number

Collision category value to test.

Returns:
Description:

true if the given category will collide with this object, otherwise false.

Type:
  • boolean
Since: 3.70.0
Focus
Focus
addCollidesWith(category)
Focus
Focus

Description:

Adds the given Collision Category to the list of those that this Arcade Physics Body will collide with.

Parameters:

name type description
category number

The collision category to add.

Returns:
Description:

This Game Object.

Since: 3.70.0
Focus
Focus
removeCollidesWith(category)
Focus
Focus

Description:

Removes the given Collision Category from the list of those that this Arcade Physics Body will collide with.

Parameters:

name type description
category number

The collision category to add.

Returns:
Description:

This Game Object.

Since: 3.70.0
Focus
Focus
setCollidesWith(categories)
Focus
Focus

Description:

Sets all of the Collision Categories that this Arcade Physics Body will collide with. You can either pass a single category value, or an array of them.

Calling this method will reset all of the collision categories, so only those passed to this method are enabled.

If you wish to add a new category to the existing mask, call the addCollisionCategory method.

If you wish to reset the collision category and mask, call the resetCollisionCategory method.

Parameters:

name type description
categories number | Array.<number>

The collision category to collide with, or an array of them.

Returns:
Description:

This Game Object.

Since: 3.70.0
Focus
Focus
resetCollisionCategory()
Focus
Focus

Description:

Resets the Collision Category and Mask back to the defaults, which is to collide with everything.

Returns:
Description:

This Game Object.

Since: 3.70.0
Focus
Focus