godot-docs/classes/class_tileset.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileSet.xml.

.. _class_TileSet:

TileSet
=======

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

Tile library for tilemaps.

.. rst-class:: classref-introduction-group

Description
-----------

A TileSet is a library of tiles for a :ref:`TileMap<class_TileMap>`. A TileSet handles a list of :ref:`TileSetSource<class_TileSetSource>`, each of them storing a set of tiles.

Tiles can either be from a :ref:`TileSetAtlasSource<class_TileSetAtlasSource>`, that render tiles out of a texture with support for physics, navigation, etc... or from a :ref:`TileSetScenesCollectionSource<class_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 less properties. To do so, the TileSet resources uses property layers, that you can add or remove depending on your needs.

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

See the functions to add new layers for more information.

.. rst-class:: classref-introduction-group

Tutorials
---------

- :doc:`Using Tilemaps <../tutorials/2d/using_tilemaps>`

- `2D Platformer Demo <https://godotengine.org/asset-library/asset/120>`__

- `2D Isometric Demo <https://godotengine.org/asset-library/asset/112>`__

- `2D Hexagonal Demo <https://godotengine.org/asset-library/asset/111>`__

- `2D Navigation Astar Demo <https://godotengine.org/asset-library/asset/519>`__

- `2D Role Playing Game Demo <https://godotengine.org/asset-library/asset/520>`__

