TileSetScenesCollectionSource

继承： TileSetSource < Resource < RefCounted < Object

以图块的形式向 TileSet 资源暴露一组场景。

描述

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.

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:

GDScriptC#

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)

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);
    }
}

方法

方法说明

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

从给定的场景创建基于场景的图块。

返回新生成的唯一 ID。

int get_next_scene_tile_id() const 🔗

返回后续调用 create_scene_tile 时会返回的场景 ID。

bool get_scene_tile_display_placeholder(id: int) const 🔗

返回 ID 为 id 的场景图块是否在编辑器中显示占位图。

int get_scene_tile_id(index: int) 🔗

返回索引为 index 的场景图块的场景图块 ID。

PackedScene get_scene_tile_scene(id: int) const 🔗

返回 ID 为 id 的场景图块的 PackedScene 资源。

int get_scene_tiles_count() 🔗

返回该 TileSet 源中场景图块的数量。

bool has_scene_tile_id(id: int) 🔗

返回该 TileSet 源是否包含 ID 为 id 的场景图块。

void remove_scene_tile(id: int) 🔗

移除 ID 为 id 的场景图块。

void set_scene_tile_display_placeholder(id: int, display_placeholder: bool) 🔗

设置 ID 为 id 的场景图块是否应该在编辑器中显示为占位符。对不可见的场景可能有用。

void set_scene_tile_id(id: int, new_id: int) 🔗

将场景图块的 ID 从 id 改为 new_id。如果已经存在 ID 为 new_id 的图块则会失败。

void set_scene_tile_scene(id: int, packed_scene: PackedScene) 🔗

将 PackedScene 资源分配给 ID 为 id 的场景图块。如果该场景扩展的不是 CanvasItem 则会失败，因为将场景放置到 TileMap 上需要位置属性。