Phaser API Documentation

  Version: 
getTilesWithin([tileX], [tileY], [width], [height], [filteringOptions])

Description:

Gets the tiles in the given rectangular area (in tile coordinates) of the layer.

Parameters:

name type arguments description
tileX number <optional>

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

tileY number <optional>

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

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:

An array of Tile objects found within the area.

Type:
Since: 3.50.0