- `2D Kinematic Character Demo <https://godotengine.org/asset-library/asset/113>`__

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +----------------------------------------------------+------------------------------------------------------------------+----------------------+
   | :ref:`TileLayout<enum_TileSet_TileLayout>`         | :ref:`tile_layout<class_TileSet_property_tile_layout>`           | ``0``                |
   +----------------------------------------------------+------------------------------------------------------------------+----------------------+
   | :ref:`TileOffsetAxis<enum_TileSet_TileOffsetAxis>` | :ref:`tile_offset_axis<class_TileSet_property_tile_offset_axis>` | ``0``                |
   +----------------------------------------------------+------------------------------------------------------------------+----------------------+
   | :ref:`TileShape<enum_TileSet_TileShape>`           | :ref:`tile_shape<class_TileSet_property_tile_shape>`             | ``0``                |
   +----------------------------------------------------+------------------------------------------------------------------+----------------------+
   | :ref:`Vector2i<class_Vector2i>`                    | :ref:`tile_size<class_TileSet_property_tile_size>`               | ``Vector2i(16, 16)`` |
   +----------------------------------------------------+------------------------------------------------------------------+----------------------+
   | :ref:`bool<class_bool>`                            | :ref:`uv_clipping<class_TileSet_property_uv_clipping>`           | ``false``            |
   +----------------------------------------------------+------------------------------------------------------------------+----------------------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`add_custom_data_layer<class_TileSet_method_add_custom_data_layer>` **(** :ref:`int<class_int>` to_position=-1 **)**                                                                                                                                                                                                                           |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`add_navigation_layer<class_TileSet_method_add_navigation_layer>` **(** :ref:`int<class_int>` to_position=-1 **)**                                                                                                                                                                                                                             |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`add_occlusion_layer<class_TileSet_method_add_occlusion_layer>` **(** :ref:`int<class_int>` to_position=-1 **)**                                                                                                                                                                                                                               |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`add_pattern<class_TileSet_method_add_pattern>` **(** :ref:`TileMapPattern<class_TileMapPattern>` pattern, :ref:`int<class_int>` index=-1 **)**                                                                                                                                                                                                |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`add_physics_layer<class_TileSet_method_add_physics_layer>` **(** :ref:`int<class_int>` to_position=-1 **)**                                                                                                                                                                                                                                   |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`add_source<class_TileSet_method_add_source>` **(** :ref:`TileSetSource<class_TileSetSource>` source, :ref:`int<class_int>` atlas_source_id_override=-1 **)**                                                                                                                                                                                  |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`add_terrain<class_TileSet_method_add_terrain>` **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` to_position=-1 **)**                                                                                                                                                                                                            |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`add_terrain_set<class_TileSet_method_add_terrain_set>` **(** :ref:`int<class_int>` to_position=-1 **)**                                                                                                                                                                                                                                       |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`cleanup_invalid_tile_proxies<class_TileSet_method_cleanup_invalid_tile_proxies>` **(** **)**                                                                                                                                                                                                                                                  |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`clear_tile_proxies<class_TileSet_method_clear_tile_proxies>` **(** **)**                                                                                                                                                                                                                                                                      |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Array<class_Array>`                           | :ref:`get_alternative_level_tile_proxy<class_TileSet_method_get_alternative_level_tile_proxy>` **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from, :ref:`int<class_int>` alternative_from **)**                                                                                                                   |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Array<class_Array>`                           | :ref:`get_coords_level_tile_proxy<class_TileSet_method_get_coords_level_tile_proxy>` **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from **)**                                                                                                                                                                     |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_custom_data_layer_by_name<class_TileSet_method_get_custom_data_layer_by_name>` **(** :ref:`String<class_String>` layer_name **)** |const|                                                                                                                                                                                                 |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                         | :ref:`get_custom_data_layer_name<class_TileSet_method_get_custom_data_layer_name>` **(** :ref:`int<class_int>` layer_index **)** |const|                                                                                                                                                                                                            |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`get_custom_data_layer_type<class_TileSet_method_get_custom_data_layer_type>` **(** :ref:`int<class_int>` layer_index **)** |const|                                                                                                                                                                                                            |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_custom_data_layers_count<class_TileSet_method_get_custom_data_layers_count>` **(** **)** |const|                                                                                                                                                                                                                                          |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_navigation_layer_layers<class_TileSet_method_get_navigation_layer_layers>` **(** :ref:`int<class_int>` layer_index **)** |const|                                                                                                                                                                                                          |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_navigation_layers_count<class_TileSet_method_get_navigation_layers_count>` **(** **)** |const|                                                                                                                                                                                                                                            |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_next_source_id<class_TileSet_method_get_next_source_id>` **(** **)** |const|                                                                                                                                                                                                                                                              |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_occlusion_layer_light_mask<class_TileSet_method_get_occlusion_layer_light_mask>` **(** :ref:`int<class_int>` layer_index **)** |const|                                                                                                                                                                                                    |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`get_occlusion_layer_sdf_collision<class_TileSet_method_get_occlusion_layer_sdf_collision>` **(** :ref:`int<class_int>` layer_index **)** |const|                                                                                                                                                                                              |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_occlusion_layers_count<class_TileSet_method_get_occlusion_layers_count>` **(** **)** |const|                                                                                                                                                                                                                                              |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`TileMapPattern<class_TileMapPattern>`         | :ref:`get_pattern<class_TileSet_method_get_pattern>` **(** :ref:`int<class_int>` index=-1 **)**                                                                                                                                                                                                                                                     |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_patterns_count<class_TileSet_method_get_patterns_count>` **(** **)**                                                                                                                                                                                                                                                                      |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_physics_layer_collision_layer<class_TileSet_method_get_physics_layer_collision_layer>` **(** :ref:`int<class_int>` layer_index **)** |const|                                                                                                                                                                                              |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_physics_layer_collision_mask<class_TileSet_method_get_physics_layer_collision_mask>` **(** :ref:`int<class_int>` layer_index **)** |const|                                                                                                                                                                                                |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PhysicsMaterial<class_PhysicsMaterial>`       | :ref:`get_physics_layer_physics_material<class_TileSet_method_get_physics_layer_physics_material>` **(** :ref:`int<class_int>` layer_index **)** |const|                                                                                                                                                                                            |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_physics_layers_count<class_TileSet_method_get_physics_layers_count>` **(** **)** |const|                                                                                                                                                                                                                                                  |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`TileSetSource<class_TileSetSource>`           | :ref:`get_source<class_TileSet_method_get_source>` **(** :ref:`int<class_int>` source_id **)** |const|                                                                                                                                                                                                                                              |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_source_count<class_TileSet_method_get_source_count>` **(** **)** |const|                                                                                                                                                                                                                                                                  |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_source_id<class_TileSet_method_get_source_id>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                                                                                                            |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_source_level_tile_proxy<class_TileSet_method_get_source_level_tile_proxy>` **(** :ref:`int<class_int>` source_from **)**                                                                                                                                                                                                                  |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`                           | :ref:`get_terrain_color<class_TileSet_method_get_terrain_color>` **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` terrain_index **)** |const|                                                                                                                                                                                         |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                         | :ref:`get_terrain_name<class_TileSet_method_get_terrain_name>` **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` terrain_index **)** |const|                                                                                                                                                                                           |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`TerrainMode<enum_TileSet_TerrainMode>`        | :ref:`get_terrain_set_mode<class_TileSet_method_get_terrain_set_mode>` **(** :ref:`int<class_int>` terrain_set **)** |const|                                                                                                                                                                                                                        |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_terrain_sets_count<class_TileSet_method_get_terrain_sets_count>` **(** **)** |const|                                                                                                                                                                                                                                                      |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_terrains_count<class_TileSet_method_get_terrains_count>` **(** :ref:`int<class_int>` terrain_set **)** |const|                                                                                                                                                                                                                            |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_alternative_level_tile_proxy<class_TileSet_method_has_alternative_level_tile_proxy>` **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from, :ref:`int<class_int>` alternative_from **)**                                                                                                                   |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_coords_level_tile_proxy<class_TileSet_method_has_coords_level_tile_proxy>` **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from **)**                                                                                                                                                                     |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_source<class_TileSet_method_has_source>` **(** :ref:`int<class_int>` source_id **)** |const|                                                                                                                                                                                                                                              |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_source_level_tile_proxy<class_TileSet_method_has_source_level_tile_proxy>` **(** :ref:`int<class_int>` source_from **)**                                                                                                                                                                                                                  |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Array<class_Array>`                           | :ref:`map_tile_proxy<class_TileSet_method_map_tile_proxy>` **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from, :ref:`int<class_int>` alternative_from **)** |const|                                                                                                                                               |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`move_custom_data_layer<class_TileSet_method_move_custom_data_layer>` **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` to_position **)**                                                                                                                                                                                         |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`move_navigation_layer<class_TileSet_method_move_navigation_layer>` **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` to_position **)**                                                                                                                                                                                           |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`move_occlusion_layer<class_TileSet_method_move_occlusion_layer>` **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` to_position **)**                                                                                                                                                                                             |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`move_physics_layer<class_TileSet_method_move_physics_layer>` **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` to_position **)**                                                                                                                                                                                                 |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`move_terrain<class_TileSet_method_move_terrain>` **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` terrain_index, :ref:`int<class_int>` to_position **)**                                                                                                                                                                        |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`move_terrain_set<class_TileSet_method_move_terrain_set>` **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` to_position **)**                                                                                                                                                                                                     |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_alternative_level_tile_proxy<class_TileSet_method_remove_alternative_level_tile_proxy>` **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from, :ref:`int<class_int>` alternative_from **)**                                                                                                             |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_coords_level_tile_proxy<class_TileSet_method_remove_coords_level_tile_proxy>` **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from **)**                                                                                                                                                               |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_custom_data_layer<class_TileSet_method_remove_custom_data_layer>` **(** :ref:`int<class_int>` layer_index **)**                                                                                                                                                                                                                        |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_navigation_layer<class_TileSet_method_remove_navigation_layer>` **(** :ref:`int<class_int>` layer_index **)**                                                                                                                                                                                                                          |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_occlusion_layer<class_TileSet_method_remove_occlusion_layer>` **(** :ref:`int<class_int>` layer_index **)**                                                                                                                                                                                                                            |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_pattern<class_TileSet_method_remove_pattern>` **(** :ref:`int<class_int>` index **)**                                                                                                                                                                                                                                                  |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_physics_layer<class_TileSet_method_remove_physics_layer>` **(** :ref:`int<class_int>` layer_index **)**                                                                                                                                                                                                                                |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_source<class_TileSet_method_remove_source>` **(** :ref:`int<class_int>` source_id **)**                                                                                                                                                                                                                                                |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_source_level_tile_proxy<class_TileSet_method_remove_source_level_tile_proxy>` **(** :ref:`int<class_int>` source_from **)**                                                                                                                                                                                                            |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_terrain<class_TileSet_method_remove_terrain>` **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` terrain_index **)**                                                                                                                                                                                                       |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_terrain_set<class_TileSet_method_remove_terrain_set>` **(** :ref:`int<class_int>` terrain_set **)**                                                                                                                                                                                                                                    |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_alternative_level_tile_proxy<class_TileSet_method_set_alternative_level_tile_proxy>` **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from, :ref:`int<class_int>` alternative_from, :ref:`int<class_int>` source_to, :ref:`Vector2i<class_Vector2i>` coords_to, :ref:`int<class_int>` alternative_to **)** |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_coords_level_tile_proxy<class_TileSet_method_set_coords_level_tile_proxy>` **(** :ref:`int<class_int>` p_source_from, :ref:`Vector2i<class_Vector2i>` coords_from, :ref:`int<class_int>` source_to, :ref:`Vector2i<class_Vector2i>` coords_to **)**                                                                                       |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_custom_data_layer_name<class_TileSet_method_set_custom_data_layer_name>` **(** :ref:`int<class_int>` layer_index, :ref:`String<class_String>` layer_name **)**                                                                                                                                                                            |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_custom_data_layer_type<class_TileSet_method_set_custom_data_layer_type>` **(** :ref:`int<class_int>` layer_index, :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` layer_type **)**                                                                                                                                                    |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_navigation_layer_layers<class_TileSet_method_set_navigation_layer_layers>` **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` layers **)**                                                                                                                                                                                    |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_occlusion_layer_light_mask<class_TileSet_method_set_occlusion_layer_light_mask>` **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` light_mask **)**                                                                                                                                                                          |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_occlusion_layer_sdf_collision<class_TileSet_method_set_occlusion_layer_sdf_collision>` **(** :ref:`int<class_int>` layer_index, :ref:`bool<class_bool>` sdf_collision **)**                                                                                                                                                               |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_physics_layer_collision_layer<class_TileSet_method_set_physics_layer_collision_layer>` **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` layer **)**                                                                                                                                                                         |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_physics_layer_collision_mask<class_TileSet_method_set_physics_layer_collision_mask>` **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` mask **)**                                                                                                                                                                            |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_physics_layer_physics_material<class_TileSet_method_set_physics_layer_physics_material>` **(** :ref:`int<class_int>` layer_index, :ref:`PhysicsMaterial<class_PhysicsMaterial>` physics_material **)**                                                                                                                                    |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_source_id<class_TileSet_method_set_source_id>` **(** :ref:`int<class_int>` source_id, :ref:`int<class_int>` new_source_id **)**                                                                                                                                                                                                           |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_source_level_tile_proxy<class_TileSet_method_set_source_level_tile_proxy>` **(** :ref:`int<class_int>` source_from, :ref:`int<class_int>` source_to **)**                                                                                                                                                                                 |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_terrain_color<class_TileSet_method_set_terrain_color>` **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` terrain_index, :ref:`Color<class_Color>` color **)**                                                                                                                                                                |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_terrain_name<class_TileSet_method_set_terrain_name>` **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` terrain_index, :ref:`String<class_String>` name **)**                                                                                                                                                                 |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_terrain_set_mode<class_TileSet_method_set_terrain_set_mode>` **(** :ref:`int<class_int>` terrain_set, :ref:`TerrainMode<enum_TileSet_TerrainMode>` mode **)**                                                                                                                                                                             |
   +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Enumerations
------------

.. _enum_TileSet_TileShape:

.. rst-class:: classref-enumeration

enum **TileShape**:

.. _class_TileSet_constant_TILE_SHAPE_SQUARE:

.. rst-class:: classref-enumeration-constant

:ref:`TileShape<enum_TileSet_TileShape>` **TILE_SHAPE_SQUARE** = ``0``

Rectangular tile shape.

.. _class_TileSet_constant_TILE_SHAPE_ISOMETRIC:

.. rst-class:: classref-enumeration-constant

:ref:`TileShape<enum_TileSet_TileShape>` **TILE_SHAPE_ISOMETRIC** = ``1``

Diamond tile shape (for isometric look).

\ **Note:** Isometric **TileSet** works best if :ref:`TileMap<class_TileMap>` and all its layers have Y-sort enabled.

.. _class_TileSet_constant_TILE_SHAPE_HALF_OFFSET_SQUARE:

.. rst-class:: classref-enumeration-constant

:ref:`TileShape<enum_TileSet_TileShape>` **TILE_SHAPE_HALF_OFFSET_SQUARE** = ``2``

Rectangular tile shape with one row/column out of two offset by half a tile.

.. _class_TileSet_constant_TILE_SHAPE_HEXAGON:

.. rst-class:: classref-enumeration-constant

:ref:`TileShape<enum_TileSet_TileShape>` **TILE_SHAPE_HEXAGON** = ``3``

Hexagonal tile shape.

.. rst-class:: classref-item-separator

----

.. _enum_TileSet_TileLayout:

.. rst-class:: classref-enumeration

enum **TileLayout**:

.. _class_TileSet_constant_TILE_LAYOUT_STACKED:

.. rst-class:: classref-enumeration-constant

:ref:`TileLayout<enum_TileSet_TileLayout>` **TILE_LAYOUT_STACKED** = ``0``

Tile coordinates layout where both axis stay consistent with their respective local horizontal and vertical axis.

.. _class_TileSet_constant_TILE_LAYOUT_STACKED_OFFSET:

.. rst-class:: classref-enumeration-constant

:ref:`TileLayout<enum_TileSet_TileLayout>` **TILE_LAYOUT_STACKED_OFFSET** = ``1``

Same as :ref:`TILE_LAYOUT_STACKED<class_TileSet_constant_TILE_LAYOUT_STACKED>`, but the first half-offset is negative instead of positive.

.. _class_TileSet_constant_TILE_LAYOUT_STAIRS_RIGHT:

.. rst-class:: classref-enumeration-constant

:ref:`TileLayout<enum_TileSet_TileLayout>` **TILE_LAYOUT_STAIRS_RIGHT** = ``2``

Tile coordinates layout where the horizontal axis stay horizontal, and the vertical one goes down-right.

.. _class_TileSet_constant_TILE_LAYOUT_STAIRS_DOWN:

.. rst-class:: classref-enumeration-constant

:ref:`TileLayout<enum_TileSet_TileLayout>` **TILE_LAYOUT_STAIRS_DOWN** = ``3``

Tile coordinates layout where the vertical axis stay vertical, and the horizontal one goes down-right.

.. _class_TileSet_constant_TILE_LAYOUT_DIAMOND_RIGHT:

.. rst-class:: classref-enumeration-constant

:ref:`TileLayout<enum_TileSet_TileLayout>` **TILE_LAYOUT_DIAMOND_RIGHT** = ``4``

Tile coordinates layout where the horizontal axis goes up-right, and the vertical one goes down-right.

.. _class_TileSet_constant_TILE_LAYOUT_DIAMOND_DOWN:

.. rst-class:: classref-enumeration-constant

:ref:`TileLayout<enum_TileSet_TileLayout>` **TILE_LAYOUT_DIAMOND_DOWN** = ``5``

Tile coordinates layout where the horizontal axis goes down-right, and the vertical one goes down-left.

.. rst-class:: classref-item-separator

----

.. _enum_TileSet_TileOffsetAxis:

.. rst-class:: classref-enumeration

enum **TileOffsetAxis**:

.. _class_TileSet_constant_TILE_OFFSET_AXIS_HORIZONTAL:

.. rst-class:: classref-enumeration-constant

:ref:`TileOffsetAxis<enum_TileSet_TileOffsetAxis>` **TILE_OFFSET_AXIS_HORIZONTAL** = ``0``

Horizontal half-offset.

.. _class_TileSet_constant_TILE_OFFSET_AXIS_VERTICAL:

.. rst-class:: classref-enumeration-constant

:ref:`TileOffsetAxis<enum_TileSet_TileOffsetAxis>` **TILE_OFFSET_AXIS_VERTICAL** = ``1``

Vertical half-offset.

.. rst-class:: classref-item-separator

----

.. _enum_TileSet_CellNeighbor:

.. rst-class:: classref-enumeration

enum **CellNeighbor**:

.. _class_TileSet_constant_CELL_NEIGHBOR_RIGHT_SIDE:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_RIGHT_SIDE** = ``0``

Neighbor on the right side.

.. _class_TileSet_constant_CELL_NEIGHBOR_RIGHT_CORNER:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_RIGHT_CORNER** = ``1``

Neighbor in the right corner.

.. _class_TileSet_constant_CELL_NEIGHBOR_BOTTOM_RIGHT_SIDE:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_BOTTOM_RIGHT_SIDE** = ``2``

Neighbor on the bottom right side.

.. _class_TileSet_constant_CELL_NEIGHBOR_BOTTOM_RIGHT_CORNER:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_BOTTOM_RIGHT_CORNER** = ``3``

Neighbor in the bottom right corner.

.. _class_TileSet_constant_CELL_NEIGHBOR_BOTTOM_SIDE:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_BOTTOM_SIDE** = ``4``

Neighbor on the bottom side.

.. _class_TileSet_constant_CELL_NEIGHBOR_BOTTOM_CORNER:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_BOTTOM_CORNER** = ``5``

Neighbor in the bottom corner.

.. _class_TileSet_constant_CELL_NEIGHBOR_BOTTOM_LEFT_SIDE:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_BOTTOM_LEFT_SIDE** = ``6``

Neighbor on the bottom left side.

.. _class_TileSet_constant_CELL_NEIGHBOR_BOTTOM_LEFT_CORNER:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_BOTTOM_LEFT_CORNER** = ``7``

Neighbor in the bottom left corner.

.. _class_TileSet_constant_CELL_NEIGHBOR_LEFT_SIDE:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_LEFT_SIDE** = ``8``

Neighbor on the left side.

.. _class_TileSet_constant_CELL_NEIGHBOR_LEFT_CORNER:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_LEFT_CORNER** = ``9``

Neighbor in the left corner.

.. _class_TileSet_constant_CELL_NEIGHBOR_TOP_LEFT_SIDE:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_TOP_LEFT_SIDE** = ``10``

Neighbor on the top left side.

.. _class_TileSet_constant_CELL_NEIGHBOR_TOP_LEFT_CORNER:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_TOP_LEFT_CORNER** = ``11``

Neighbor in the top left corner.

.. _class_TileSet_constant_CELL_NEIGHBOR_TOP_SIDE:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_TOP_SIDE** = ``12``

Neighbor on the top side.

.. _class_TileSet_constant_CELL_NEIGHBOR_TOP_CORNER:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_TOP_CORNER** = ``13``

Neighbor in the top corner.

.. _class_TileSet_constant_CELL_NEIGHBOR_TOP_RIGHT_SIDE:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_TOP_RIGHT_SIDE** = ``14``

Neighbor on the top right side.

.. _class_TileSet_constant_CELL_NEIGHBOR_TOP_RIGHT_CORNER:

.. rst-class:: classref-enumeration-constant

:ref:`CellNeighbor<enum_TileSet_CellNeighbor>` **CELL_NEIGHBOR_TOP_RIGHT_CORNER** = ``15``

Neighbor in the top right corner.

.. rst-class:: classref-item-separator

----

.. _enum_TileSet_TerrainMode:

.. rst-class:: classref-enumeration

enum **TerrainMode**:

.. _class_TileSet_constant_TERRAIN_MODE_MATCH_CORNERS_AND_SIDES:

.. rst-class:: classref-enumeration-constant

:ref:`TerrainMode<enum_TileSet_TerrainMode>` **TERRAIN_MODE_MATCH_CORNERS_AND_SIDES** = ``0``

Requires both corners and side to match with neighboring tiles' terrains.

.. _class_TileSet_constant_TERRAIN_MODE_MATCH_CORNERS:

.. rst-class:: classref-enumeration-constant

:ref:`TerrainMode<enum_TileSet_TerrainMode>` **TERRAIN_MODE_MATCH_CORNERS** = ``1``

Requires corners to match with neighboring tiles' terrains.

.. _class_TileSet_constant_TERRAIN_MODE_MATCH_SIDES:

.. rst-class:: classref-enumeration-constant

:ref:`TerrainMode<enum_TileSet_TerrainMode>` **TERRAIN_MODE_MATCH_SIDES** = ``2``

Requires sides to match with neighboring tiles' terrains.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_TileSet_property_tile_layout:

.. rst-class:: classref-property

:ref:`TileLayout<enum_TileSet_TileLayout>` **tile_layout** = ``0``

.. rst-class:: classref-property-setget

- void **set_tile_layout** **(** :ref:`TileLayout<enum_TileSet_TileLayout>` value **)**
- :ref:`TileLayout<enum_TileSet_TileLayout>` **get_tile_layout** **(** **)**

For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), changes the way tiles are indexed in the TileMap grid.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_property_tile_offset_axis:

.. rst-class:: classref-property

:ref:`TileOffsetAxis<enum_TileSet_TileOffsetAxis>` **tile_offset_axis** = ``0``

.. rst-class:: classref-property-setget

- void **set_tile_offset_axis** **(** :ref:`TileOffsetAxis<enum_TileSet_TileOffsetAxis>` value **)**
- :ref:`TileOffsetAxis<enum_TileSet_TileOffsetAxis>` **get_tile_offset_axis** **(** **)**

For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), determines the offset axis.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_property_tile_shape:

.. rst-class:: classref-property

:ref:`TileShape<enum_TileSet_TileShape>` **tile_shape** = ``0``

.. rst-class:: classref-property-setget

- void **set_tile_shape** **(** :ref:`TileShape<enum_TileSet_TileShape>` value **)**
- :ref:`TileShape<enum_TileSet_TileShape>` **get_tile_shape** **(** **)**

The tile shape.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_property_tile_size:

.. rst-class:: classref-property

:ref:`Vector2i<class_Vector2i>` **tile_size** = ``Vector2i(16, 16)``

.. rst-class:: classref-property-setget

- void **set_tile_size** **(** :ref:`Vector2i<class_Vector2i>` value **)**
- :ref:`Vector2i<class_Vector2i>` **get_tile_size** **(** **)**

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.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_property_uv_clipping:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **uv_clipping** = ``false``

.. rst-class:: classref-property-setget

- void **set_uv_clipping** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_uv_clipping** **(** **)**

Enables/Disable uv clipping when rendering the tiles.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_TileSet_method_add_custom_data_layer:

.. rst-class:: classref-method

void **add_custom_data_layer** **(** :ref:`int<class_int>` to_position=-1 **)**

Adds a custom data layer to the TileSet at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array.

Custom data layers allow assigning custom properties to atlas tiles.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_add_navigation_layer:

.. rst-class:: classref-method

void **add_navigation_layer** **(** :ref:`int<class_int>` to_position=-1 **)**

Adds a navigation layer to the TileSet at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array.

Navigation layers allow assigning a navigable area to atlas tiles.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_add_occlusion_layer:

.. rst-class:: classref-method

void **add_occlusion_layer** **(** :ref:`int<class_int>` to_position=-1 **)**

Adds an occlusion layer to the TileSet at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array.

Occlusion layers allow assigning occlusion polygons to atlas tiles.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_add_pattern:

.. rst-class:: classref-method

:ref:`int<class_int>` **add_pattern** **(** :ref:`TileMapPattern<class_TileMapPattern>` pattern, :ref:`int<class_int>` index=-1 **)**

Adds a :ref:`TileMapPattern<class_TileMapPattern>` to be stored in the TileSet resource. If provided, insert it at the given ``index``.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_add_physics_layer:

.. rst-class:: classref-method

void **add_physics_layer** **(** :ref:`int<class_int>` to_position=-1 **)**

Adds a physics layer to the TileSet at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array.

Physics layers allow assigning collision polygons to atlas tiles.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_add_source:

.. rst-class:: classref-method

:ref:`int<class_int>` **add_source** **(** :ref:`TileSetSource<class_TileSetSource>` source, :ref:`int<class_int>` atlas_source_id_override=-1 **)**

Adds a :ref:`TileSetSource<class_TileSetSource>` to the TileSet. If ``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 source ID or -1 if the source could not be added.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_add_terrain:

.. rst-class:: classref-method

void **add_terrain** **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` to_position=-1 **)**

