Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

TileSet

Inherits: Resource < RefCounted < Object

Tile library for tilemaps.

Description

A TileSet is a library of tiles for a TileMap. A TileSet handles a list of TileSetSource, each of them storing a set of tiles.

Tiles can either be from a TileSetAtlasSource, which renders tiles out of a texture with support for physics, navigation, etc., or from a TileSetScenesCollectionSource, which exposes scene-based tiles.

Tiles are referenced by using three IDs: their source ID, their atlas coordinates ID, and their alternative tile ID.

A TileSet can be configured so that its tiles expose more or fewer properties. To do so, the TileSet resources use property layers, which you can add or remove depending on your needs.

For example, adding a physics layer allows giving collision shapes to your tiles. Each layer has dedicated properties (physics layer and mask), so you may add several TileSet physics layers for each type of collision you need.

See the functions to add new layers for more information.

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

TileLayout	tile_layout	0
TileOffsetAxis	tile_offset_axis	0
TileShape	tile_shape	0
Vector2i	tile_size	Vector2i(16, 16)
bool	uv_clipping	false

Methods

void	add_custom_data_layer ( int to_position=-1 )
void	add_navigation_layer ( int to_position=-1 )
void	add_occlusion_layer ( int to_position=-1 )
int	add_pattern ( TileMapPattern pattern, int index=-1 )
void	add_physics_layer ( int to_position=-1 )
int	add_source ( TileSetSource source, int atlas_source_id_override=-1 )
void	add_terrain (