Tile map Reference

The Tilemap object can be used to display tile-based objects. It's a good way to create maps for RPG, strategy games or create objects by assembling tiles, useful for platformer, retro-looking games, etc... External tilemaps are also supported - but it's recommended to use the built-in, simple Tilemap object for most use cases. Read more explanations about it.

External Tilemap (Tiled/LDtk) collision mask

Invisible object handling collisions with parts of a tilemap.

Object properties

Class filter (🔤 String). Only the tiles with the given class (set in Tiled 1.9+) will have hitboxes created.
Debug mode (🔘 Boolean). When activated, it displays the hitboxes in the given color. Default value is false.
Fill color (🎨 Color). Default value is 255;255;255.
Fill opacity (0-255) (🔢 Number). Default value is 64.
Layer index (🔢 Number). Default value is 1.
Outline color (🎨 Color). Default value is 255;255;255.
Outline opacity (0-255) (🔢 Number). Default value is 128.
Outline size (in pixels) (🔢 Number). Default value is 1.
Tilemap JSON file (🗂️ Resource). This is the JSON file that was saved or exported from Tiled. LDtk is not supported yet for collisions.
Tileset JSON file (optional) (🗂️ Resource). Optional, don't specify it if you've not saved the tileset in a different file.
Use all layers (🔘 Boolean). Default value is true.

See internal technical details

Class filter is stored as collisionMaskTag (string). Default value is ``.
Debug mode is stored as debugMode (boolean). Default value is false.
Fill color is stored as fillColor (color). Default value is 255;255;255.
Fill opacity (0-255) is stored as fillOpacity (number). Default value is 64.
Layer index is stored as layerIndex (number). Default value is 1.
Outline color is stored as outlineColor (color). Default value is 255;255;255.
Outline opacity (0-255) is stored as outlineOpacity (number). Default value is 128.
Outline size (in pixels) is stored as outlineSize (number). Default value is 1.
Tilemap JSON file is stored as tilemapJsonFile (resource). Default value is ``.
Tileset JSON file (optional) is stored as tilesetJsonFile (resource). Default value is ``.
Use all layers is stored as useAllLayers (boolean). Default value is true.

Object actions

Tilemap JSON file
Set the JSON file containing the Tilemap data to display. This is usually the JSON file exported from Tiled.

See parameters & details

Parameter 0 (👾 Object): Tile map collision mask
Parameter 1 (jsonResource): Tilemap JSON file

Technical note: this action internal type (in GDevelop JSON) is TileMap::CollisionMask::SetTilemapJsonFile.

Tileset JSON file
Set the JSON file with the tileset data (sometimes that is embedded in the Tilemap, so not needed)

See parameters & details

Parameter 0 (👾 Object): Tile map collision mask
Parameter 1 (jsonResource): Tileset JSON file

Technical note: this action internal type (in GDevelop JSON) is TileMap::CollisionMask::SetTilesetJsonFile.

Object conditions

Tilemap JSON file
Check the Tilemap JSON file being used.

See parameters & details

Parameter 0 (👾 Object): Tile map collision mask
Parameter 1 (jsonResource): Tilemap JSON file

Technical note: this condition internal type (in GDevelop JSON) is TileMap::CollisionMask::TilemapJsonFile.

Tileset JSON file
Check the tileset JSON file being used.

See parameters & details

Parameter 0 (👾 Object): Tile map collision mask
Parameter 1 (jsonResource): Tileset JSON file

Technical note: this condition internal type (in GDevelop JSON) is TileMap::CollisionMask::TilesetJsonFile.

No expressions for this object.

Tile map

Displays a tile-based map. Recommended for most games that need to use static tiles.

Object actions

Flip tile horizontally (on the grid)
Flip tile horizontally at grid coordinates.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (🔢 Number): Grid X
Parameter 2 (🔢 Number): Grid Y
Parameter 3 (❓ Yes or No): Flip horizontally