Adds a new terrain to the given terrain set ``terrain_set`` at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_add_terrain_set:

.. rst-class:: classref-method

void **add_terrain_set** **(** :ref:`int<class_int>` to_position=-1 **)**

Adds a new terrain set at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_cleanup_invalid_tile_proxies:

.. rst-class:: classref-method

void **cleanup_invalid_tile_proxies** **(** **)**

Clears tile proxies pointing to invalid tiles.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_clear_tile_proxies:

.. rst-class:: classref-method

void **clear_tile_proxies** **(** **)**

Clears all tile proxies.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_alternative_level_tile_proxy:

.. rst-class:: classref-method

:ref:`Array<class_Array>` **get_alternative_level_tile_proxy** **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from, :ref:`int<class_int>` alternative_from **)**

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.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_coords_level_tile_proxy:

.. rst-class:: classref-method

:ref:`Array<class_Array>` **get_coords_level_tile_proxy** **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from **)**

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.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_custom_data_layer_by_name:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_custom_data_layer_by_name** **(** :ref:`String<class_String>` layer_name **)** |const|

Returns the index of the custom data layer identified by the given name.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_custom_data_layer_name:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_custom_data_layer_name** **(** :ref:`int<class_int>` layer_index **)** |const|

Returns the name of the custom data layer identified by the given index.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_custom_data_layer_type:

