Phaser API Documentation

  Version: 
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
Event: TILE_OVERLAP
Phaser.Physics.Arcade.Events.TILE_OVERLAP
TILE_OVERLAP

Description:

The Arcade Physics Tile Overlap Event.

This event is dispatched by an Arcade Physics World instance if a body overlaps with a Tile and has its onOverlap property set to true.

It provides an alternative means to handling overlap events rather than using the callback approach.

Listen to it from a Scene using: this.physics.world.on('tileoverlap', listener).

Please note that 'collide' and 'overlap' are two different things in Arcade Physics.

Parameters:

name type description
gameObject Phaser.GameObjects.GameObject

The Game Object involved in the overlap. This is the parent of body.

tile Phaser.Tilemaps.Tile

The tile the body overlapped.

body Phaser.Physics.Arcade.Body

The Arcade Physics Body of the Game Object involved in the overlap.

Since: 3.16.1