Technical note: this action internal type (in GDevelop JSON) is TileMap::FlipTileOnXAtGridCoordinates.

Flip tile horizontally (at position)
Flip tile horizontally at scene coordinates.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (🔢 Number): Position X
Parameter 2 (🔢 Number): Position Y
Parameter 3 (❓ Yes or No): Flip horizontally

Technical note: this action internal type (in GDevelop JSON) is TileMap::FlipTileOnXAtPosition.

Flip tile vertically (on the grid)
Flip tile vertically at grid coordinates.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (🔢 Number): Grid X
Parameter 2 (🔢 Number): Grid Y
Parameter 3 (❓ Yes or No): Flip vertically

Technical note: this action internal type (in GDevelop JSON) is TileMap::FlipTileOnYAtGridCoordinates.

Flip tile vertically (at position)
Flip tile vertically at scene coordinates.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (🔢 Number): Position X
Parameter 2 (🔢 Number): Position Y
Parameter 3 (❓ Yes or No): Flip vertically

Technical note: this action internal type (in GDevelop JSON) is TileMap::FlipTileOnYAtPosition.

Remove tile (on the grid)
Remove the tile at the grid coordinates.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (🔢 Number): Grid X
Parameter 2 (🔢 Number): Grid Y

Technical note: this action internal type (in GDevelop JSON) is TileMap::RemoveTileAtGridCoordinates.

Remove tile (at position)
Remove the tile at the scene coordinates.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (🔢 Number): Position X
Parameter 2 (🔢 Number): Position Y

Technical note: this action internal type (in GDevelop JSON) is TileMap::RemoveTileAtPosition.

Grid column count
Change the grid column count in the tile map.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1: 🟰 Operator
Parameter 2 (🔢 Number): Value

Technical note: this action internal type (in GDevelop JSON) is TileMap::SimpleTileMap::SetGridColumnCount.

Grid row count
Change the grid row count in the tile map.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1: 🟰 Operator
Parameter 2 (🔢 Number): Value

Technical note: this action internal type (in GDevelop JSON) is TileMap::SimpleTileMap::SetGridRowCount.

Tile (on the grid)
Change the id of the tile at the grid coordinates.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1: 🟰 Operator
Parameter 2 (🔢 Number): Value
Parameter 3 (🔢 Number): Grid X
Parameter 4 (🔢 Number): Grid Y

Technical note: this action internal type (in GDevelop JSON) is TileMap::SimpleTileMap::SetTileIdAtGrid.

Tile (at position)
Change the id of the tile at the scene coordinates.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1: 🟰 Operator
Parameter 2 (🔢 Number): Value
Parameter 3 (🔢 Number): Position X
Parameter 4 (🔢 Number): Position Y

Technical note: this action internal type (in GDevelop JSON) is TileMap::SimpleTileMap::SetTileIdAtPosition.

Object conditions

Tile flipped horizontally (on the grid)
Check if tile at grid coordinates is flipped horizontally.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (🔢 Number): Grid X
Parameter 2 (🔢 Number): Grid Y

Technical note: this condition internal type (in GDevelop JSON) is TileMap::IsTileFlippedOnXAtGridCoordinates.

Tile flipped horizontally (at position)
Check if tile at scene coordinates is flipped horizontally.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (🔢 Number): Position X
Parameter 2 (🔢 Number): Position Y

Technical note: this condition internal type (in GDevelop JSON) is TileMap::IsTileFlippedOnXAtPosition.

Tile flipped vertically (on the grid)
Check if tile at grid coordinates is flipped vertically.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (🔢 Number): Grid X
Parameter 2 (🔢 Number): Grid Y

Technical note: this condition internal type (in GDevelop JSON) is TileMap::IsTileFlippedOnYAtGridCoordinates.

Tile flipped vertically (at position)
Check if tile at scene coordinates is flipped vertically.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (🔢 Number): Position X
Parameter 2 (🔢 Number): Position Y

Technical note: this condition internal type (in GDevelop JSON) is TileMap::IsTileFlippedOnYAtPosition.