.. rst-class:: classref-method

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **get_custom_data_layer_type** **(** :ref:`int<class_int>` layer_index **)** |const|

Returns the type of the custom data layer identified by the given index.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_custom_data_layers_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_custom_data_layers_count** **(** **)** |const|

Returns the custom data layers count.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_navigation_layer_layers:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_navigation_layer_layers** **(** :ref:`int<class_int>` layer_index **)** |const|

Returns the navigation layers (as in the Navigation server) of the gives TileSet navigation layer.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_navigation_layers_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_navigation_layers_count** **(** **)** |const|

Returns the navigation layers count.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_next_source_id:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_next_source_id** **(** **)** |const|

Returns a new unused source ID. This generated ID is the same that a call to ``add_source`` would return.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_occlusion_layer_light_mask:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_occlusion_layer_light_mask** **(** :ref:`int<class_int>` layer_index **)** |const|

Returns the light mask of the occlusion layer.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_occlusion_layer_sdf_collision:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **get_occlusion_layer_sdf_collision** **(** :ref:`int<class_int>` layer_index **)** |const|

Returns if the occluders from this layer use ``sdf_collision``.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_occlusion_layers_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_occlusion_layers_count** **(** **)** |const|

Returns the occlusion layers count.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_pattern:

.. rst-class:: classref-method

