Phaser API Documentation

  Version: 
<private> collideObjects(object1, [object2], collideCallback, processCallback, callbackContext, overlapOnly)

Description:

Internal helper function. Please use Phaser.Physics.Arcade.World#collide instead.

Parameters:

name type arguments description
object1 Phaser.Types.Physics.Arcade.ArcadeColliderType

The first object to check for collision.

object2 Phaser.Types.Physics.Arcade.ArcadeColliderType <optional>

The second object to check for collision.

collideCallback ArcadePhysicsCallback

The callback to invoke when the two objects collide.

processCallback ArcadePhysicsCallback

The callback to invoke when the two objects collide. Must return a boolean.

callbackContext any

The scope in which to call the callbacks.

overlapOnly boolean

Whether this is a collision or overlap check.

Returns:
Description:

True if any objects overlap (with overlapOnly); or true if any overlapping objects were separated.

Type:
  • boolean
Examples:
Since: 3.0.0