Index · Object → RefCounted → Resource → TileSetSource → TileSetScenesCollectionSource

TileSetScenesCollectionSource

Exposes a set of scenes as tiles for a TileSet resource.

Class Description

When placed on a 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 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 TileMapLayer that is already inside the tree, the 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. TileSetSource.get_tiles_count() will always return 1. Use 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 TileMapLayer:

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)

Properties

Inherited from Resource (4)

Methods

func create_scene_tile(packed_scene: PackedScene, id_override: int = -1) -> int

Creates a scene-based tile out of the given scene.

Returns a newly generated unique ID.

func get_next_scene_tile_id() -> int

Returns the scene ID a following call to create_scene_tile() would return.

func get_scene_tile_display_placeholder(id: int) -> bool

Returns whether the scene tile with id displays a placeholder in the editor.

func get_scene_tile_id(index: int) -> int

Returns the scene tile ID of the scene tile at index.

func get_scene_tile_scene(id: int) -> PackedScene

Returns the PackedScene resource of scene tile with id.

func get_scene_tiles_count() -> int

Returns the number or scene tiles this TileSet source has.

func has_scene_tile_id(id: int) -> bool

Returns whether this TileSet source has a scene tile with id.

func remove_scene_tile(id: int) -> void

Remove the scene tile with id.

func set_scene_tile_display_placeholder(id: int, display_placeholder: bool) -> void

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.

func set_scene_tile_id(id: int, new_id: int) -> void

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.

func set_scene_tile_scene(id: int, packed_scene: PackedScene) -> void

Assigns a PackedScene resource to the scene tile with id. This will fail if the scene does not extend CanvasItem, as positioning properties are needed to place the scene on the TileMapLayer.

Inherited from TileSetSource (6)
func get_alternative_tile_id(atlas_coords: Vector2i, index: int) -> int
func get_tile_id(index: int) -> Vector2i
func has_alternative_tile(atlas_coords: Vector2i, alternative_tile: int) -> bool
func has_tile(atlas_coords: Vector2i) -> bool
Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)