:ref:`TileMapPattern<class_TileMapPattern>` **get_pattern** **(** :ref:`int<class_int>` index=-1 **)**

Returns the :ref:`TileMapPattern<class_TileMapPattern>` at the given ``index``.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_patterns_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_patterns_count** **(** **)**

Returns the number of :ref:`TileMapPattern<class_TileMapPattern>` this tile set handles.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_physics_layer_collision_layer:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_physics_layer_collision_layer** **(** :ref:`int<class_int>` layer_index **)** |const|

Returns the collision layer (as in the physics server) bodies on the given TileSet's physics layer are in.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_physics_layer_collision_mask:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_physics_layer_collision_mask** **(** :ref:`int<class_int>` layer_index **)** |const|

Returns the collision mask of bodies on the given TileSet's physics layer.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_physics_layer_physics_material:

.. rst-class:: classref-method

:ref:`PhysicsMaterial<class_PhysicsMaterial>` **get_physics_layer_physics_material** **(** :ref:`int<class_int>` layer_index **)** |const|

Returns the physics material of bodies on the given TileSet's physics layer.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_physics_layers_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_physics_layers_count** **(** **)** |const|

Returns the physics layers count.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_source:

.. rst-class:: classref-method

:ref:`TileSetSource<class_TileSetSource>` **get_source** **(** :ref:`int<class_int>` source_id **)** |const|

