: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/TileSetScenesCollectionSource.xml. .. _class_TileSetScenesCollectionSource: TileSetScenesCollectionSource ============================= **Inherits:** :ref:`TileSetSource` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Exposes a set of scenes as tiles for a :ref:`TileSet` resource. .. rst-class:: classref-introduction-group Description ----------- When placed on a :ref:`TileMapLayer`, tiles from **TileSetScenesCollectionSource** will automatically instantiate an associated scene at the cell's position in the TileMapLayer. Scenes are instantiated as children of the :ref:`TileMapLayer` after it enters the tree, at the end of the frame (their creation is deferred). If you add/remove a scene tile in the :ref:`TileMapLayer` that is already inside the tree, the :ref:`TileMapLayer` will automatically instantiate/free the scene accordingly. \ **Note:** Scene tiles all occupy one tile slot and instead use alternate tile ID to identify scene index. :ref:`TileSetSource.get_tiles_count()` will always return ``1``. Use :ref:`get_scene_tiles_count()` to get a number of scenes in a **TileSetScenesCollectionSource**. Use this code if you want to find the scene path at a given tile in :ref:`TileMapLayer`: .. tabs:: .. code-tab:: gdscript var source_id = tile_map_layer.get_cell_source_id(Vector2i(x, y)) if source_id > -1: var scene_source = tile_map_layer.tile_set.get_source(source_id) if scene_source is TileSetScenesCollectionSource: var alt_id = tile_map_layer.get_cell_alternative_tile(Vector2i(x, y)) # The assigned PackedScene. var scene = scene_source.get_scene_tile_scene(alt_id) .. code-tab:: csharp int sourceId = tileMapLayer.GetCellSourceId(new Vector2I(x, y)); if (sourceId > -1) { TileSetSource source = tileMapLayer.TileSet.GetSource(sourceId); if (source is TileSetScenesCollectionSource sceneSource) { int altId = tileMapLayer.GetCellAlternativeTile(new Vector2I(x, y)); // The assigned PackedScene. PackedScene scene = sceneSource.GetSceneTileScene(altId); } } .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`create_scene_tile`\ (\ packed_scene\: :ref:`PackedScene`, id_override\: :ref:`int` = -1\ ) | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_next_scene_tile_id`\ (\ ) |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_scene_tile_display_placeholder`\ (\ id\: :ref:`int`\ ) |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_scene_tile_id`\ (\ index\: :ref:`int`\ ) | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedScene` | :ref:`get_scene_tile_scene`\ (\ id\: :ref:`int`\ ) |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_scene_tiles_count`\ (\ ) | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_scene_tile_id`\ (\ id\: :ref:`int`\ ) | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_scene_tile`\ (\ id\: :ref:`int`\ ) | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_scene_tile_display_placeholder`\ (\ id\: :ref:`int`, display_placeholder\: :ref:`bool`\ ) | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_scene_tile_id`\ (\ id\: :ref:`int`, new_id\: :ref:`int`\ ) | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_scene_tile_scene`\ (\ id\: :ref:`int`, packed_scene\: :ref:`PackedScene`\ ) | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_TileSetScenesCollectionSource_method_create_scene_tile: .. rst-class:: classref-method :ref:`int` **create_scene_tile**\ (\ packed_scene\: :ref:`PackedScene`, id_override\: :ref:`int` = -1\ ) :ref:`🔗` Creates a scene-based tile out of the given scene. Returns a newly generated unique ID. .. rst-class:: classref-item-separator ---- .. _class_TileSetScenesCollectionSource_method_get_next_scene_tile_id: .. rst-class:: classref-method :ref:`int` **get_next_scene_tile_id**\ (\ ) |const| :ref:`🔗` Returns the scene ID a following call to :ref:`create_scene_tile()` would return. .. rst-class:: classref-item-separator ---- .. _class_TileSetScenesCollectionSource_method_get_scene_tile_display_placeholder: .. rst-class:: classref-method :ref:`bool` **get_scene_tile_display_placeholder**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the scene tile with ``id`` displays a placeholder in the editor. .. rst-class:: classref-item-separator ---- .. _class_TileSetScenesCollectionSource_method_get_scene_tile_id: .. rst-class:: classref-method :ref:`int` **get_scene_tile_id**\ (\ index\: :ref:`int`\ ) :ref:`🔗` Returns the scene tile ID of the scene tile at ``index``. .. rst-class:: classref-item-separator ---- .. _class_TileSetScenesCollectionSource_method_get_scene_tile_scene: .. rst-class:: classref-method :ref:`PackedScene` **get_scene_tile_scene**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`PackedScene` resource of scene tile with ``id``. .. rst-class:: classref-item-separator ---- .. _class_TileSetScenesCollectionSource_method_get_scene_tiles_count: .. rst-class:: classref-method :ref:`int` **get_scene_tiles_count**\ (\ ) :ref:`🔗` Returns the number or scene tiles this TileSet source has. .. rst-class:: classref-item-separator ---- .. _class_TileSetScenesCollectionSource_method_has_scene_tile_id: .. rst-class:: classref-method :ref:`bool` **has_scene_tile_id**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Returns whether this TileSet source has a scene tile with ``id``. .. rst-class:: classref-item-separator ---- .. _class_TileSetScenesCollectionSource_method_remove_scene_tile: .. rst-class:: classref-method |void| **remove_scene_tile**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Remove the scene tile with ``id``. .. rst-class:: classref-item-separator ---- .. _class_TileSetScenesCollectionSource_method_set_scene_tile_display_placeholder: .. rst-class:: classref-method |void| **set_scene_tile_display_placeholder**\ (\ id\: :ref:`int`, display_placeholder\: :ref:`bool`\ ) :ref:`🔗` Sets whether or not the scene tile with ``id`` should display a placeholder in the editor. This might be useful for scenes that are not visible. .. rst-class:: classref-item-separator ---- .. _class_TileSetScenesCollectionSource_method_set_scene_tile_id: .. rst-class:: classref-method |void| **set_scene_tile_id**\ (\ id\: :ref:`int`, new_id\: :ref:`int`\ ) :ref:`🔗` Changes a scene tile's ID from ``id`` to ``new_id``. This will fail if there is already a tile with an ID equal to ``new_id``. .. rst-class:: classref-item-separator ---- .. _class_TileSetScenesCollectionSource_method_set_scene_tile_scene: .. rst-class:: classref-method |void| **set_scene_tile_scene**\ (\ id\: :ref:`int`, packed_scene\: :ref:`PackedScene`\ ) :ref:`🔗` Assigns a :ref:`PackedScene` resource to the scene tile with ``id``. This will fail if the scene does not extend :ref:`CanvasItem`, as positioning properties are needed to place the scene on the :ref:`TileMapLayer`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`