:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TileSet.xml. .. _class_TileSet: TileSet ======= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Tile library for tilemaps. .. rst-class:: classref-introduction-group Description ----------- A TileSet is a library of tiles for a :ref:`TileMap`. It contains a list of tiles, each consisting of a sprite and optional collision shapes. Tiles are referenced by a unique integer ID. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Using Tilemaps <../tutorials/2d/using_tilemaps>` - `2D Platformer Demo `__ - `2D Isometric Demo `__ - `2D Hexagonal Demo `__ - `2D Navigation Astar Demo `__ - `2D Role Playing Game Demo `__ - `2D Kinematic Character Demo `__ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`_forward_atlas_subtile_selection` **(** :ref:`int` atlastile_id, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`_forward_subtile_selection` **(** :ref:`int` autotile_id, :ref:`int` bitmask, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_tile_bound` **(** :ref:`int` drawn_id, :ref:`int` neighbor_id **)** |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`autotile_clear_bitmask_map` **(** :ref:`int` id **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`autotile_get_bitmask` **(** :ref:`int` id, :ref:`Vector2` coord **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`BitmaskMode` | :ref:`autotile_get_bitmask_mode` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`FallbackMode` | :ref:`autotile_get_fallback_mode` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`autotile_get_icon_coordinate` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`OccluderPolygon2D` | :ref:`autotile_get_light_occluder` **(** :ref:`int` id, :ref:`Vector2` coord **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NavigationPolygon` | :ref:`autotile_get_navigation_polygon` **(** :ref:`int` id, :ref:`Vector2` coord **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`autotile_get_size` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`autotile_get_spacing` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`autotile_get_subtile_priority` **(** :ref:`int` id, :ref:`Vector2` coord **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`autotile_get_z_index` **(** :ref:`int` id, :ref:`Vector2` coord **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`autotile_set_bitmask` **(** :ref:`int` id, :ref:`Vector2` bitmask, :ref:`int` flag **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`autotile_set_bitmask_mode` **(** :ref:`int` id, :ref:`BitmaskMode` mode **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`autotile_set_fallback_mode` **(** :ref:`int` id, :ref:`FallbackMode` mode **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`autotile_set_icon_coordinate` **(** :ref:`int` id, :ref:`Vector2` coord **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`autotile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder, :ref:`Vector2` coord **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`autotile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon, :ref:`Vector2` coord **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`autotile_set_size` **(** :ref:`int` id, :ref:`Vector2` size **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`autotile_set_spacing` **(** :ref:`int` id, :ref:`int` spacing **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`autotile_set_subtile_priority` **(** :ref:`int` id, :ref:`Vector2` coord, :ref:`int` priority **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`autotile_set_z_index` **(** :ref:`int` id, :ref:`Vector2` coord, :ref:`int` z_index **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_tile` **(** :ref:`int` id **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_tiles_ids` **(** **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_tile` **(** :ref:`int` id **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_add_shape` **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`tile_get_modulate` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id, :ref:`int` shape_id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`tile_get_shape_count` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`tile_get_shape_offset` **(** :ref:`int` id, :ref:`int` shape_id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`tile_get_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tile_get_shape_one_way_margin` **(** :ref:`int` id, :ref:`int` shape_id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`tile_get_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TileMode` | :ref:`tile_get_tile_mode` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`tile_get_z_index` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_modulate` **(** :ref:`int` id, :ref:`Color` color **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture` normal_map **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_shape_offset` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Vector2` shape_offset **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_shape_one_way_margin` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`float` one_way **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_tile_mode` **(** :ref:`int` id, :ref:`TileMode` tilemode **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_z_index` **(** :ref:`int` id, :ref:`int` z_index **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_TileSet_BitmaskMode: .. rst-class:: classref-enumeration enum **BitmaskMode**: .. _class_TileSet_constant_BITMASK_2X2: .. rst-class:: classref-enumeration-constant :ref:`BitmaskMode` **BITMASK_2X2** = ``0`` .. _class_TileSet_constant_BITMASK_3X3_MINIMAL: .. rst-class:: classref-enumeration-constant :ref:`BitmaskMode` **BITMASK_3X3_MINIMAL** = ``1`` .. _class_TileSet_constant_BITMASK_3X3: .. rst-class:: classref-enumeration-constant :ref:`BitmaskMode` **BITMASK_3X3** = ``2`` .. rst-class:: classref-item-separator ---- .. _enum_TileSet_FallbackMode: .. rst-class:: classref-enumeration enum **FallbackMode**: .. _class_TileSet_constant_FALLBACK_AUTO: .. rst-class:: classref-enumeration-constant :ref:`FallbackMode` **FALLBACK_AUTO** = ``0`` Autotiles will automatically find a best match for missing tiles if they're incomplete. .. _class_TileSet_constant_FALLBACK_ICON: .. rst-class:: classref-enumeration-constant :ref:`FallbackMode` **FALLBACK_ICON** = ``1`` Autotiles will use the icon tile for missing tiles if they're incomplete. .. rst-class:: classref-item-separator ---- .. _enum_TileSet_AutotileBindings: .. rst-class:: classref-enumeration enum **AutotileBindings**: .. _class_TileSet_constant_BIND_TOPLEFT: .. rst-class:: classref-enumeration-constant :ref:`AutotileBindings` **BIND_TOPLEFT** = ``1`` .. _class_TileSet_constant_BIND_TOP: .. rst-class:: classref-enumeration-constant :ref:`AutotileBindings` **BIND_TOP** = ``2`` .. _class_TileSet_constant_BIND_TOPRIGHT: .. rst-class:: classref-enumeration-constant :ref:`AutotileBindings` **BIND_TOPRIGHT** = ``4`` .. _class_TileSet_constant_BIND_LEFT: .. rst-class:: classref-enumeration-constant :ref:`AutotileBindings` **BIND_LEFT** = ``8`` .. _class_TileSet_constant_BIND_CENTER: .. rst-class:: classref-enumeration-constant :ref:`AutotileBindings` **BIND_CENTER** = ``16`` .. _class_TileSet_constant_BIND_RIGHT: .. rst-class:: classref-enumeration-constant :ref:`AutotileBindings` **BIND_RIGHT** = ``32`` .. _class_TileSet_constant_BIND_BOTTOMLEFT: .. rst-class:: classref-enumeration-constant :ref:`AutotileBindings` **BIND_BOTTOMLEFT** = ``64`` .. _class_TileSet_constant_BIND_BOTTOM: .. rst-class:: classref-enumeration-constant :ref:`AutotileBindings` **BIND_BOTTOM** = ``128`` .. _class_TileSet_constant_BIND_BOTTOMRIGHT: .. rst-class:: classref-enumeration-constant :ref:`AutotileBindings` **BIND_BOTTOMRIGHT** = ``256`` .. rst-class:: classref-item-separator ---- .. _enum_TileSet_TileMode: .. rst-class:: classref-enumeration enum **TileMode**: .. _class_TileSet_constant_SINGLE_TILE: .. rst-class:: classref-enumeration-constant :ref:`TileMode` **SINGLE_TILE** = ``0`` .. _class_TileSet_constant_AUTO_TILE: .. rst-class:: classref-enumeration-constant :ref:`TileMode` **AUTO_TILE** = ``1`` .. _class_TileSet_constant_ATLAS_TILE: .. rst-class:: classref-enumeration-constant :ref:`TileMode` **ATLAS_TILE** = ``2`` .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_TileSet_method__forward_atlas_subtile_selection: .. rst-class:: classref-method :ref:`Vector2` **_forward_atlas_subtile_selection** **(** :ref:`int` atlastile_id, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_TileSet_method__forward_subtile_selection: .. rst-class:: classref-method :ref:`Vector2` **_forward_subtile_selection** **(** :ref:`int` autotile_id, :ref:`int` bitmask, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_TileSet_method__is_tile_bound: .. rst-class:: classref-method :ref:`bool` **_is_tile_bound** **(** :ref:`int` drawn_id, :ref:`int` neighbor_id **)** |virtual| Determines when the auto-tiler should consider two different auto-tile IDs to be bound together. \ **Note:** ``neighbor_id`` will be ``-1`` (:ref:`TileMap.INVALID_CELL`) when checking a tile against an empty neighbor tile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_clear_bitmask_map: .. rst-class:: classref-method void **autotile_clear_bitmask_map** **(** :ref:`int` id **)** Clears all bitmask information of the autotile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_get_bitmask: .. rst-class:: classref-method :ref:`int` **autotile_get_bitmask** **(** :ref:`int` id, :ref:`Vector2` coord **)** Returns the bitmask of the subtile from an autotile given its coordinates. The value is the sum of the values in :ref:`AutotileBindings` present in the subtile (e.g. a value of 5 means the bitmask has bindings in both the top left and top right). .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_get_bitmask_mode: .. rst-class:: classref-method :ref:`BitmaskMode` **autotile_get_bitmask_mode** **(** :ref:`int` id **)** |const| Returns the :ref:`BitmaskMode` of the autotile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_get_fallback_mode: .. rst-class:: classref-method :ref:`FallbackMode` **autotile_get_fallback_mode** **(** :ref:`int` id **)** |const| Returns the :ref:`FallbackMode` of the autotile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_get_icon_coordinate: .. rst-class:: classref-method :ref:`Vector2` **autotile_get_icon_coordinate** **(** :ref:`int` id **)** |const| Returns the subtile that's being used as an icon in an atlas/autotile given its coordinates. The subtile defined as the icon will be used as a fallback when the atlas/autotile's bitmask information is incomplete. It will also be used to represent it in the TileSet editor. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_get_light_occluder: .. rst-class:: classref-method :ref:`OccluderPolygon2D` **autotile_get_light_occluder** **(** :ref:`int` id, :ref:`Vector2` coord **)** |const| Returns the light occluder of the subtile from an atlas/autotile given its coordinates. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_get_navigation_polygon: .. rst-class:: classref-method :ref:`NavigationPolygon` **autotile_get_navigation_polygon** **(** :ref:`int` id, :ref:`Vector2` coord **)** |const| Returns the navigation polygon of the subtile from an atlas/autotile given its coordinates. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_get_size: .. rst-class:: classref-method :ref:`Vector2` **autotile_get_size** **(** :ref:`int` id **)** |const| Returns the size of the subtiles in an atlas/autotile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_get_spacing: .. rst-class:: classref-method :ref:`int` **autotile_get_spacing** **(** :ref:`int` id **)** |const| Returns the spacing between subtiles of the atlas/autotile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_get_subtile_priority: .. rst-class:: classref-method :ref:`int` **autotile_get_subtile_priority** **(** :ref:`int` id, :ref:`Vector2` coord **)** Returns the priority of the subtile from an autotile given its coordinates. When more than one subtile has the same bitmask value, one of them will be picked randomly for drawing. Its priority will define how often it will be picked. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_get_z_index: .. rst-class:: classref-method :ref:`int` **autotile_get_z_index** **(** :ref:`int` id, :ref:`Vector2` coord **)** Returns the drawing index of the subtile from an atlas/autotile given its coordinates. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_set_bitmask: .. rst-class:: classref-method void **autotile_set_bitmask** **(** :ref:`int` id, :ref:`Vector2` bitmask, :ref:`int` flag **)** Sets the bitmask of the subtile from an autotile given its coordinates. The value is the sum of the values in :ref:`AutotileBindings` present in the subtile (e.g. a value of 5 means the bitmask has bindings in both the top left and top right). .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_set_bitmask_mode: .. rst-class:: classref-method void **autotile_set_bitmask_mode** **(** :ref:`int` id, :ref:`BitmaskMode` mode **)** Sets the :ref:`BitmaskMode` of the autotile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_set_fallback_mode: .. rst-class:: classref-method void **autotile_set_fallback_mode** **(** :ref:`int` id, :ref:`FallbackMode` mode **)** Returns the :ref:`FallbackMode` of the autotile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_set_icon_coordinate: .. rst-class:: classref-method void **autotile_set_icon_coordinate** **(** :ref:`int` id, :ref:`Vector2` coord **)** Sets the subtile that will be used as an icon in an atlas/autotile given its coordinates. The subtile defined as the icon may be used as a fallback when the atlas/autotile's bitmask information is incomplete. It will also be used to represent it in the TileSet editor. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_set_light_occluder: .. rst-class:: classref-method void **autotile_set_light_occluder** **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder, :ref:`Vector2` coord **)** Sets the light occluder of the subtile from an atlas/autotile given its coordinates. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_set_navigation_polygon: .. rst-class:: classref-method void **autotile_set_navigation_polygon** **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon, :ref:`Vector2` coord **)** Sets the navigation polygon of the subtile from an atlas/autotile given its coordinates. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_set_size: .. rst-class:: classref-method void **autotile_set_size** **(** :ref:`int` id, :ref:`Vector2` size **)** Sets the size of the subtiles in an atlas/autotile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_set_spacing: .. rst-class:: classref-method void **autotile_set_spacing** **(** :ref:`int` id, :ref:`int` spacing **)** Sets the spacing between subtiles of the atlas/autotile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_set_subtile_priority: .. rst-class:: classref-method void **autotile_set_subtile_priority** **(** :ref:`int` id, :ref:`Vector2` coord, :ref:`int` priority **)** Sets the priority of the subtile from an autotile given its coordinates. When more than one subtile has the same bitmask value, one of them will be picked randomly for drawing. Its priority will define how often it will be picked. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_autotile_set_z_index: .. rst-class:: classref-method void **autotile_set_z_index** **(** :ref:`int` id, :ref:`Vector2` coord, :ref:`int` z_index **)** Sets the drawing index of the subtile from an atlas/autotile given its coordinates. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_clear: .. rst-class:: classref-method void **clear** **(** **)** Clears all tiles. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_create_tile: .. rst-class:: classref-method void **create_tile** **(** :ref:`int` id **)** Creates a new tile with the given ID. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_find_tile_by_name: .. rst-class:: classref-method :ref:`int` **find_tile_by_name** **(** :ref:`String` name **)** |const| Returns the first tile matching the given name. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_get_last_unused_tile_id: .. rst-class:: classref-method :ref:`int` **get_last_unused_tile_id** **(** **)** |const| Returns the ID following the last currently used ID, useful when creating a new tile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_get_tiles_ids: .. rst-class:: classref-method :ref:`Array` **get_tiles_ids** **(** **)** |const| Returns an array of all currently used tile IDs. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_remove_tile: .. rst-class:: classref-method void **remove_tile** **(** :ref:`int` id **)** Removes the given tile ID. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_add_shape: .. rst-class:: classref-method void **tile_add_shape** **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** Adds a shape to the tile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_light_occluder: .. rst-class:: classref-method :ref:`OccluderPolygon2D` **tile_get_light_occluder** **(** :ref:`int` id **)** |const| Returns the tile's light occluder. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_material: .. rst-class:: classref-method :ref:`ShaderMaterial` **tile_get_material** **(** :ref:`int` id **)** |const| Returns the tile's material. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_modulate: .. rst-class:: classref-method :ref:`Color` **tile_get_modulate** **(** :ref:`int` id **)** |const| Returns the tile's modulation color. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_name: .. rst-class:: classref-method :ref:`String` **tile_get_name** **(** :ref:`int` id **)** |const| Returns the tile's name. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_navigation_polygon: .. rst-class:: classref-method :ref:`NavigationPolygon` **tile_get_navigation_polygon** **(** :ref:`int` id **)** |const| Returns the navigation polygon of the tile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_navigation_polygon_offset: .. rst-class:: classref-method :ref:`Vector2` **tile_get_navigation_polygon_offset** **(** :ref:`int` id **)** |const| Returns the offset of the tile's navigation polygon. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_normal_map: .. rst-class:: classref-method :ref:`Texture` **tile_get_normal_map** **(** :ref:`int` id **)** |const| Returns the tile's normal map texture. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_occluder_offset: .. rst-class:: classref-method :ref:`Vector2` **tile_get_occluder_offset** **(** :ref:`int` id **)** |const| Returns the offset of the tile's light occluder. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_region: .. rst-class:: classref-method :ref:`Rect2` **tile_get_region** **(** :ref:`int` id **)** |const| Returns the tile sub-region in the texture. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_shape: .. rst-class:: classref-method :ref:`Shape2D` **tile_get_shape** **(** :ref:`int` id, :ref:`int` shape_id **)** |const| Returns a tile's given shape. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_shape_count: .. rst-class:: classref-method :ref:`int` **tile_get_shape_count** **(** :ref:`int` id **)** |const| Returns the number of shapes assigned to a tile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_shape_offset: .. rst-class:: classref-method :ref:`Vector2` **tile_get_shape_offset** **(** :ref:`int` id, :ref:`int` shape_id **)** |const| Returns the offset of a tile's shape. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_shape_one_way: .. rst-class:: classref-method :ref:`bool` **tile_get_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id **)** |const| Returns the one-way collision value of a tile's shape. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_shape_one_way_margin: .. rst-class:: classref-method :ref:`float` **tile_get_shape_one_way_margin** **(** :ref:`int` id, :ref:`int` shape_id **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_shape_transform: .. rst-class:: classref-method :ref:`Transform2D` **tile_get_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id **)** |const| Returns the :ref:`Transform2D` of a tile's shape. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_shapes: .. rst-class:: classref-method :ref:`Array` **tile_get_shapes** **(** :ref:`int` id **)** |const| Returns an array of dictionaries describing the tile's shapes. \ **Dictionary structure in the array returned by this method:**\ :: { "autotile_coord": Vector2, "one_way": bool, "one_way_margin": int, "shape": CollisionShape2D, "shape_transform": Transform2D, } .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_texture: .. rst-class:: classref-method :ref:`Texture` **tile_get_texture** **(** :ref:`int` id **)** |const| Returns the tile's texture. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_texture_offset: .. rst-class:: classref-method :ref:`Vector2` **tile_get_texture_offset** **(** :ref:`int` id **)** |const| Returns the texture offset of the tile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_tile_mode: .. rst-class:: classref-method :ref:`TileMode` **tile_get_tile_mode** **(** :ref:`int` id **)** |const| Returns the tile's :ref:`TileMode`. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_get_z_index: .. rst-class:: classref-method :ref:`int` **tile_get_z_index** **(** :ref:`int` id **)** |const| Returns the tile's Z index (drawing layer). .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_light_occluder: .. rst-class:: classref-method void **tile_set_light_occluder** **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** Sets a light occluder for the tile. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_material: .. rst-class:: classref-method void **tile_set_material** **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** Sets the tile's material. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_modulate: .. rst-class:: classref-method void **tile_set_modulate** **(** :ref:`int` id, :ref:`Color` color **)** Sets the tile's modulation color. \ **Note:** Modulation is performed by setting the tile's vertex color. To access this in a shader, use ``COLOR`` rather than ``MODULATE`` (which instead accesses the :ref:`TileMap`'s :ref:`CanvasItem.modulate` property). .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_name: .. rst-class:: classref-method void **tile_set_name** **(** :ref:`int` id, :ref:`String` name **)** Sets the tile's name. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_navigation_polygon: .. rst-class:: classref-method void **tile_set_navigation_polygon** **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** Sets the tile's navigation polygon. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_navigation_polygon_offset: .. rst-class:: classref-method void **tile_set_navigation_polygon_offset** **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** Sets an offset for the tile's navigation polygon. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_normal_map: .. rst-class:: classref-method void **tile_set_normal_map** **(** :ref:`int` id, :ref:`Texture` normal_map **)** Sets the tile's normal map texture. \ **Note:** Godot expects the normal map to use X+, Y-, and Z+ coordinates. See `this page `__ for a comparison of normal map coordinates expected by popular engines. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_occluder_offset: .. rst-class:: classref-method void **tile_set_occluder_offset** **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** Sets an offset for the tile's light occluder. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_region: .. rst-class:: classref-method void **tile_set_region** **(** :ref:`int` id, :ref:`Rect2` region **)** Sets the tile's sub-region in the texture. This is common in texture atlases. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_shape: .. rst-class:: classref-method void **tile_set_shape** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** Sets a shape for the tile, enabling collision. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_shape_offset: .. rst-class:: classref-method void **tile_set_shape_offset** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Vector2` shape_offset **)** Sets the offset of a tile's shape. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_shape_one_way: .. rst-class:: classref-method void **tile_set_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** Enables one-way collision on a tile's shape. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_shape_one_way_margin: .. rst-class:: classref-method void **tile_set_shape_one_way_margin** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`float` one_way **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_shape_transform: .. rst-class:: classref-method void **tile_set_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** Sets a :ref:`Transform2D` on a tile's shape. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_shapes: .. rst-class:: classref-method void **tile_set_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** Sets an array of shapes for the tile, enabling collision. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_texture: .. rst-class:: classref-method void **tile_set_texture** **(** :ref:`int` id, :ref:`Texture` texture **)** Sets the tile's texture. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_texture_offset: .. rst-class:: classref-method void **tile_set_texture_offset** **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** Sets the tile's texture offset. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_tile_mode: .. rst-class:: classref-method void **tile_set_tile_mode** **(** :ref:`int` id, :ref:`TileMode` tilemode **)** Sets the tile's :ref:`TileMode`. .. rst-class:: classref-item-separator ---- .. _class_TileSet_method_tile_set_z_index: .. rst-class:: classref-method void **tile_set_z_index** **(** :ref:`int` id, :ref:`int` z_index **)** Sets the tile's drawing index. .. |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.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`