Tile library for tilemaps.
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.
$DOCS_URL/tutorials/2d/using_tilemaps.html https://godotengine.org/asset-library/asset/120 https://godotengine.org/asset-library/asset/112 https://godotengine.org/asset-library/asset/111 https://godotengine.org/asset-library/asset/519 https://godotengine.org/asset-library/asset/520 https://godotengine.org/asset-library/asset/113
Adds a custom data layer to the TileSet at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array. Custom data layers allow assigning custom properties to atlas tiles.
Adds a navigation layer to the TileSet at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array. Navigation layers allow assigning a navigable area to atlas tiles.
Adds an occlusion layer to the TileSet at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array. Occlusion layers allow assigning occlusion polygons to atlas tiles.
Adds a [TileMapPattern] to be stored in the TileSet resource. If provided, insert it at the given [param index].
Adds a physics layer to the TileSet at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array. Physics layers allow assigning collision polygons to atlas tiles.
Adds a [TileSetSource] to the TileSet. If [param atlas_source_id_override] is not -1, also set its source ID. Otherwise, a unique identifier is automatically generated. The function returns the added source ID or -1 if the source could not be added. [b]Warning:[/b] A source cannot belong to two TileSets at the same time. If the added source was attached to another [TileSet], it will be removed from that one.
Adds a new terrain to the given terrain set [param terrain_set] at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array.
Adds a new terrain set at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array.
Clears tile proxies pointing to invalid tiles.
Clears all tile proxies.
Returns the alternative-level proxy for the given identifiers. The returned array contains the three proxie's target identifiers (source ID, atlas coords ID and alternative tile ID). If the TileSet has no proxy for the given identifiers, returns an empty Array.
Returns the coordinate-level proxy for the given identifiers. The returned array contains the two target identifiers of the proxy (source ID and atlas coordinates ID). If the TileSet has no proxy for the given identifiers, returns an empty Array.
Returns the index of the custom data layer identified by the given name.
Returns the name of the custom data layer identified by the given index.
Returns the type of the custom data layer identified by the given index.
Returns the custom data layers count.
Returns whether or not the specified navigation layer of the TileSet navigation data layer identified by the given [param layer_index] is enabled, given a navigation_layers [param layer_number] between 1 and 32.
Returns the navigation layers (as in the Navigation server) of the given TileSet navigation layer.
Returns the navigation layers count.
Returns a new unused source ID. This generated ID is the same that a call to [code]add_source[/code] would return.
Returns the light mask of the occlusion layer.
Returns if the occluders from this layer use [code]sdf_collision[/code].
Returns the occlusion layers count.
Returns the [TileMapPattern] at the given [param index].
Returns the number of [TileMapPattern] this tile set handles.
Returns the collision layer (as in the physics server) bodies on the given TileSet's physics layer are in.
Returns the collision mask of bodies on the given TileSet's physics layer.
Returns the physics material of bodies on the given TileSet's physics layer.
Returns the physics layers count.
Returns the [TileSetSource] with ID [param source_id].
Returns the number of [TileSetSource] in this TileSet.
Returns the source ID for source with index [param index].
Returns the source-level proxy for the given source identifier. If the TileSet has no proxy for the given identifier, returns -1.
Returns a terrain's color.
Returns a terrain's name.
Returns a terrain set mode.
Returns the terrain sets count.
Returns the number of terrains in the given terrain set.
Returns if there is an alternative-level proxy for the given identifiers.
Returns if there is a coodinates-level proxy for the given identifiers.
Returns if this TileSet has a source for the given source ID.
Returns if there is a source-level proxy for the given source ID.
According to the configured proxies, maps the provided identifiers to a new set of identifiers. The source ID, atlas coordinates ID and alternative tile ID are returned as a 3 elements Array. This function first look for matching alternative-level proxies, then coordinates-level proxies, then source-level proxies. If no proxy corresponding to provided identifiers are found, returns the same values the ones used as arguments.
Moves the custom data layer at index [param layer_index] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
Moves the navigation layer at index [param layer_index] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
Moves the occlusion layer at index [param layer_index] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
Moves the physics layer at index [param layer_index] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
Moves the terrain at index [param terrain_index] for terrain set [param terrain_set] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
Moves the terrain set at index [param terrain_set] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
Removes an alternative-level proxy for the given identifiers.
Removes a coordinates-level proxy for the given identifiers.
Removes the custom data layer at index [param layer_index]. Also updates the atlas tiles accordingly.
Removes the navigation layer at index [param layer_index]. Also updates the atlas tiles accordingly.
Removes the occlusion layer at index [param layer_index]. Also updates the atlas tiles accordingly.
Remove the [TileMapPattern] at the given index.
Removes the physics layer at index [param layer_index]. Also updates the atlas tiles accordingly.
Removes the source with the given source ID.
Removes a source-level tile proxy.
Removes the terrain at index [param terrain_index] in the given terrain set [param terrain_set]. Also updates the atlas tiles accordingly.
Removes the terrain set at index [param terrain_set]. Also updates the atlas tiles accordingly.
Create an alternative-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. This can be used to replace a tile in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target tile when one is available. Proxied tiles can be automatically replaced in TileMap nodes using the editor.
Creates a coordinates-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. The alternative tile ID is kept the same when using coordinates-level proxies. This can be used to replace a tile in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target tile when one is available. Proxied tiles can be automatically replaced in TileMap nodes using the editor.
Sets the name of the custom data layer identified by the given index. Names are identifiers of the layer therefore if the name is already taken it will fail and raise an error.
Sets the type of the custom data layer identified by the given index.
Based on [param value], enables or disables the specified navigation layer of the TileSet navigation data layer identified by the given [param layer_index], given a navigation_layers [param layer_number] between 1 and 32.
Sets the navigation layers (as in the navigation server) for navigation regions in the given TileSet navigation layer.
Sets the occlusion layer (as in the rendering server) for occluders in the given TileSet occlusion layer.
Enables or disables SDF collision for occluders in the given TileSet occlusion layer.
Sets the physics layer (as in the physics server) for bodies in the given TileSet physics layer.
Sets the physics layer (as in the physics server) for bodies in the given TileSet physics layer.
Sets the physics material for bodies in the given TileSet physics layer.
Changes a source's ID.
Creates a source-level proxy for the given source ID. A proxy will map set of tile identifiers to another set of identifiers. Both the atlas coordinates ID and the alternative tile ID are kept the same when using source-level proxies. This can be used to replace a source in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target source when one is available. Proxied tiles can be automatically replaced in TileMap nodes using the editor.
Sets a terrain's color. This color is used for identifying the different terrains in the TileSet editor.
Sets a terrain's name.
Sets a terrain mode. Each mode determines which bits of a tile shape is used to match the neighboring tiles' terrains.
- For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), changes the way tiles are indexed in the TileMap grid.
- For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), determines the offset axis.
- The tile shape.
- The tile size, in pixels. For all tile shapes, this size corresponds to the encompassing rectangle of the tile shape. This is thus the minimal cell size required in an atlas.
- Enables/Disable uv clipping when rendering the tiles.
Rectangular tile shape.
Diamond tile shape (for isometric look). [b]Note:[/b] Isometric [TileSet] works best if [TileMap] and all its layers have Y-sort enabled.
Rectangular tile shape with one row/column out of two offset by half a tile.
Hexagonal tile shape.
Tile coordinates layout where both axis stay consistent with their respective local horizontal and vertical axis.
Same as [constant TILE_LAYOUT_STACKED], but the first half-offset is negative instead of positive.
Tile coordinates layout where the horizontal axis stay horizontal, and the vertical one goes down-right.
Tile coordinates layout where the vertical axis stay vertical, and the horizontal one goes down-right.
Tile coordinates layout where the horizontal axis goes up-right, and the vertical one goes down-right.
Tile coordinates layout where the horizontal axis goes down-right, and the vertical one goes down-left.
Horizontal half-offset.
Vertical half-offset.
Neighbor on the right side.
Neighbor in the right corner.
Neighbor on the bottom right side.
Neighbor in the bottom right corner.
Neighbor on the bottom side.
Neighbor in the bottom corner.
Neighbor on the bottom left side.
Neighbor in the bottom left corner.
Neighbor on the left side.
Neighbor in the left corner.
Neighbor on the top left side.
Neighbor in the top left corner.
Neighbor on the top side.
Neighbor in the top corner.
Neighbor on the top right side.
Neighbor in the top right corner.
Requires both corners and side to match with neighboring tiles' terrains.
Requires corners to match with neighboring tiles' terrains.
Requires sides to match with neighboring tiles' terrains.