collideSpriteVsTilesHandler - Phaser 3 API Documentation (beta)

<private> collideSpriteVsTilesHandler(sprite, tilemapLayer, [collideCallback], [processCallback], [callbackContext], [overlapOnly], [isLayer])

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

name	type	arguments	description
sprite	Phaser.GameObjects.GameObject		The first object to check for collision.
tilemapLayer	Phaser.Tilemaps.TilemapLayer		The second object to check for collision.
collideCallback	ArcadePhysicsCallback	<optional>	An optional callback function that is called if the objects collide.
processCallback	ArcadePhysicsCallback	<optional>	An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.
callbackContext	any	<optional>	The context in which to run the callbacks.
overlapOnly	boolean	<optional>	Whether this is a collision or overlap check.
isLayer	boolean	<optional>	Is this check coming from a TilemapLayer or an array of tiles?

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

Since: 3.17.0

Source: src/physics/arcade/World.js (Line 2223)

Possible examples