Phaser.Tilemaps.Components
Scope: static
Static functions
CalculateFacesAt
<static> CalculateFacesAt(tileX, tileY, layer)
Description:
Calculates interesting faces at the given tile coordinates of the specified layer. Interesting faces are used internally for optimizing collisions against tiles. This method is mostly used internally to optimize recalculating faces when only one tile has been changed.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The x coordinate of the tile in tile grid coordinates. |
| tileY | number | No | The y coordinate of the tile in tile grid coordinates. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Tilemaps.Tile - The tile at the given coordinates, or null if no tile exists there.
Source: src/tilemaps/components/CalculateFacesAt.js#L9
Since: 3.0.0
CalculateFacesWithin
<static> CalculateFacesWithin(tileX, tileY, width, height, layer)
Description:
Calculates the interesting faces for all collidable tiles within the rectangular area specified (in tile coordinates) of the layer. An "interesting face" is an exposed edge of a collidable tile — specifically, any face that is not shared with another collidable tile adjacent to it. For example, if two collidable tiles sit side by side, the shared edge between them is not an interesting face because a physics body moving between them would never collide with it. Only interesting faces are tested during collision resolution, which avoids the internal-edge problem and keeps collision checks efficient. This function is called automatically when tiles are placed or removed, and is mostly used internally by the tilemap system.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The left most tile index (in tile coordinates) to use as the origin of the area. |
| tileY | number | No | The top most tile index (in tile coordinates) to use as the origin of the area. |
| width | number | No | How many tiles wide from the tileX index the area will be. |
| height | number | No | How many tiles tall from the tileY index the area will be. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/CalculateFacesWithin.js#L10
Since: 3.0.0
CheckIsoBounds
<static> CheckIsoBounds(tileX, tileY, layer, [camera])
Description:
Checks if the given tile coordinate is within the visible bounds of the camera for an isometric tilemap layer. This is used during tile culling to determine whether a tile should be rendered.
The tile coordinate is first converted to world-space using the layer's tile-to-world transform. The resulting position is then tested against the camera's world view rectangle, expanded by the layer's cullPaddingX and cullPaddingY values (in tile units) to avoid tiles popping in at the edges of the viewport. The padding offsets are measured from the center of each tile.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The x coordinate, in tiles, not pixels. |
| tileY | number | No | The y coordinate, in tiles, not pixels. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to check against. |
| camera | Phaser.Cameras.Scene2D.Camera | Yes | The Camera to run the cull check against. |
Returns: boolean - Returns true if the coordinates are within the iso bounds.
Source: src/tilemaps/components/CheckIsoBounds.js#L11
Since: 3.50.0
Copy
<static> Copy(srcTileX, srcTileY, width, height, destTileX, destTileY, recalculateFaces, layer)
Description:
Copies the tiles in the source rectangular area to a new destination (all specified in tile coordinates) within the layer. This copies all tile properties and recalculates collision information in the destination region.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| srcTileX | number | No | The x coordinate of the area to copy from, in tiles, not pixels. |
| srcTileY | number | No | The y coordinate of the area to copy from, in tiles, not pixels. |
| width | number | No | The width of the area to copy, in tiles, not pixels. |
| height | number | No | The height of the area to copy, in tiles, not pixels. |
| destTileX | number | No | The x coordinate of the area to copy to, in tiles, not pixels. |
| destTileY | number | No | The y coordinate of the area to copy to, in tiles, not pixels. |
| recalculateFaces | boolean | No | true if the collision face data for tiles in the destination region should be recalculated after the copy. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/Copy.js#L12
Since: 3.0.0
CreateFromTiles
<static> CreateFromTiles(indexes, replacements, spriteConfig, scene, camera, layer)
Description:
Creates a Sprite for every object matching the given tile indexes in the layer. You can optionally specify if each tile will be replaced with a new tile after the Sprite has been created. This is useful if you want to lay down special tiles in a level that are converted to Sprites, but want to replace the tile itself with a floor tile or similar once converted.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| indexes | number | Array.<number> | No | The tile index, or array of indexes, to create Sprites from. |
| replacements | number | Array.<number> | No | The tile index, or array of indexes, to change a converted tile to. Set to null to leave the tiles unchanged. If an array is given, it is assumed to be a one-to-one mapping with the indexes array. |
| spriteConfig | Phaser.Types.GameObjects.Sprite.SpriteConfig | No | The config object to pass into the Sprite creator (i.e. scene.make.sprite). |
| scene | Phaser.Scene | No | The Scene to create the Sprites within. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when determining the world XY position of each tile. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Array.<Phaser.GameObjects.Sprite> - An array of the Sprites that were created.
Source: src/tilemaps/components/CreateFromTiles.js#L11
Since: 3.0.0
CullBounds
<static> CullBounds(layer, camera)
Description:
Calculates the tile coordinate bounds within the given orthogonal tilemap layer that fall inside the camera's viewport. The result accounts for the layer's position, scale, and cull padding on each axis. This is used internally by the cull tiles function to determine which tiles need to be rendered.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to run the cull check against. |
Returns: Phaser.Geom.Rectangle - A rectangle containing the culled bounds. If you wish to retain this object, clone it, as it's recycled internally.
Source: src/tilemaps/components/CullBounds.js#L13
Since: 3.50.0
CullTiles
<static> CullTiles(layer, camera, [outputArray], [renderOrder])
Description:
Returns the tiles in the given layer that are within the camera's viewport. Culling avoids rendering tiles that are off-screen, improving performance. The camera's world view bounds are calculated and snapped to the scaled tile size, taking cull padding (expressed in tiles) into account. If the layer has skipCull enabled, or if its scroll factors differ from 1, the full layer dimensions are used instead so that all tiles are included. This function is used internally by the tilemap rendering pipeline.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. | |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to run the cull check against. | |
| outputArray | array | Yes | An optional array to store the culled Tile objects within. | |
| renderOrder | number | Yes | 0 | The rendering order constant. Controls the order in which tiles are iterated and added to the output array. |
Returns: Array.<Phaser.Tilemaps.Tile> - An array of Tile objects.
Source: src/tilemaps/components/CullTiles.js#L10
Since: 3.50.0
Fill
<static> Fill(index, tileX, tileY, width, height, recalculateFaces, layer)
Description:
Sets the tiles in the given rectangular area (in tile coordinates) of the layer with the specified index. Tiles will be set to collide if the given index is a colliding index. Collision information in the region will be recalculated.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| index | number | No | The tile index to fill the area with. |
| tileX | number | No | The left most tile coordinate (in tile coordinates) to use as the origin of the area. |
| tileY | number | No | The top most tile coordinate (in tile coordinates) to use as the origin of the area. |
| width | number | No | How many tiles wide from the tileX coordinate the area will be. |
| height | number | No | How many tiles tall from the tileY coordinate the area will be. |
| recalculateFaces | boolean | No | true if the faces data should be recalculated. |
| layer | Phaser.Tilemaps.LayerData | No | The tile layer to use. If not given the current layer is used. |
Source: src/tilemaps/components/Fill.js#L11
Since: 3.0.0
FilterTiles
<static> FilterTiles(callback, context, tileX, tileY, width, height, filteringOptions, layer)
Description:
For each tile in the given rectangular area (in tile coordinates) of the layer, run the given filter callback function. Any tiles that pass the filter test (i.e. where the callback returns true) will be returned as a new array. Similar to Array.prototype.filter in vanilla JS.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| callback | function | No | The callback. Each tile in the given area will be passed to this callback as the first and only parameter. The callback should return true for tiles that pass the filter. |
| context | object | No | The context under which the callback should be run. |
| tileX | number | No | The left most tile index (in tile coordinates) to use as the origin of the area to filter. |
| tileY | number | No | The top most tile index (in tile coordinates) to use as the origin of the area to filter. |
| width | number | No | How many tiles wide from the tileX index the area will be. |
| height | number | No | How many tiles tall from the tileY index the area will be. |
| filteringOptions | Phaser.Types.Tilemaps.FilteringOptions | No | Optional filters to apply when getting the tiles. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Array.<Phaser.Tilemaps.Tile> - The filtered array of Tiles.
Source: src/tilemaps/components/FilterTiles.js#L9
Since: 3.0.0
FindByIndex
<static> FindByIndex(index, skip, reverse, layer)
Description:
Searches the entire map layer for the first tile matching the given index, then returns that Tile object. If no match is found, it returns null. The search starts from the top-left tile and continues horizontally until it hits the end of the row, then it drops down to the next row. If the reverse boolean is true, it scans starting from the bottom-right corner traveling up to the top-left.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| index | number | No | The tile index value to search for. |
| skip | number | No | The number of times to skip a matching tile before returning. |
| reverse | boolean | No | If true it will scan the layer in reverse, starting at the bottom-right. Otherwise it scans from the top-left. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Tilemaps.Tile - The first (or n skipped) tile with the matching index.
Source: src/tilemaps/components/FindByIndex.js#L7
Since: 3.0.0
FindTile
<static> FindTile(callback, context, tileX, tileY, width, height, filteringOptions, layer)
Description:
Find the first tile in the given rectangular area (in tile coordinates) of the layer that satisfies the provided testing function. I.e. finds the first tile for which callback returns true. Similar to Array.prototype.find in vanilla JS.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| callback | FindTileCallback | No | The callback. Each tile in the given area will be passed to this callback as the first parameter, along with the tile index and the array of tiles. |
| context | object | No | The context under which the callback should be run. |
| tileX | number | No | The left most tile index (in tile coordinates) to use as the origin of the area to filter. |
| tileY | number | No | The top most tile index (in tile coordinates) to use as the origin of the area to filter. |
| width | number | No | How many tiles wide from the tileX index the area will be. |
| height | number | No | How many tiles tall from the tileY index the area will be. |
| filteringOptions | Phaser.Types.Tilemaps.FilteringOptions | No | Optional filters to apply when getting the tiles. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Tilemaps.Tile - A Tile that matches the search, or null if no Tile found
Source: src/tilemaps/components/FindTile.js#L19
Since: 3.0.0
ForEachTile
<static> ForEachTile(callback, context, tileX, tileY, width, height, filteringOptions, layer)
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 | optional | description |
|---|---|---|---|
| callback | EachTileCallback | No | The callback. Each tile in the given area will be passed to this callback, along with its index in the array and the array itself. |
| context | object | No | The context under which the callback should be run. |
| tileX | number | No | The left most tile index (in tile coordinates) to use as the origin of the area to filter. |
| tileY | number | No | The top most tile index (in tile coordinates) to use as the origin of the area to filter. |
| width | number | No | How many tiles wide from the tileX index the area will be. |
| height | number | No | How many tiles tall from the tileY index the area will be. |
| filteringOptions | Phaser.Types.Tilemaps.FilteringOptions | No | Optional filters to apply when getting the tiles. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/ForEachTile.js#L17
Since: 3.0.0
GetCullTilesFunction
<static> GetCullTilesFunction(orientation)
Description:
Gets the correct function to use to cull tiles, based on the map orientation.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| orientation | number | No | The Tilemap orientation constant. |
Returns: function - The function to use to cull tiles for the given map type.
Source: src/tilemaps/components/GetCullTilesFunction.js#L14
Since: 3.50.0
GetTileAt
<static> GetTileAt(tileX, tileY, nonNull, layer)
Description:
Gets a tile at the given tile coordinates from the given layer.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | X position to get the tile from (given in tile units, not pixels). |
| tileY | number | No | Y position to get the tile from (given in tile units, not pixels). |
| nonNull | boolean | No | For empty tiles, return a Tile object with an index of -1 instead of null. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Tilemaps.Tile - The tile at the given coordinates or null if no tile was found or the coordinates were invalid.
Source: src/tilemaps/components/GetTileAt.js#L9
Since: 3.0.0
GetTileAtWorldXY
<static> GetTileAtWorldXY(worldX, worldY, nonNull, camera, layer)
Description:
Gets a tile at the given world coordinates from the given layer.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| worldX | number | No | X position to get the tile from (given in pixels) |
| worldY | number | No | Y position to get the tile from (given in pixels) |
| nonNull | boolean | No | For empty tiles, return a Tile object with an index of -1 instead of null. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the tile index from the world values. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Tilemaps.Tile - The tile at the given coordinates or null if no tile was found or the coordinates were invalid.
Source: src/tilemaps/components/GetTileAtWorldXY.js#L12
Since: 3.0.0
GetTileCorners
<static> GetTileCorners(tileX, tileY, camera, layer)
Description:
Gets the four corners of a tile, given its tile-space coordinates, as an array of world-space Vector2 positions. The returned positions account for the layer's world position, scale, and the camera's scroll offset, and are ordered: top-left, top-right, bottom-right, bottom-left.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The x coordinate, in tiles, not pixels. |
| tileY | number | No | The y coordinate, in tiles, not pixels. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera whose scroll offset is used when calculating the world-space position of the tile corners. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Array.<Phaser.Math.Vector2> - An array of Vector2s corresponding to the world XY location of each tile corner.
Source: src/tilemaps/components/GetTileCorners.js#L9
Since: 3.60.0
GetTileCornersFunction
<static> GetTileCornersFunction(orientation)
Description:
Gets the correct function to use to get the tile corners, based on the map orientation.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| orientation | number | No | The Tilemap orientation constant. |
Returns: function - The function to use to get the tile corners for the given map orientation.
Source: src/tilemaps/components/GetTileCornersFunction.js#L12
Since: 3.60.0
GetTilesWithin
<static> GetTilesWithin(tileX, tileY, width, height, filteringOptions, layer)
Description:
Gets the tiles in the given rectangular area (in tile coordinates) of the layer.
This returns an array containing references to the Tile instances themselves, so be aware that modifying them directly will affect the layer data.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The left most tile index (in tile coordinates) to use as the origin of the area. |
| tileY | number | No | The top most tile index (in tile coordinates) to use as the origin of the area. |
| width | number | No | How many tiles wide from the tileX index the area will be. |
| height | number | No | How many tiles tall from the tileY index the area will be. |
| filteringOptions | Phaser.Types.Tilemaps.FilteringOptions | No | Optional filters to apply when getting the tiles. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Array.<Phaser.Tilemaps.Tile> - Array of Tile objects.
Source: src/tilemaps/components/GetTilesWithin.js#L9
Since: 3.0.0
GetTilesWithinShape
<static> GetTilesWithinShape(shape, filteringOptions, camera, layer)
Description:
Gets the tiles that overlap with the given shape in the given layer. The shape must be a Circle, Line, Rectangle or Triangle. The shape should be in world coordinates.
Note: This method currently only works with orthogonal tilemap layers.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| shape | Phaser.Geom.Circle | Phaser.Geom.Line | Phaser.Geom.Rectangle | Phaser.Geom.Triangle |
| filteringOptions | Phaser.Types.Tilemaps.FilteringOptions | No | Optional filters to apply when getting the tiles. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the tile index from the world values. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Array.<Phaser.Tilemaps.Tile> - An array of Tile objects that intersect with the given shape, or an empty array if no tiles overlap or the layer is not orthogonal.
Source: src/tilemaps/components/GetTilesWithinShape.js#L23
Since: 3.0.0
GetTilesWithinWorldXY
<static> GetTilesWithinWorldXY(worldX, worldY, width, height, filteringOptions, camera, layer)
Description:
Gets the tiles in the given rectangular area (in world coordinates) of the layer.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| worldX | number | No | The world x coordinate for the top-left of the area. |
| worldY | number | No | The world y coordinate for the top-left of the area. |
| width | number | No | The width of the area. |
| height | number | No | The height of the area. |
| filteringOptions | Phaser.Types.Tilemaps.FilteringOptions | No | Optional filters to apply when getting the tiles. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when factoring in which tiles to return. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Array.<Phaser.Tilemaps.Tile> - Array of Tile objects.
Source: src/tilemaps/components/GetTilesWithinWorldXY.js#L13
Since: 3.0.0
GetTileToWorldXFunction
<static> GetTileToWorldXFunction(orientation)
Description:
Returns the correct function to use for converting a tile X coordinate to a world X pixel coordinate, based on the map orientation. For orthogonal maps, this returns the TileToWorldX function. For all other orientations, a NOOP function is returned, as non-orthogonal maps do not support this conversion.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| orientation | number | No | The Tilemap orientation constant. |
Returns: function - The function to use to convert tile X coordinates to world X pixel coordinates for the given map orientation.
Source: src/tilemaps/components/GetTileToWorldXFunction.js#L11
Since: 3.50.0
GetTileToWorldXYFunction
<static> GetTileToWorldXYFunction(orientation)
Description:
Gets the correct function to use to translate tiles, based on the map orientation.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| orientation | number | No | The Tilemap orientation constant. |
Returns: function - The function to use to translate tiles for the given map type.
Source: src/tilemaps/components/GetTileToWorldXYFunction.js#L14
Since: 3.50.0
GetTileToWorldYFunction
<static> GetTileToWorldYFunction(orientation)
Description:
Gets the correct function to use to translate tiles, based on the map orientation.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| orientation | number | No | The Tilemap orientation constant. |
Returns: function - The function to use to translate tiles for the given map type.
Source: src/tilemaps/components/GetTileToWorldYFunction.js#L12
Since: 3.50.0
GetWorldToTileXFunction
<static> GetWorldToTileXFunction(orientation)
Description:
Returns the correct function to use for converting a world pixel X coordinate to a tile X (column) index, based on the map orientation. Only orthogonal maps support this conversion; for all other orientations a NULL function is returned.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| orientation | number | No | The Tilemap orientation constant. |
Returns: function - The function to use to convert a world X coordinate to a tile X index for the given map orientation, or a NULL function if the orientation is unsupported.
Source: src/tilemaps/components/GetWorldToTileXFunction.js#L11
Since: 3.50.0
GetWorldToTileXYFunction
<static> GetWorldToTileXYFunction(orientation)
Description:
Returns the appropriate world-to-tile coordinate conversion function for the given map orientation. The returned function converts world pixel coordinates (X, Y) into tile grid coordinates, using the correct projection math for orthogonal, isometric, hexagonal, or staggered tilemaps. If the orientation is unrecognised, a NOOP function is returned.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| orientation | number | No | The Tilemap orientation constant, as defined in Phaser.Tilemaps.ORIENTATION_CONST. |
Returns: function - The world-to-tile coordinate conversion function for the given map orientation.
Source: src/tilemaps/components/GetWorldToTileXYFunction.js#L14
Since: 3.50.0
GetWorldToTileYFunction
<static> GetWorldToTileYFunction(orientation)
Description:
Returns the correct function to use for converting a world Y coordinate to a tile Y coordinate, based on the map orientation. Returns WorldToTileY for orthogonal maps, StaggeredWorldToTileY for staggered maps, and a NULL function for all other orientations.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| orientation | number | No | The Tilemap orientation constant. |
Returns: function - The function to use to convert a world Y coordinate to a tile Y coordinate for the given map orientation.
Source: src/tilemaps/components/GetWorldToTileYFunction.js#L12
Since: 3.50.0
HasTileAt
<static> HasTileAt(tileX, tileY, layer)
Description:
Checks if there is a tile at the given location (in tile coordinates) in the given layer. Returns false if there is no tile or if the tile at that location has an index of -1.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | X position to get the tile from (given in tile units, not pixels). |
| tileY | number | No | Y position to get the tile from (given in tile units, not pixels). |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: boolean - Returns true if a valid tile (with an index greater than -1) exists at the given coordinates, or false if the coordinates are out of bounds, the tile is null, or the tile index is -1.
Source: src/tilemaps/components/HasTileAt.js#L9
Since: 3.0.0
HasTileAtWorldXY
<static> HasTileAtWorldXY(worldX, worldY, camera, layer)
Description:
Checks if there is a tile at the given location (in world coordinates) in the given layer. Returns false if there is no tile or if the tile at that location has an index of -1.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| worldX | number | No | The X coordinate of the world position. |
| worldY | number | No | The Y coordinate of the world position. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when factoring in which tiles to return. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: boolean - Returns a boolean, or null if the layer given was invalid.
Source: src/tilemaps/components/HasTileAtWorldXY.js#L12
Since: 3.0.0
HexagonalCullBounds
<static> HexagonalCullBounds(layer, camera)
Description:
Calculates the tile grid index bounds of a hexagonal Tilemap Layer that fall within the camera's viewport. The bounds account for the layer's stagger axis (x or y), hex side length, tile scale, layer offset, and cull padding, returning the range of tile columns and rows that need to be rendered. This is used internally by the hexagonal cull tiles function.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to run the cull check against. |
Returns: object - An object containing the left, right, top and bottom tile grid index bounds.
Source: src/tilemaps/components/HexagonalCullBounds.js#L10
Since: 3.50.0
HexagonalCullTiles
<static> HexagonalCullTiles(layer, camera, [outputArray], [renderOrder])
Description:
Returns the tiles in the given layer that are within the camera's viewport. This is used internally.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. | |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to run the cull check against. | |
| outputArray | array | Yes | An optional array to store the Tile objects within. | |
| renderOrder | number | Yes | 0 | The rendering order constant. |
Returns: Array.<Phaser.Tilemaps.Tile> - An array of Tile objects.
Source: src/tilemaps/components/HexagonalCullTiles.js#L10
Since: 3.50.0
HexagonalGetTileCorners
<static> HexagonalGetTileCorners(tileX, tileY, camera, layer)
Description:
Calculates and returns the six corner positions of a hexagonal tile as an array of Vector2 objects in world space. The tile is identified by its tile grid coordinates and the corners are computed relative to the tile's world center, taking into account the layer's stagger axis and any scale applied to the tilemap layer.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The x coordinate, in tiles, not pixels. |
| tileY | number | No | The y coordinate, in tiles, not pixels. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when converting tile coordinates to world position. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Array.<Phaser.Math.Vector2> - An array of Vector2s corresponding to the world XY location of each tile corner.
Source: src/tilemaps/components/HexagonalGetTileCorners.js#L12
Since: 3.60.0
HexagonalTileToWorldXY
<static> HexagonalTileToWorldXY(tileX, tileY, point, camera, layer)
Description:
Converts from hexagonal tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the layer's position, scale and scroll. This will return a new Vector2 object or update the given point object.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The x coordinate, in tiles, not pixels. |
| tileY | number | No | The y coordinate, in tiles, not pixels. |
| point | Phaser.Math.Vector2 | No | A Vector2 to store the coordinates in. If not given a new Vector2 is created. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the world coordinates from the tile values. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Math.Vector2 - The XY location in world coordinates.
Source: src/tilemaps/components/HexagonalTileToWorldXY.js#L9
Since: 3.50.0
HexagonalWorldToTileXY
<static> HexagonalWorldToTileXY(worldX, worldY, snapToFloor, point, camera, layer)
Description:
Converts from world XY coordinates (pixels) to hexagonal tile XY coordinates (tile units), factoring in the layer's position, scale and scroll. This will return a new Vector2 object or update the given point object.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| worldX | number | No | The x coordinate to be converted, in pixels, not tiles. |
| worldY | number | No | The y coordinate to be converted, in pixels, not tiles. |
| snapToFloor | boolean | No | Whether or not to round the tile coordinates down to the nearest integer. |
| point | Phaser.Math.Vector2 | No | A Vector2 to store the coordinates in. If not given a new Vector2 is created. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the tile XY coordinates from the world values. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Math.Vector2 - The XY location in tile units.
Source: src/tilemaps/components/HexagonalWorldToTileXY.js#L9
Since: 3.50.0
IsInLayerBounds
<static> IsInLayerBounds(tileX, tileY, layer)
Description:
Checks if the given tile coordinates are within the bounds of the layer.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The x coordinate, in tiles, not pixels. |
| tileY | number | No | The y coordinate, in tiles, not pixels. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: boolean - true if the tile coordinates are within the bounds of the layer, otherwise false.
Source: src/tilemaps/components/IsInLayerBounds.js#L7
Since: 3.0.0
IsometricCullTiles
<static> IsometricCullTiles(layer, camera, [outputArray], [renderOrder])
Description:
Returns the tiles in the given layer that are within the camera's viewport. This is used internally.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. | |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to run the cull check against. | |
| outputArray | array | Yes | An optional array to store the Tile objects within. | |
| renderOrder | number | Yes | 0 | The rendering order constant. 0 = right-down, 1 = left-down, 2 = right-up, 3 = left-up. |
Returns: Array.<Phaser.Tilemaps.Tile> - An array of Tile objects.
Source: src/tilemaps/components/IsometricCullTiles.js#L9
Since: 3.50.0
IsometricTileToWorldXY
<static> IsometricTileToWorldXY(tileX, tileY, point, camera, layer)
Description:
Converts from isometric tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the layer's position, scale and scroll. This will return a new Vector2 object or update the given point object.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The x coordinate, in tiles, not pixels. |
| tileY | number | No | The y coordinate, in tiles, not pixels. |
| point | Phaser.Math.Vector2 | No | A Vector2 to store the coordinates in. If not given a new Vector2 is created. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the world position from the tile coordinates. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Math.Vector2 - The XY location in world coordinates.
Source: src/tilemaps/components/IsometricTileToWorldXY.js#L9
Since: 3.50.0
IsometricWorldToTileXY
<static> IsometricWorldToTileXY(worldX, worldY, snapToFloor, point, camera, layer, [originTop])
Description:
Converts from world XY coordinates (pixels) to isometric tile XY coordinates (tile units), factoring in the layer's position, scale and scroll. This will return a new Vector2 object or update the given point object.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| worldX | number | No | The x coordinate to be converted, in pixels, not tiles. | |
| worldY | number | No | The y coordinate to be converted, in pixels, not tiles. | |
| snapToFloor | boolean | No | Whether or not to round the tile coordinate down to the nearest integer. | |
| point | Phaser.Math.Vector2 | No | A Vector2 to store the coordinates in. If not given a new Vector2 is created. | |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the tile index from the world values. | |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. | |
| originTop | boolean | Yes | true | Which is the active face of the isometric tile? The top (default, true), or the base? (false) |
Returns: Phaser.Math.Vector2 - The XY location in tile units.
Source: src/tilemaps/components/IsometricWorldToTileXY.js#L9
Since: 3.50.0
PutTileAt
<static> PutTileAt(tile, tileX, tileY, recalculateFaces, layer)
Description:
Puts a tile at the given tile coordinates in the specified layer. You can pass in either an index or a Tile object. If you pass in a Tile, all attributes will be copied over to the specified location. If you pass in an index, only the index at the specified location will be changed. Collision information will be recalculated at the specified location.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tile | number | Phaser.Tilemaps.Tile | No | The index of this tile to set or a Tile object. |
| tileX | number | No | The x coordinate, in tiles, not pixels. |
| tileY | number | No | The y coordinate, in tiles, not pixels. |
| recalculateFaces | boolean | No | true if the faces data should be recalculated. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Tilemaps.Tile - The Tile object that was created or added to this map.
Source: src/tilemaps/components/PutTileAt.js#L12
Since: 3.0.0
PutTileAtWorldXY
<static> PutTileAtWorldXY(tile, worldX, worldY, recalculateFaces, camera, layer)
Description:
Puts a tile at the given world coordinates (pixels) in the specified layer. You can pass in either an index or a Tile object. If you pass in a Tile, all attributes will be copied over to the specified location. If you pass in an index, only the index at the specified location will be changed. Collision face information will be recalculated at the specified location if recalculateFaces is true.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tile | number | Phaser.Tilemaps.Tile | No | The index of this tile to set or a Tile object. |
| worldX | number | No | The x coordinate, in pixels. |
| worldY | number | No | The y coordinate, in pixels. |
| recalculateFaces | boolean | No | true if the tile edge collision face data should be recalculated. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the tile index from the world values. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Tilemaps.Tile - The Tile object that was created or added to this map.
Source: src/tilemaps/components/PutTileAtWorldXY.js#L12
Since: 3.0.0
PutTilesAt
<static> PutTilesAt(tilesArray, tileX, tileY, recalculateFaces, layer)
Description:
Puts an array of tiles or a 2D array of tiles at the given tile coordinates in the specified layer. The array can be composed of either tile indexes or Tile objects. If you pass in a Tile, all attributes will be copied over to the specified location. If you pass in an index, only the index at the specified location will be changed. Collision information will be recalculated within the region tiles were changed.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tilesArray | Array.<number> | Array.<Array.<number>> | Array.<Phaser.Tilemaps.Tile> | Array.<Array.<Phaser.Tilemaps.Tile>> |
| tileX | number | No | The x coordinate, in tiles, not pixels. |
| tileY | number | No | The y coordinate, in tiles, not pixels. |
| recalculateFaces | boolean | No | true if the faces data should be recalculated. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/PutTilesAt.js#L10
Since: 3.0.0
Randomize
<static> Randomize(tileX, tileY, width, height, indexes, layer)
Description:
Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the specified layer. Each tile will receive a new index. If an array of indexes is passed in, then those will be used for randomly assigning new tile indexes. If an array is not provided, the indexes found within the region (excluding -1) will be used for randomly assigning new tile indexes. This method only modifies tile indexes and does not change collision information.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The left-most tile coordinate (in tile coordinates) to use as the origin of the area. |
| tileY | number | No | The top-most tile coordinate (in tile coordinates) to use as the origin of the area. |
| width | number | No | How many tiles wide from the tileX coordinate the area will be. |
| height | number | No | How many tiles tall from the tileY coordinate the area will be. |
| indexes | Array.<number> | No | An array of indexes to randomly draw from during randomization. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/Randomize.js#L10
Since: 3.0.0
RemoveTileAt
<static> RemoveTileAt(tileX, tileY, replaceWithNull, recalculateFaces, layer)
Description:
Removes the tile at the given tile coordinates in the specified layer and updates the layer's collision information.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The x coordinate of the tile to remove, in tile grid units (not pixels). |
| tileY | number | No | The y coordinate of the tile to remove, in tile grid units (not pixels). |
| replaceWithNull | boolean | No | If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1. |
| recalculateFaces | boolean | No | true if the faces data should be recalculated. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Tilemaps.Tile - The Tile object that was removed.
Source: src/tilemaps/components/RemoveTileAt.js#L11
Since: 3.0.0
RemoveTileAtWorldXY
<static> RemoveTileAtWorldXY(worldX, worldY, replaceWithNull, recalculateFaces, camera, layer)
Description:
Removes the tile at the given world coordinates in the specified layer and updates the layer's collision information.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| worldX | number | No | The x coordinate, in pixels. |
| worldY | number | No | The y coordinate, in pixels. |
| replaceWithNull | boolean | No | If true, this will replace the tile at the specified location with null instead of a Tile with an index of -1. |
| recalculateFaces | boolean | No | true if the faces data should be recalculated. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the tile index from the world values. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Tilemaps.Tile - The Tile object that was removed.
Source: src/tilemaps/components/RemoveTileAtWorldXY.js#L12
Since: 3.0.0
RenderDebug
<static> RenderDebug(graphics, styleConfig, layer)
Description:
Draws a debug representation of the layer to the given Graphics. This is helpful when you want to get a quick idea of which of your tiles are colliding and which have interesting faces. The tiles are drawn starting at (0, 0) in the Graphics, allowing you to place the debug representation wherever you want on the screen.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| graphics | Phaser.GameObjects.Graphics | No | The target Graphics object to draw upon. |
| styleConfig | Phaser.Types.Tilemaps.DebugStyleOptions | No | An object specifying the colors to use for the debug drawing. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/RenderDebug.js#L14
Since: 3.0.0
ReplaceByIndex
<static> ReplaceByIndex(findIndex, newIndex, tileX, tileY, width, height, layer)
Description:
Scans the given rectangular area (given in tile coordinates) for tiles with an index matching findIndex and updates their index to match newIndex. This only modifies the index and does not change collision information.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| findIndex | number | No | The index of the tile to search for. |
| newIndex | number | No | The index of the tile to replace it with. |
| tileX | number | No | The left most tile coordinate (in tile coordinates) to use as the origin of the area. |
| tileY | number | No | The top most tile coordinate (in tile coordinates) to use as the origin of the area. |
| width | number | No | How many tiles wide from the tileX index the area will be. |
| height | number | No | How many tiles tall from the tileY index the area will be. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/ReplaceByIndex.js#L9
Since: 3.0.0
RunCull
<static> RunCull(layer, bounds, renderOrder, outputArray)
Description:
Returns the tiles in the given layer that are within the camera's viewport. This is used internally.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
| bounds | object | No | An object containing the left, right, top and bottom bounds. |
| renderOrder | number | No | The rendering order constant. 0 = right-down, 1 = left-down, 2 = right-up, 3 = left-up. |
| outputArray | array | No | The array to store the Tile objects within. |
Returns: Array.<Phaser.Tilemaps.Tile> - An array of Tile objects.
Source: src/tilemaps/components/RunCull.js#L7
Since: 3.50.0
SetCollision
<static> SetCollision(indexes, collides, recalculateFaces, layer, [updateLayer])
Description:
Sets collision on the given tile or tiles within a layer by index. You can pass in either a single numeric index or an array of indexes: [2, 3, 15, 20]. The collides parameter controls if collision will be enabled (true) or disabled (false).
This function updates both the layer's collision index (which affects any tiles placed in the future) and, unless updateLayer is false, all existing tiles in the layer that match the given indexes.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| indexes | number | array | No | Either a single tile index, or an array of tile indexes. | |
| collides | boolean | No | If true it will enable collision. If false it will clear collision. | |
| recalculateFaces | boolean | No | Whether or not to recalculate the tile faces after the update. | |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. | |
| updateLayer | boolean | Yes | true | If true, updates the current tiles on the layer. Set to false if no tiles have been placed for significant performance boost. |
Source: src/tilemaps/components/SetCollision.js#L11
Since: 3.0.0
SetCollisionBetween
<static> SetCollisionBetween(start, stop, collides, recalculateFaces, layer, [updateLayer])
Description:
Sets collision on a range of tiles in a layer whose index is between the specified start and stop (inclusive). Calling this with a start value of 10 and a stop value of 14 would set collision for tiles 10, 11, 12, 13 and 14. The collides parameter controls if collision will be enabled (true) or disabled (false).
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| start | number | No | The first index of the tile to be set for collision. | |
| stop | number | No | The last index of the tile to be set for collision. | |
| collides | boolean | No | If true it will enable collision. If false it will clear collision. | |
| recalculateFaces | boolean | No | Whether or not to recalculate the tile faces after the update. | |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. | |
| updateLayer | boolean | Yes | true | If true, updates the current tiles on the layer. Set to false if no tiles have been placed for significant performance boost. |
Source: src/tilemaps/components/SetCollisionBetween.js#L11
Since: 3.0.0
SetCollisionByExclusion
<static> SetCollisionByExclusion(indexes, collides, recalculateFaces, layer)
Description:
Sets collision on all tiles in the given layer, except for tiles that have an index specified in the given array. The collides parameter controls if collision will be enabled (true) or disabled (false). Tile indexes not currently in the layer are not affected.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| indexes | Array.<number> | No | An array of tile indexes to exclude from the collision update. Tiles with these indexes will not have their collision state changed. |
| collides | boolean | No | If true it will enable collision. If false it will clear collision. |
| recalculateFaces | boolean | No | Whether or not to recalculate the tile faces after the update. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/SetCollisionByExclusion.js#L11
Since: 3.0.0
SetCollisionByProperty
<static> SetCollisionByProperty(properties, collides, recalculateFaces, layer)
Description:
Sets collision on the tiles within a layer by checking tile properties. If a tile has a property that matches the given properties object, its collision flag will be set. The collides parameter controls if collision will be enabled (true) or disabled (false). Passing in { collides: true } would update the collision flag on any tiles with a "collides" property that has a value of true. Any tile that doesn't have "collides" set to true will be ignored. You can also use an array of values, e.g. { types: ["stone", "lava", "sand" ] }. If a tile has a "types" property that matches any of those values, its collision flag will be updated.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| properties | object | No | An object with tile properties and corresponding values that should be checked. |
| collides | boolean | No | If true it will enable collision. If false it will clear collision. |
| recalculateFaces | boolean | No | Whether or not to recalculate the tile faces after the update. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/SetCollisionByProperty.js#L11
Since: 3.0.0
SetCollisionFromCollisionGroup
<static> SetCollisionFromCollisionGroup(collides, recalculateFaces, layer)
Description:
Sets collision on the tiles within a layer by checking each tile's collision group data (typically defined in Tiled within the tileset collision editor). If any objects are found within a tile's collision group, the tile's colliding information will be set. The collides parameter controls if collision will be enabled (true) or disabled (false).
Parameters:
| name | type | optional | description |
|---|---|---|---|
| collides | boolean | No | If true it will enable collision. If false it will clear collision. |
| recalculateFaces | boolean | No | Whether or not to recalculate the tile faces after the update. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/SetCollisionFromCollisionGroup.js#L10
Since: 3.0.0
SetLayerCollisionIndex
<static> SetLayerCollisionIndex(tileIndex, collides, layer)
Description:
Internally used method to keep track of the tile indexes that collide within a layer. This updates LayerData.collideIndexes to either contain or not contain the given tileIndex.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileIndex | number | No | The tile index to set the collision boolean for. |
| collides | boolean | No | Should the tile index collide or not? |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/SetLayerCollisionIndex.js#L7
Since: 3.0.0
SetTileCollision
<static> SetTileCollision(tile, [collides])
Description:
Internally used method to set the colliding state of a tile. This does not recalculate interesting faces.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| tile | Phaser.Tilemaps.Tile | No | The Tile to set the collision on. | |
| collides | boolean | Yes | true | Should the tile collide or not? |
Source: src/tilemaps/components/SetTileCollision.js#L7
Since: 3.0.0
SetTileIndexCallback
<static> SetTileIndexCallback(indexes, callback, callbackContext, layer)
Description:
Sets a global collision callback for the given tile index within the layer. This will affect all tiles on this layer that have the same index. If a callback is already set for the tile index it will be replaced. Set the callback to null to remove it. If you want to set a callback for a tile at a specific location on the map then see setTileLocationCallback.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| indexes | number | array | No | Either a single tile index, or an array of tile indexes to have a collision callback set for. |
| callback | function | No | The callback that will be invoked when the tile is collided with. |
| callbackContext | object | No | The context under which the callback is called. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/SetTileIndexCallback.js#L7
Since: 3.0.0
SetTileLocationCallback
<static> SetTileLocationCallback(tileX, tileY, width, height, callback, callbackContext, layer)
Description:
Sets a collision callback for the given rectangular area (in tile coordinates) within the layer. If a callback is already set for a tile it will be replaced. Set the callback to null to remove it.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The left most tile coordinate to use as the origin of the area. |
| tileY | number | No | The top most tile coordinate to use as the origin of the area. |
| width | number | No | How many tiles wide from the tileX index the area will be. |
| height | number | No | How many tiles tall from the tileY index the area will be. |
| callback | function | No | The callback that will be invoked when the tile is collided with. |
| callbackContext | object | No | The context under which the callback is called. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/SetTileLocationCallback.js#L9
Since: 3.0.0
Shuffle
<static> Shuffle(tileX, tileY, width, height, layer)
Description:
Shuffles the tiles in a rectangular region (specified in tile coordinates) within the given layer. It will only randomize the tiles in that area, so if they're all the same nothing will appear to have changed! This method only modifies tile indexes and does not change collision information.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The leftmost tile index (in tile coordinates) to use as the origin of the area. |
| tileY | number | No | The topmost tile index (in tile coordinates) to use as the origin of the area. |
| width | number | No | How many tiles wide from the tileX index the area will be. |
| height | number | No | How many tiles tall from the tileY index the area will be. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/Shuffle.js#L10
Since: 3.0.0
StaggeredCullBounds
<static> StaggeredCullBounds(layer, camera)
Description:
Returns the bounds in the given layer that are within the camera's viewport. This is used internally by the cull tiles function.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to run the cull check against. |
Returns: object - An object containing the left, right, top and bottom bounds.
Source: src/tilemaps/components/StaggeredCullBounds.js#L10
Since: 3.50.0
StaggeredCullTiles
<static> StaggeredCullTiles(layer, camera, [outputArray], [renderOrder])
Description:
Returns the tiles in the given layer that are within the camera's viewport. This is used internally.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. | |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to run the cull check against. | |
| outputArray | array | Yes | An optional array to store the Tile objects within. | |
| renderOrder | number | Yes | 0 | The rendering order constant. |
Returns: Array.<Phaser.Tilemaps.Tile> - An array of Tile objects.
Source: src/tilemaps/components/StaggeredCullTiles.js#L10
Since: 3.50.0
StaggeredTileToWorldXY
<static> StaggeredTileToWorldXY(tileX, tileY, point, camera, layer)
Description:
Converts from staggered tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the layer's position, scale and scroll. This will return a new Vector2 object or update the given point object.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The x coordinate, in tiles, not pixels. |
| tileY | number | No | The y coordinate, in tiles, not pixels. |
| point | Phaser.Math.Vector2 | No | A Vector2 to store the coordinates in. If not given a new Vector2 is created. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the world position from the tile coordinates. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Math.Vector2 - The XY location in world coordinates.
Source: src/tilemaps/components/StaggeredTileToWorldXY.js#L9
Since: 3.50.0
StaggeredTileToWorldY
<static> StaggeredTileToWorldY(tileY, camera, layer)
Description:
Converts from staggered tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the layer's position, scale and scroll.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileY | number | No | The y coordinate, in tiles, not pixels. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when factoring in scroll offset during the conversion. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: number - The Y location in world coordinates.
Source: src/tilemaps/components/StaggeredTileToWorldY.js#L7
Since: 3.50.0
StaggeredWorldToTileXY
<static> StaggeredWorldToTileXY(worldX, worldY, snapToFloor, point, camera, layer)
Description:
Converts from world XY coordinates (pixels) to staggered tile XY coordinates (tile units), factoring in the layer's position, scale and scroll. This will return a new Vector2 object or update the given point object.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| worldX | number | No | The x coordinate to be converted, in pixels, not tiles. |
| worldY | number | No | The y coordinate to be converted, in pixels, not tiles. |
| snapToFloor | boolean | No | Whether or not to round the tile coordinate down to the nearest integer. |
| point | Phaser.Math.Vector2 | No | A Vector2 to store the coordinates in. If not given a new Vector2 is created. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the tile index from the world values. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Math.Vector2 - The XY location in tile units.
Source: src/tilemaps/components/StaggeredWorldToTileXY.js#L9
Since: 3.50.0
StaggeredWorldToTileY
<static> StaggeredWorldToTileY(worldY, snapToFloor, camera, layer)
Description:
Converts from world Y coordinates (pixels) to staggered tile Y coordinates (tile units), factoring in the layer's position, scale and scroll.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| worldY | number | No | The y coordinate to be converted, in pixels, not tiles. |
| snapToFloor | boolean | No | Whether or not to round the tile coordinate down to the nearest integer. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the tile index from the world values. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: number - The Y location in tile units.
Source: src/tilemaps/components/StaggeredWorldToTileY.js#L7
Since: 3.50.0
SwapByIndex
<static> SwapByIndex(indexA, indexB, tileX, tileY, width, height, layer)
Description:
Scans the given rectangular area (given in tile coordinates) for tiles with an index matching indexA and swaps them with indexB. This only modifies the index and does not change collision information.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| indexA | number | No | The tile index to search for and replace with indexB. |
| indexB | number | No | The tile index to replace indexA with. |
| tileX | number | No | The left most tile index (in tile coordinates) to use as the origin of the area. |
| tileY | number | No | The top most tile index (in tile coordinates) to use as the origin of the area. |
| width | number | No | How many tiles wide from the tileX index the area will be. |
| height | number | No | How many tiles tall from the tileY index the area will be. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/SwapByIndex.js#L9
Since: 3.0.0
TileToWorldX
<static> TileToWorldX(tileX, camera, layer)
Description:
Converts from tile X coordinates (tile units) to world X coordinates (pixels), factoring in the layer's position, scale and scroll.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The x coordinate, in tiles, not pixels. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the world position from the tile coordinates. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: number - The world X coordinate, in pixels, corresponding to the given tile X coordinate.
Source: src/tilemaps/components/TileToWorldX.js#L7
Since: 3.0.0
TileToWorldXY
<static> TileToWorldXY(tileX, tileY, point, camera, layer)
Description:
Converts from tile XY coordinates (tile units) to world XY coordinates (pixels), factoring in the layer's position, scale and scroll. This will return a new Vector2 object or update the given point object.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The x coordinate, in tiles, not pixels. |
| tileY | number | No | The y coordinate, in tiles, not pixels. |
| point | Phaser.Math.Vector2 | No | A Vector2 to store the coordinates in. If not given a new Vector2 is created. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when converting the tile coordinates to world pixel values. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Math.Vector2 - The XY location in world coordinates.
Source: src/tilemaps/components/TileToWorldXY.js#L11
Since: 3.0.0
TileToWorldY
<static> TileToWorldY(tileY, camera, layer)
Description:
Converts from tile Y coordinates (tile units) to world Y coordinates (pixels), factoring in the layer's position, scale and scroll.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileY | number | No | The y coordinate, in tiles, not pixels. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the tile index from the world values. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: number - The Y location in world coordinates.
Source: src/tilemaps/components/TileToWorldY.js#L7
Since: 3.0.0
WeightedRandomize
<static> WeightedRandomize(tileX, tileY, width, height, weightedIndexes, layer)
Description:
Randomizes the indexes of a rectangular region of tiles (in tile coordinates) within the specified layer. Each tile will receive a new index. New indexes are drawn from the given weightedIndexes array. An example weighted array:
[ { index: 6, weight: 4 }, // Probability of index 6 is 4 / 8 { index: 7, weight: 2 }, // Probability of index 7 would be 2 / 8 { index: 8, weight: 1.5 }, // Probability of index 8 would be 1.5 / 8 { index: 26, weight: 0.5 } // Probability of index 26 would be 0.5 / 8 ]
The probability of any index being chosen is (the index's weight) / (sum of all weights). This method only modifies tile indexes and does not change collision information.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| tileX | number | No | The left most tile index (in tile coordinates) to use as the origin of the area. |
| tileY | number | No | The top most tile index (in tile coordinates) to use as the origin of the area. |
| width | number | No | How many tiles wide from the tileX index the area will be. |
| height | number | No | How many tiles tall from the tileY index the area will be. |
| weightedIndexes | Array.<object> | No | An array of objects to randomly draw from during randomization. They should be in the form: { index: 0, weight: 4 } or { index: [0, 1], weight: 4 } if you wish to draw from multiple tile indexes. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Source: src/tilemaps/components/WeightedRandomize.js#L10
Since: 3.0.0
WorldToTileX
<static> WorldToTileX(worldX, snapToFloor, camera, layer)
Description:
Converts from world X coordinates (pixels) to tile X coordinates (tile units), factoring in the layer's position, scale and scroll.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| worldX | number | No | The x coordinate to be converted, in pixels, not tiles. |
| snapToFloor | boolean | No | Whether or not to round the tile coordinate down to the nearest integer. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the tile index from the world values. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: number - The X location in tile units.
Source: src/tilemaps/components/WorldToTileX.js#L12
Since: 3.0.0
WorldToTileXY
<static> WorldToTileXY(worldX, worldY, snapToFloor, point, camera, layer)
Description:
Converts from world XY coordinates (pixels) to tile XY coordinates (tile units), factoring in the layer's position, scale and scroll. This will return a new Vector2 object or update the given point object.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| worldX | number | No | The x coordinate to be converted, in pixels, not tiles. |
| worldY | number | No | The y coordinate to be converted, in pixels, not tiles. |
| snapToFloor | boolean | No | Whether or not to round the tile coordinate down to the nearest integer. |
| point | Phaser.Math.Vector2 | No | A Vector2 to store the coordinates in. If not given a new Vector2 is created. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the tile index from the world values. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: Phaser.Math.Vector2 - The XY location in tile units.
Source: src/tilemaps/components/WorldToTileXY.js#L9
Since: 3.0.0
WorldToTileY
<static> WorldToTileY(worldY, snapToFloor, camera, layer)
Description:
Converts from world Y coordinates (pixels) to tile Y coordinates (tile units), factoring in the layer's position, scale and scroll.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| worldY | number | No | The y coordinate to be converted, in pixels, not tiles. |
| snapToFloor | boolean | No | Whether or not to round the tile coordinate down to the nearest integer. |
| camera | Phaser.Cameras.Scene2D.Camera | No | The Camera to use when calculating the tile index from the world values. |
| layer | Phaser.Tilemaps.LayerData | No | The Tilemap Layer to act upon. |
Returns: number - The Y location in tile units.
Source: src/tilemaps/components/WorldToTileY.js#L12
Since: 3.0.0