Grid column count
Compare the grid column count in the tile map.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1: 🟰 Relational operator
Parameter 2 (🔢 Number): Value to compare

Technical note: this condition internal type (in GDevelop JSON) is TileMap::SimpleTileMap::GridColumnCount.

Grid row count
Compare the grid row count in the tile map.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1: 🟰 Relational operator
Parameter 2 (🔢 Number): Value to compare

Technical note: this condition internal type (in GDevelop JSON) is TileMap::SimpleTileMap::GridRowCount.

Tile (on the grid)
Compare the id of the tile at the grid coordinates.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1: 🟰 Relational operator
Parameter 2 (🔢 Number): Value to compare
Parameter 3 (🔢 Number): Grid X
Parameter 4 (🔢 Number): Grid Y

Technical note: this condition internal type (in GDevelop JSON) is TileMap::SimpleTileMap::TileIdAtGrid.

Tile (at position)
Compare the id of the tile at the scene coordinates.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1: 🟰 Relational operator
Parameter 2 (🔢 Number): Value to compare
Parameter 3 (🔢 Number): Position X
Parameter 4 (🔢 Number): Position Y

Technical note: this condition internal type (in GDevelop JSON) is TileMap::SimpleTileMap::TileIdAtPosition.

Object expressions

Expression	Description
`Object.GridColumnCount()`	Return the grid column count in the tile map.
`Object.GridRowCount()`	Return the grid row count in the tile map.
`Object.GridX(number, number)`	Get the grid column coordinates in the tile map corresponding to the scene coordinates.
	🔢 Number	Position X
	🔢 Number	Position Y
`Object.GridY(number, number)`	Get the grid row coordinates in the tile map corresponding to the scene coordinates.
	🔢 Number	Position X
	🔢 Number	Position Y
`Object.TileCenterX(number, number)`	Get the scene X position of the center of the tile.
	🔢 Number	Grid X
	🔢 Number	Grid Y
`Object.TileCenterY(number, number)`	Get the scene Y position of the center of the tile.
	🔢 Number	Grid X
	🔢 Number	Grid Y
`Object.TileIdAtGrid(number, number)`	Return the id of the tile at the grid coordinates.
	🔢 Number	Grid X
	🔢 Number	Grid Y
`Object.TileIdAtPosition(number, number)`	Return the id of the tile at the scene coordinates.
	🔢 Number	Position X
	🔢 Number	Position Y
`Object.TilesetColumnCount()`	Get the number of columns in the tileset.
`Object.TilesetRowCount()`	Get the number of rows in the tileset.

External Tilemap (Tiled/LDtk)

