Phaser API Documentation

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

Description:

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

If no layer is specified, the maps current layer is used.

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.

layer string | number | Phaser.Tilemaps.TilemapLayer <optional>

The tile layer to use. If not given the current layer is used.

Returns:
Description:

Returns an array of Tiles, or null if the layer given was invalid.

Type:
Since: 3.0.0
Source: src/tilemaps/Tilemap.js (Line 1363)