Phaser API Documentation

  Version: 
forEachTile(callback, [context], [tileX], [tileY], [width], [height], [filteringOptions])

Description:

For each tile in the given rectangular area (in tile coordinates) of the layer, run the given callback. Similar to Array.prototype.forEach in vanilla JS.

Parameters:

name type arguments description
callback EachTileCallback

The callback. Each tile in the given area will be passed to this callback as the first and only parameter.

context object <optional>

The context, or scope, under which the callback should be run.

tileX number <optional>

The left most tile index (in tile coordinates) to use as the origin of the area to search.

tileY number <optional>

The top most tile index (in tile coordinates) to use as the origin of the area to search.

width number <optional>

How many tiles wide from the tileX index the area will be.

height number <optional>

How many tiles tall from the tileY index the area will be.

filteringOptions Phaser.Types.Tilemaps.FilteringOptions <optional>

Optional filters to apply when getting the tiles.

Returns:
Description:

This Tilemap Layer object.

Since: 3.50.0