[Unity] “Entity Prefab” 管理

英文原文：
https://coffeebraingames.wordpress.com/2020/07/19/entity-prefab-management/

  我目前正在制作一个2D建造者游戏的原型，作为一个副业项目。不过这次是用纯ECS制作的，或者至少是大部分。我想做一个和我们为《 Academia 》做的一样的原型，但要用纯ECS。我想，真的需要建立一个，这样我就可以弄清楚并创建我所选择的流派所需要的用DOTS建立的实用代码/框架。一路走来，我已经做了一些。其中一个是管理 “entity prefabs”。

  Entity prefabs与我们所知道的普通prefabs不同。在这篇文章中，我将仅仅把它们定义为转换后的prefabs，然后可以使用EntityManager.Instantiate()或EntityCommandBuffer.Instantiate()进行实例化/克隆。它们仅仅被表示为实体值。

  我想实现的是，我希望能够在编辑器中编写prefabs，然后有一个单点，我可以通过字符串id查询它们。我还希望能够在Job中查询和实例化entity prefabs。

Prefabs Holder

  我做的第一件事是创建了可脚本对象，它将容纳我们要转换的所有Prefabs。这只是直接的数据持有代码。

[Serializable]
public struct EntityPrefabItem {
    public string id;
    public GameObject prefab;
}
 
// You can change the menu location
[CreateAssetMenu(menuName = "CommonEcs/EntityPrefabItemsHolder")]
public class EntityPrefabItemsHolder : ScriptableObject {
    [SerializeField]
    private List<EntityPrefabItem> prefabs;
 
    public IReadOnlyList<EntityPrefabItem> Prefabs {
        get {
            return this.prefabs;
        }
    }
}

  一旦编译完成，我们就可以创建一个可以容纳 Prefabs 的 Scriptable 对象。

The System

  接下来是创建一个系统，在NativeHashMap中保存实体prefabs。任何其他系统都可以查询这个系统，这样他们就可以访问 entity prefabs 了。

public class EntityPrefabManagerSystem : SystemBase {
    private NativeHashMap<FixedString64, Entity> map;
     
    protected override void OnCreate() {
        this.map = new NativeHashMap<FixedString64, Entity>(10, Allocator.Persistent);
    }
 
    protected override void OnDestroy() {
        if (this.map.IsCreated) {
            this.map.Dispose();
        }
    }
 
    /// <summary>
    /// Adds a prefab to maintain
    /// </summary>
    /// <param name="item"></param>
    public void Add(FixedString64 id, Entity entityPrefab) {
        if (this.map.ContainsKey(id)) {
            throw new Exception($"The prefab pool already contains an entry for {id}");
        }
 
        this.map[id] = entityPrefab;
    }
 
    /// <summary>
    /// This is used when the map is required inside a job
    /// </summary>
    public EntityPrefabResolver EntityPrefabResolver {
        get {
            return new EntityPrefabResolver(this.map);
        }
    }
 
    public Entity GetEntityPrefab(FixedString64 id) {
        if (this.map.TryGetValue(id, out Entity prefabEntity)) {
            return prefabEntity;
        }
         
        throw new Exception($"The prefab pool does not contain an entry for {id}");
    }
 
    protected override void OnUpdate() {
    }
}

EntityPrefabResolver是这样实现的：

public struct EntityPrefabResolver {
    private NativeHashMap<FixedString64, Entity> map;
 
    public EntityPrefabResolver(NativeHashMap<FixedString64, Entity> map) {
        this.map = map;
    }
 
    public Entity GetEntityPrefab(FixedString64 id) {
        if (this.map.TryGetValue(id, out Entity prefabEntity)) {
            return prefabEntity;
        }
         
        throw new Exception($"The prefab pool does not contain an entry for {id}");
    }
}

  它只是内部NativeHashMap的一个封装器，这样我就可以把它传递给作业或其他什么东西，而不需要访问原始NativeHashMap。

The Populator

  然后，我们实现一个真正做Prefab的转换，并将它们存储到我们刚刚创建的系统中。这可能是一个天真的实现，但这是我所知道的。

[RequireComponent(typeof(ConvertToEntity))]
public class EntityPrefabManagerPopulator : MonoBehaviour, IDeclareReferencedPrefabs, IConvertGameObjectToEntity {
    [SerializeField]
    private EntityPrefabItemsHolder items;
 
