godot/doc/classes/TileSetScenesCollectionSource.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="TileSetScenesCollectionSource" inherits="TileSetSource" version="4.0">
	<brief_description>
		Exposes a set of scenes as tiles for a [TileSet] resource.
	</brief_description>
	<description>
		When placed on a [TileMap], tiles from [TileSetScenesCollectionSource] will automatically instantiate an associated scene at the cell's position in the TileMap.
		Scenes are instantiated as children of the [TileMap] when it enters the tree. If you add/remove a scene tile in the [TileMap] that is already inside the tree, the [TileMap] will automatically instantiate/free the scene accordingly.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="create_scene_tile">
			<return type="int" />
			<argument index="0" name="packed_scene" type="PackedScene" />
			<argument index="1" name="id_override" type="int" default="-1" />
			<description>
				Creates a scene-based tile out of the given scene.
				Returns a newly generated unique ID.
			</description>
		</method>
		<method name="get_next_scene_tile_id" qualifiers="const">
			<return type="int" />
			<description>
				Returns the scene ID a following call to [method create_scene_tile] would return.
			</description>
		</method>
		<method name="get_scene_tile_display_placeholder" qualifiers="const">
			<return type="bool" />
			<argument index="0" name="id" type="int" />
			<description>
				Returns whether the scene tile with id [code]id[/code] displays a placeholder in the editor.
			</description>
		</method>
		<method name="get_scene_tile_id">
			<return type="int" />
			<argument index="0" name="index" type="int" />
			<description>
				Returns the scene tile ID of the scene tile at index [code]index[/code].
			</description>
		</method>
		<method name="get_scene_tile_scene" qualifiers="const">
			<return type="PackedScene" />
			<argument index="0" name="id" type="int" />
			<description>
				Returns the [PackedScene] resource of scene tile with id [code]id[/code].
			</description>
		</method>
		<method name="get_scene_tiles_count">
			<return type="int" />
			<description>
				Returns the number or scene tiles this TileSet source has.
			</description>
		</method>
		<method name="has_scene_tile_id">
			<return type="bool" />
			<argument index="0" name="id" type="int" />
			<description>
				Returns whether this TileSet source has a scene tile with id [code]id[/code].
			</description>
		</method>
		<method name="remove_scene_tile">
			<return type="void" />
			<argument index="0" name="id" type="int" />
			<description>
				Remove the scene tile with id [code]id[/code].
			</description>
		</method>
		<method name="set_scene_tile_display_placeholder">
			<return type="void" />
			<argument index="0" name="id" type="int" />
			<argument index="1" name="display_placeholder" type="bool" />
			<description>
				Sets whether or not the scene tile with id [code]id[/code] should display a placeholder in the editor. This might be useful for scenes that are not visible.
			</description>
		</method>
		<method name="set_scene_tile_id">
			<return type="void" />
			<argument index="0" name="id" type="int" />
			<argument index="1" name="new_id" type="int" />
			<description>
				Changes a scene tile's ID from [code]id[/code] to [code]new_id[/code]. This will fail if there is already a tile with a ID equal to [code]new_id[/code].
			</description>
		</method>
		<method name="set_scene_tile_scene">
			<return type="void" />
			<argument index="0" name="id" type="int" />
			<argument index="1" name="packed_scene" type="PackedScene" />
			<description>
				Assigns a [PackedScene] resource to the scene tile with id [code]id[/code]. This will fail if the scene does not extend CanvasItem, as positioning properties are needed to place the scene on the TileMap.
			</description>
		</method>
	</methods>
</class>