Returns the :ref:`TileSetSource<class_TileSetSource>` with ID ``source_id``.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_source_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_source_count** **(** **)** |const|

Returns the number of :ref:`TileSetSource<class_TileSetSource>` in this TileSet.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_source_id:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_source_id** **(** :ref:`int<class_int>` index **)** |const|

Returns the source ID for source with index ``index``.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_source_level_tile_proxy:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_source_level_tile_proxy** **(** :ref:`int<class_int>` source_from **)**

Returns the source-level proxy for the given source identifier.

If the TileSet has no proxy for the given identifier, returns -1.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_terrain_color:

.. rst-class:: classref-method

:ref:`Color<class_Color>` **get_terrain_color** **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` terrain_index **)** |const|

Returns a terrain's color.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_terrain_name:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_terrain_name** **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` terrain_index **)** |const|

Returns a terrain's name.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_terrain_set_mode:

.. rst-class:: classref-method

:ref:`TerrainMode<enum_TileSet_TerrainMode>` **get_terrain_set_mode** **(** :ref:`int<class_int>` terrain_set **)** |const|

Returns a terrain set mode.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_terrain_sets_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_terrain_sets_count** **(** **)** |const|

Returns the terrain sets count.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_get_terrains_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_terrains_count** **(** :ref:`int<class_int>` terrain_set **)** |const|