Displays a tiled-based map, made with the Tiled editor (https://www.mapeditor.org/) or the LDtk editor (https://ldtk.io/).

Object properties

Animation FPS (🔢 Number). Default value is 4.
Animation speed scale (🔢 Number). Default value is 1.
Display mode (choice, one of: "visible", "all", "index"). Default value is visible.
Layer index to display (🔢 Number). If "index" is selected as the display mode, this is the index of the layer to display. Default value is 0.
Level index to display (🔢 Number). Select which level to render via its index (LDtk). Default value is 0.
Atlas image (🗂️ Resource). The Atlas image containing the tileset.
Tilemap file (Tiled or LDtk) (🗂️ Resource). This is the file that was saved or exported from Tiled or LDtk.
Tileset JSON file (optional) (🗂️ Resource). Optional: specify this if you've saved the tileset in a different file as the Tiled tilemap.

See internal technical details

Animation FPS is stored as animationFps (number). Default value is 4.
Animation speed scale is stored as animationSpeedScale (number). Default value is 1.
Display mode is stored as displayMode (choice). Default value is visible.
Layer index to display is stored as layerIndex (number). Default value is 0.
Level index to display is stored as levelIndex (number). Default value is 0.
Atlas image is stored as tilemapAtlasImage (resource). Default value is ``.
Tilemap file (Tiled or LDtk) is stored as tilemapJsonFile (resource). Default value is ``.
Tileset JSON file (optional) is stored as tilesetJsonFile (resource). Default value is ``.

Object actions

Animation speed (FPS)
Set the animation speed of the Tilemap.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1: 🟰 Operator
Parameter 2 (🔢 Number): Animation speed (in frames per second)

Technical note: this action internal type (in GDevelop JSON) is TileMap::SetAnimationFps.

Animation speed scale
Set the animation speed scale of the Tilemap.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1: 🟰 Operator
Parameter 2 (🔢 Number): Speed scale (1 by default)

Technical note: this action internal type (in GDevelop JSON) is TileMap::SetAnimationSpeedScale.

Display mode
Set the display mode

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (🔤 String): Display mode (one of: "visible", "all", "index")

Technical note: this action internal type (in GDevelop JSON) is TileMap::SetDisplayMode.

Layer index
Set the layer index of the Tilemap.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1: 🟰 Operator
Parameter 2 (🔢 Number): Value

Technical note: this action internal type (in GDevelop JSON) is TileMap::SetLayerIndex.

Tilemap file (Tiled or LDtk)
Set the Tiled or LDtk file containing the Tilemap data to display. This is usually the main file exported from Tiled/LDtk.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (tilemapResource): Tilemap file (Tiled or LDtk)

Technical note: this action internal type (in GDevelop JSON) is TileMap::SetTilemapJsonFile.

Tileset JSON file
Set the JSON file with the tileset data (sometimes that is embedded in the Tilemap, so not needed)

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (tilesetResource): Tileset JSON file

Technical note: this action internal type (in GDevelop JSON) is TileMap::SetTilesetJsonFile.

Object conditions

Animation speed (FPS)
Compare the animation speed.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1: 🟰 Relational operator
Parameter 2 (🔢 Number): Animation speed to compare to (in frames per second)

Technical note: this condition internal type (in GDevelop JSON) is TileMap::AnimationFps.

Animation speed scale
Compare the animation speed scale.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1: 🟰 Relational operator
Parameter 2 (🔢 Number): Speed scale to compare to (1 by default)

Technical note: this condition internal type (in GDevelop JSON) is TileMap::AnimationSpeedScale.

Display mode
Compare the value of the display mode.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (🔤 String): Display mode (one of: "visible", "all", "index")

Technical note: this condition internal type (in GDevelop JSON) is TileMap::DisplayMode.

Layer index
Compare the value of the layer index.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1: 🟰 Relational operator
Parameter 2 (🔢 Number): Value to compare

Technical note: this condition internal type (in GDevelop JSON) is TileMap::LayerIndex.

Level index
Compare the level index being displayed..

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1: 🟰 Relational operator
Parameter 2 (🔢 Number): Value to compare

Technical note: this condition internal type (in GDevelop JSON) is TileMap::TileMap::LevelIndex.

Tilemap file (Tiled or LDtk)
Check the tilemap file (Tiled or LDtk) being used.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (tilemapResource): Tilemap file (Tiled or LDtk)

Technical note: this condition internal type (in GDevelop JSON) is TileMap::TilemapJsonFile.

Tileset JSON file
Check the tileset JSON file being used.

See parameters & details

Parameter 0 (👾 Object): Tile map
Parameter 1 (tilesetResource): Tileset JSON file

Technical note: this condition internal type (in GDevelop JSON) is TileMap::TilesetJsonFile.

Object expressions

Expression	Description
`Object.AnimationFps()`	Get the animation speed (in frames per second)
`Object.AnimationSpeedScale()`	Get the Animation speed scale
`Object.LayerIndex()`	Get the layer index being displayed
`Object.LevelIndex()`	Return the level index being displayed..

The Tile map extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager.

This page is an auto-generated reference page about the Tile map feature of GDevelop, the open-source, AI-powered, cross-platform game engine designed for everyone. Learn more about all GDevelop features here.