Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

TileMap

Inherits: Node2D < CanvasItem < Node < Object

Node for 2D tile-based maps.

Description

Node for 2D tile-based maps. Tilemaps use a TileSet which contain a list of tiles which are used to create grid-based maps. A TileMap may have several layers, layouting tiles on top of each other.

For performance reasons, all TileMap updates are batched at the end of a frame. Notably, this means that scene tiles from a TileSetScenesCollectionSource may be initialized after their parent. This is only queued when inside the scene tree.

To force an update earlier on, call update_internals.

Tutorials

• Using Tilemaps

• 2D Platformer Demo

• 2D Isometric Demo

• 2D Hexagonal Demo

• 2D Navigation Astar Demo

• 2D Role Playing Game Demo

• 2D Kinematic Character Demo

Properties

bool	collision_animatable	false
VisibilityMode	collision_visibility_mode	0
VisibilityMode	navigation_visibility_mode	0
int	rendering_quadrant_size	16
TileSet	tile_set

Methods

void	_tile_data_runtime_update ( int layer, Vector2i coords, TileData tile_data ) virtual
bool	_use_tile_data_runtime_update ( int layer, Vector2i coords ) virtual
void	add_layer ( int to_position )
void	clear ( )
void	clear_layer ( int layer )
void	erase_cell ( int layer, Vector2i coords )
void	fix_invalid_tiles ( )
void	force_update ( int layer=-1 )
int	get_cell_alternative_tile ( int layer, Vector2i coords, bool use_proxies=false ) const
Vector2i	get_cell_atlas_coords ( int layer, Vector2i coords, bool use_proxies=false ) const
int	get_cell_source_id ( int layer, Vector2i coords, bool use_proxies=false ) const
TileData	get_cell_tile_data ( int layer, Vector2i coords, bool use_proxies=false ) const
Vector2i	get_coords_for_body_rid ( RID body )
int	get_layer_for_body_rid ( RID body )
Color	get_layer_modulate ( int layer ) const
String	get_layer_name ( int layer ) const
RID	get_layer_navigation_map ( int layer ) const
int	get_layer_y_sort_origin ( int layer ) const
int	get_layer_z_index ( int layer ) const
int	get_layers_count ( ) const
RID	get_navigation_map ( int layer ) const
Vector2i	get_neighbor_cell ( Vector2i coords, CellNeighbor neighbor ) const
TileMapPattern	get_pattern ( int layer, Vector2i[] coords_array )
Vector2i[]	get_surrounding_cells ( Vector2i coords )
Vector2i[]	get_used_cells ( int layer ) const
Vector2i[]	get_used_cells_by_id ( int layer, int source_id=-1, Vector2i atlas_coords=Vector2i(-1, -1), int alternative_tile=-1 ) const
Rect2i	get_used_rect ( ) const
bool	is_layer_enabled ( int layer ) const
bool	is_layer_navigation_enabled ( int layer ) const
bool	is_layer_y_sort_enabled ( int layer ) const
Vector2i	local_to_map ( Vector2 local_position ) const
Vector2i	map_pattern ( Vector2i position_in_tilemap, Vector2i coords_in_pattern, TileMapPattern pattern )
Vector2	map_to_local ( Vector2i map_position ) const
void	move_layer ( int layer, int to_position )
void	notify_runtime_tile_data_update ( int layer=-1 )
void	remove_layer ( int layer )
void	set_cell ( int layer, Vector2i coords, int source_id=-1, Vector2i atlas_coords=Vector2i(-1, -1), int alternative_tile=0 )
void	set_cells_terrain_connect ( int layer, Vector2i[] cells, int terrain_set, int terrain, bool ignore_empty_terrains=true )
void	set_cells_terrain_path ( int layer, Vector2i[] path, int terrain_set, int terrain, bool ignore_empty_terrains=true )
void	set_layer_enabled ( int layer, bool enabled )
void	set_layer_modulate ( int layer, Color modulate )
void	set_layer_name ( int layer, String name )
void	set_layer_navigation_enabled ( int layer, bool enabled )
void