Returns the number of terrains in the given terrain set.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_has_alternative_level_tile_proxy:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_alternative_level_tile_proxy** **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from, :ref:`int<class_int>` alternative_from **)**

Returns if there is and alternative-level proxy for the given identifiers.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_has_coords_level_tile_proxy:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_coords_level_tile_proxy** **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from **)**

Returns if there is a coodinates-level proxy for the given identifiers.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_has_source:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_source** **(** :ref:`int<class_int>` source_id **)** |const|

Returns if this TileSet has a source for the given source ID.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_has_source_level_tile_proxy:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_source_level_tile_proxy** **(** :ref:`int<class_int>` source_from **)**

Returns if there is a source-level proxy for the given source ID.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_map_tile_proxy:

.. rst-class:: classref-method

:ref:`Array<class_Array>` **map_tile_proxy** **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from, :ref:`int<class_int>` alternative_from **)** |const|

According to the configured proxies, maps the provided indentifiers 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.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_move_custom_data_layer:

.. rst-class:: classref-method

void **move_custom_data_layer** **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` to_position **)**

Moves the custom data layer at index ``layer_index`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_move_navigation_layer:

.. rst-class:: classref-method

void **move_navigation_layer** **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` to_position **)**

Moves the navigation layer at index ``layer_index`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_move_occlusion_layer:

.. rst-class:: classref-method

void **move_occlusion_layer** **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` to_position **)**

Moves the occlusion layer at index ``layer_index`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_move_physics_layer:

.. rst-class:: classref-method

void **move_physics_layer** **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` to_position **)**

Moves the physics layer at index ``layer_index`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_move_terrain:

.. rst-class:: classref-method

void **move_terrain** **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` terrain_index, :ref:`int<class_int>` to_position **)**

Moves the terrain at index ``terrain_index`` for terrain set ``terrain_set`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_move_terrain_set:

.. rst-class:: classref-method

void **move_terrain_set** **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` to_position **)**

Moves the terrain set at index ``terrain_set`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_remove_alternative_level_tile_proxy:

.. rst-class:: classref-method

void **remove_alternative_level_tile_proxy** **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from, :ref:`int<class_int>` alternative_from **)**

Removes an alternative-level proxy for the given identifiers.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_remove_coords_level_tile_proxy:

.. rst-class:: classref-method

void **remove_coords_level_tile_proxy** **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from **)**

Removes a coordinates-level proxy for the given identifiers.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_remove_custom_data_layer:

.. rst-class:: classref-method

void **remove_custom_data_layer** **(** :ref:`int<class_int>` layer_index **)**

Removes the custom data layer at index ``layer_index``. Also updates the atlas tiles accordingly.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_remove_navigation_layer:

.. rst-class:: classref-method

void **remove_navigation_layer** **(** :ref:`int<class_int>` layer_index **)**

Removes the navigation layer at index ``layer_index``. Also updates the atlas tiles accordingly.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_remove_occlusion_layer:

.. rst-class:: classref-method

void **remove_occlusion_layer** **(** :ref:`int<class_int>` layer_index **)**

Removes the occlusion layer at index ``layer_index``. Also updates the atlas tiles accordingly.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_remove_pattern:

.. rst-class:: classref-method

void **remove_pattern** **(** :ref:`int<class_int>` index **)**

Remove the :ref:`TileMapPattern<class_TileMapPattern>` at the given index.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_remove_physics_layer:

.. rst-class:: classref-method

void **remove_physics_layer** **(** :ref:`int<class_int>` layer_index **)**

Removes the physics layer at index ``layer_index``. Also updates the atlas tiles accordingly.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_remove_source:

.. rst-class:: classref-method

void **remove_source** **(** :ref:`int<class_int>` source_id **)**

Removes the source with the given source ID.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_remove_source_level_tile_proxy:

.. rst-class:: classref-method

void **remove_source_level_tile_proxy** **(** :ref:`int<class_int>` source_from **)**

Removes a source-level tile proxy.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_remove_terrain:

.. rst-class:: classref-method

void **remove_terrain** **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` terrain_index **)**

Removes the terrain at index ``terrain_index`` in the given terrain set ``terrain_set``. Also updates the atlas tiles accordingly.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_remove_terrain_set:

.. rst-class:: classref-method

void **remove_terrain_set** **(** :ref:`int<class_int>` terrain_set **)**

Removes the terrain set at index ``terrain_set``. Also updates the atlas tiles accordingly.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_set_alternative_level_tile_proxy:

.. rst-class:: classref-method

void **set_alternative_level_tile_proxy** **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from, :ref:`int<class_int>` alternative_from, :ref:`int<class_int>` source_to, :ref:`Vector2i<class_Vector2i>` coords_to, :ref:`int<class_int>` alternative_to **)**

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.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_set_coords_level_tile_proxy:

.. rst-class:: classref-method

void **set_coords_level_tile_proxy** **(** :ref:`int<class_int>` p_source_from, :ref:`Vector2i<class_Vector2i>` coords_from, :ref:`int<class_int>` source_to, :ref:`Vector2i<class_Vector2i>` coords_to **)**

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.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_set_custom_data_layer_name:

.. rst-class:: classref-method

void **set_custom_data_layer_name** **(** :ref:`int<class_int>` layer_index, :ref:`String<class_String>` layer_name **)**

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.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_set_custom_data_layer_type:

.. rst-class:: classref-method

void **set_custom_data_layer_type** **(** :ref:`int<class_int>` layer_index, :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` layer_type **)**

Sets the type of the custom data layer identified by the given index.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_set_navigation_layer_layers:

.. rst-class:: classref-method

void **set_navigation_layer_layers** **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` layers **)**

Sets the navigation layers (as in the navigation server) for navigation regions is the given TileSet navigation layer.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_set_occlusion_layer_light_mask:

.. rst-class:: classref-method

void **set_occlusion_layer_light_mask** **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` light_mask **)**

Sets the occlusion layer (as in the rendering server) for occluders in the given TileSet occlusion layer.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_set_occlusion_layer_sdf_collision:

.. rst-class:: classref-method

void **set_occlusion_layer_sdf_collision** **(** :ref:`int<class_int>` layer_index, :ref:`bool<class_bool>` sdf_collision **)**

Enables or disables sdf collision for occluders in the given TileSet occlusion layer.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_set_physics_layer_collision_layer:

.. rst-class:: classref-method

void **set_physics_layer_collision_layer** **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` layer **)**

Sets the physics layer (as in the physics server) for bodies in the given TileSet physics layer.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_set_physics_layer_collision_mask:

.. rst-class:: classref-method

void **set_physics_layer_collision_mask** **(** :ref:`int<class_int>` layer_index, :ref:`int<class_int>` mask **)**

Sets the physics layer (as in the physics server) for bodies in the given TileSet physics layer.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_set_physics_layer_physics_material:

.. rst-class:: classref-method

void **set_physics_layer_physics_material** **(** :ref:`int<class_int>` layer_index, :ref:`PhysicsMaterial<class_PhysicsMaterial>` physics_material **)**

Sets the physics material for bodies in the given TileSet physics layer.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_set_source_id:

.. rst-class:: classref-method

void **set_source_id** **(** :ref:`int<class_int>` source_id, :ref:`int<class_int>` new_source_id **)**

Changes a source's ID.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_set_source_level_tile_proxy:

.. rst-class:: classref-method

void **set_source_level_tile_proxy** **(** :ref:`int<class_int>` source_from, :ref:`int<class_int>` source_to **)**

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 atlac 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.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_set_terrain_color:

.. rst-class:: classref-method

void **set_terrain_color** **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` terrain_index, :ref:`Color<class_Color>` color **)**

Sets a terrain's color. This color is used for identifying the different terrains in the TileSet editor.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_set_terrain_name:

.. rst-class:: classref-method

void **set_terrain_name** **(** :ref:`int<class_int>` terrain_set, :ref:`int<class_int>` terrain_index, :ref:`String<class_String>` name **)**

Sets a terrain's name.

.. rst-class:: classref-item-separator

----

.. _class_TileSet_method_set_terrain_set_mode:

.. rst-class:: classref-method

void **set_terrain_set_mode** **(** :ref:`int<class_int>` terrain_set, :ref:`TerrainMode<enum_TileSet_TerrainMode>` mode **)**

Sets a terrain mode. Each mode determines which bits of a tile shape is used to match the neighbouring tiles' terrains.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`