    public void DeclareReferencedPrefabs(List<GameObject> referencedPrefabs) {
        Assertion.NotNull(this.items);
         
        IReadOnlyList<EntityPrefabItem> prefabs = this.items.Prefabs;
        for (int i = 0; i < prefabs.Count; ++i) {
            referencedPrefabs.Add(prefabs[i].prefab);
        }
    }
 
    public void Convert(Entity entity, EntityManager dstManager, GameObjectConversionSystem conversionSystem) {
        Assertion.NotNull(this.items);
 
        EntityPrefabManagerSystem manager =
            World.DefaultGameObjectInjectionWorld.GetOrCreateSystem<EntityPrefabManagerSystem>();
         
        IReadOnlyList<EntityPrefabItem> prefabs = this.items.Prefabs;
        for (int i = 0; i < prefabs.Count; ++i) {
            EntityPrefabItem item = prefabs[i];
            Entity entityPrefab = conversionSystem.GetPrimaryEntity(item.prefab);
            manager.Add(item.id, entityPrefab);
        }
    }
}

  我只是借鉴了关于如何转换prefabs的例子，但把它应用于指定的EntityPrefabItemsHolder的内容，而不是。我不太确定我们是否需要在DeclareReferencedPrefabs()中添加prefabs。然而，当我删除这几行代码时，它产生了一个错误。所以我就把它留在那里。prefabs的转换发生在Convert()中。

  就这样了。这个小小的代码库现在可以使用了。

Usage

  假设我们有这样一个组件，我们想用来做一个预制件。

[GenerateAuthoringComponent]
public struct TestComponent : IComponentData {
    public int value;
}

  GenerateAuthoringComponent是必需的，所以我们可以在编辑器中添加该组件。

  所以我们做一个 prefab，加入这个组件：

然后我们创建一个EntityPrefabItemsHolder并添加我们创建的预制件。

  在一个空的场景中，我们创建一个GameObject并附加EntityPrefabManagerPopulator。我们指定我们刚刚创建的EntityPrefabItemsHolder作为Item。

  现在我们创建一个简单的系统脚本，将我们的Prefab实例化，看看管理器是否工作，我们的Prefab是否被实例化：

public class EntityPrefabManagerSimpleTest : SystemBase {
    private EntityPrefabManagerSystem entityPrefabManager;
    private EndSimulationEntityCommandBufferSystem barrier;
 
    protected override void OnCreate() {
        this.entityPrefabManager = this.World.GetOrCreateSystem<EntityPrefabManagerSystem>();
        this.barrier = this.World.GetOrCreateSystem<EndSimulationEntityCommandBufferSystem>();
    }
 
    protected override void OnUpdate() {
        // Left click
        if (Input.GetMouseButtonDown(0)) {
            // Instantiate 1
            Entity entityPrefab = this.entityPrefabManager.GetEntityPrefab("Test");
            this.EntityManager.Instantiate(entityPrefab);
            Debug.Log("Instantiated Test");
        }
         
        // Right click
        if (Input.GetMouseButtonDown(1)) {
            // Instantiate using a job
            this.Dependency = new InstantiateJob() {
                commandBuffer = this.barrier.CreateCommandBuffer(),
                prefabResolver = this.entityPrefabManager.EntityPrefabResolver,
                prefabId = "Test"
            }.Schedule(this.Dependency);
             
            this.barrier.AddJobHandleForProducer(this.Dependency);
        }
    }
     
    [BurstCompile]
    private struct InstantiateJob : IJob {
        public EntityCommandBuffer commandBuffer;
        public EntityPrefabResolver prefabResolver;
        public FixedString64 prefabId;
         
        public void Execute() {
            Entity entityPrefab = this.prefabResolver.GetEntityPrefab(this.prefabId);
            this.commandBuffer.Instantiate(entityPrefab);
        }
    }
}

  这个系统一点都不特别。在更新时，我只是在左键上实例化测试Prefab。在右键上，它实例化了相同的Prefab，但使用的是一个 burst 的编译作业。我想表明，它在这种 Job 上是有效的。

  现在播放这个场景。打开实体调试器（Window > Analysis > Entity Debugger），这样你就可以看到正在实例化的prefab实体。在场景播放时做一些点击和右键点击。你应该能够看到新的实体被添加到测试 Prefab 中，这是从测试Prefab中克隆的。

  我们可以知道它实例化了我们的prefab，因为我们可以看到它的值是888，这是我们在编辑器中设置的：

Ideal

理想情况下，这个东西应该使用Blob Asset。但说实话，我还不知道如何使用它。我现在只有这些了。