Phaser API Documentation

  Version: 
<private> collideSpriteVsGroup(sprite, group, collideCallback, processCallback, callbackContext, overlapOnly)

Description:

Internal handler for Sprite vs. Group collisions. Please use Phaser.Physics.Arcade.World#collide instead.

Parameters:

name type description
sprite Phaser.GameObjects.GameObject

The first object to check for collision.

group Phaser.GameObjects.Group

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 the Sprite collided with the given Group, otherwise false.

Type:
  • boolean
Examples:
Since: 3.0.0