Unity.Entities.EndFixedStepSimulationEntityCommandBufferSystem?

Unity Engine
, , , ,
1

I’m trying to instantiate a bunch of 3d tiles that will build a grid/tile kind of map in the screen. It was previously being done successfully with objects, but now I’m refactoring that code to work with ECS.

Here’s what I’ve done:

  • Created a subscene;
  • Put a new game object inside that subscene, so it can be converted to Entity. That’s the only object currently in my subscene;
  • Added a monobehaviour (which has a baker) to that object;
  • In the Bake function, I filled up a NativeHashMap<int2, MyStructure> field in the authoring with a for loop. It looks something like this: “authoring.Nodes.Add(pos, new MyStruct { stuff… })”. One of the fields of this “MyStructure” thing is an Entity type that receives GetEntity() of the prefab that needs to be in that specific struct for instatiation later;
  • Created a System to handle the instantiation itself using burstcompile. Removing burstcompile changes nothing though;
  • Added [UpdateInGroup(typeof(InitializationSystemGroup))] to the system struct because I was getting an error while trying to get a singleton that had not yet been created while running the “OnUpdate logic” to get my “Nodes” array.
  • Did a “for” loop (iterating through all the keys) to do the instantiation in the “OnUpdate” method of that system and that loop does this: "Entity x = ecb.Instantiate(map.Nodes[keys*].Entity);*". Then, after the for loop finishes I did: “ecb.Playback(state.EntityManager);”

Relevant Info (maybe): I have an AssetsManager that loads the resources by using “Resources.LoadAll<>()” and stores them in a dictionary in which the key is the asset name. This is done in its Awake method. On the “Bake” function I check if “AssetsManager.Instance” is not null so I can do the for loop described by the item 2 (above). The “Instance” is set before the “Resources.LoadAll<>()” call, and when setting my Entity I do exactly this: "Entity = GetEntity(AssetsManager.Instance.GetAsset(authoring.MapStructure.Tiles*.PrefabName).gameObject)*". I don’t think this is the cause of the problem, because the baker ends up adding the nodes when I get to the System part, so, I think the prefabs have been already loaded by then. After all, the System “for” loop runs through all my 168 nodes which are created by the baker.
Expected Result: In my tests, only one kind of prefab is being associated with all nodes because I wanted to keep things simple at first. So, for each node I expected to have its associated prefab (which in the test scenario is always the same) instantiated and visible on the screen as an entity in order to build the tile/grid/thing map. If that worked, I would create the real map associating different prefabs to each node as necessary.
Problem: For some reason when I run this thing I can see in the Entity Hierarchy (runtime) a blue instance of my prefab, complete with all components that it shoud have (I think) at the same level of the game object to which I added the monobehavior with baking. Together with that bunch of Unity internal Systems and Components that fill up the hierarchy at runtime by default, I also get one “Unity.Entities.EndFixedStepSimulationEntityCommandBufferSyste” (yes, without the “m”, not a typo) for each Entity I tried to instantiate, with various Indexes and Versions. Their components are simply “Tags”, with “Simulate” checked, “End Fixed Step Simulation Entity Command Buffer System | Singleton”, which is empty if I try to expand, and “System Instance”, which also is empty as I expand. No Aspects, and in Relationships I have a “End Fixed Step Simulation Entity Command Buffer System” >> “Query #1” >> “Unity.Entities.EndFixedStepSimulationEntityCommandBufferSystem.Singleton”. The “>>” in this case represents that one is nested to the one before it, so only one “root” element in the Relationships. Nothing is rendered, no other components are added, and there’s no clue that those things were created by my instatiations other than they go away if I comment away the instantiation code, and they seem to be as plenty as my instatiation for loop count (which is 168 in this test). The results are the same if using “state.EntityManager” instead of the “EntityCommandBuffer”.
I have a feeling this is a noob problem caused by my lack of knowledge about the ECS tools. Been messing around with ECS for just a couple of days on a project that’s been shelved for quite some time because it’s very CPU intensive and I didn’t manage to make it run proberly back then. Since ECS is now at pre release stages I thought I should give it a go, and I would be very grateful if anyone could offer me some help.
Thanks in advance.

8843851--1205287--1.jpg

8843851--1205290--2.jpg
8843851--1205290--2.jpg538×672 160 KB

8843851--1205293--3.jpg
8843851--1205293--3.jpg1915×400 153 KB

8843851--1205296--4.jpg
8843851--1205296--4.jpg1920×384 150 KB

2

This may not be the only problem but entities that are created via GetEntity are not the same entities that are used at runtime. If these entities are added to an IComponentData or an IBufferElement they are automatically remapped. That means you cannot store entities created this way in BlobAssets or NativeContainers. However this should net a different error than the one you are getting. Perhaps you could post some of your code as the description is not entirely clear for me.

3

This is the “AssetsManager.cs”

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Unity.Entities;
using UnityEditor;
using UnityEngine;

public class AssetsManager : MonoBehaviour
{
    public static AssetsManager Instance { get; protected set; }
 
    [ColorUsage(true, true)] public Color SelectedEmissionColor;
    public Color[] ColorVariations;
    public SelectableObject SelectedObject;

    private Dictionary<string, UnityEngine.Object> _loadedAssets = new();

    protected virtual void Awake()
    {
        foreach (var x in Resources.LoadAll<IndexedAsset>(""))
        {
            _loadedAssets.Add(x.IndexedName, x);
        }

        DontDestroyOnLoad(gameObject);

        if (Instance != null && Instance != this)
        {
            Destroy(this);
        }
        else
        {
            Instance = this;
        }
    }

    public IndexedAsset GetAsset(string name)
    {
        if (_loadedAssets.ContainsKey(name)) return (IndexedAsset) _loadedAssets[name];
        else return null;
    }

    public T GetAsset<T>(string name)
    {
        if (_loadedAssets.ContainsKey(name) && ((GameObject)_loadedAssets[name]).GetComponent<T>() != null) return ((GameObject)_loadedAssets[name]).GetComponent<T>();
        else return (T)Convert.ChangeType(null, typeof(T));
    }
}

This is the “MapMono.cs”, which is the script that I add to the single GameObject inside the subscene:

using Unity.Collections;
using Unity.Entities;
using Unity.Mathematics;
using UnityEngine;
using Debug = System.Diagnostics.Debug;
using Random = Unity.Mathematics.Random;

public class MapMono : MonoBehaviour
{
    public int2 MapDimensions;
    public uint RandomSeed;
    public int2 MapOffset;
    public NativeHashMap<int2, PathNode> Nodes;
    public MapStructure MapStructure;
    private PlayerSave ps = new();
    private bool loaded = false;

    private NativeArray<PathNode> pathNodes;
    private NativeArray<int> goalPathNodes;

    public void Create()
    {
        if (loaded) return;

        if (PlayerInfoManager.Instance != null)
        {
            SaveManager.LoadSavedData(ref ps, PlayerInfoManager.Instance.Username, PlayerInfoManager.Instance.ID);
            if (ps.Maps.Count > 0) SetMapStructure(ps.Maps[0].ID);
            else Debug.WriteLine("No map to load.");
        }
    }

    public void SetMapStructure(string id, bool selectable = true)
    {
        foreach (MapStructure m in ps.Maps)
        {
            if (m.ID.Trim() == id.Trim())
            {
                MapStructure = m;
            }
        }
    }
}

public class MapBaker : Baker<MapMono>
{
    public override void Bake(MapMono authoring)
    {
        authoring.Create();

        if (authoring.MapStructure != null && authoring.MapStructure.Tiles != null && AssetsManager.Instance != null)
        {
            if (authoring.Nodes.IsCreated) authoring.Nodes.Dispose();

            authoring.Nodes = new NativeHashMap<int2, PathNode>(1, Allocator.Persistent);

            for (int i = 0; i < authoring.MapStructure.Tiles.Count; i++)
            {
                Debug.WriteLine((int)authoring.MapStructure.Tiles[i].PosX + " - " + (int)authoring.MapStructure.Tiles[i].PosY);

                int2 pos = new int2((int)authoring.MapStructure.Tiles[i].PosX, (int)authoring.MapStructure.Tiles[i].PosY);

                if (!authoring.Nodes.ContainsKey(pos))
                {
                    authoring.Nodes.Add(pos, new PathNode
                    {
                        realX = (int)authoring.MapStructure.Tiles[i].PosX,
                        realY = (int)authoring.MapStructure.Tiles[i].PosY,
                        gridX = (int)authoring.MapStructure.Tiles[i].PosX + authoring.MapOffset.x,
                        gridY = (int)authoring.MapStructure.Tiles[i].PosY + authoring.MapOffset.y,
                        index = -1,
                        parent = -1,
                        tag = -1,
                        Entity = GetEntity(AssetsManager.Instance.GetAsset(authoring.MapStructure.Tiles[i].PrefabName).gameObject),
                        canBuildOver = false,
                        isWalkable = false
                    });
                }
            }

            AddComponent(new MapProperties
            {
                MapDimensions = authoring.MapDimensions,
                Nodes = authoring.Nodes
            });
        }

        AddComponent(new HelperRandom
        {
            Value = Random.CreateFromIndex(authoring.RandomSeed)
        });
    }
}

public struct PathNode
{
    public Entity Entity;

    public int gridX;
    public int gridY;

    public int realX;
    public int realY;

    public int index;

    private int gCost;
    private int hCost;
    private int fCost;

    public bool isWalkable;
    public bool canBuildOver;

    public int tag;

    public int parent;

    public void SetGCost(int p) { gCost = p; fCost = gCost + hCost; }
    public int GetGCost() { return gCost; }

    public void SetHCost(int p) { hCost = p; fCost = gCost + hCost; }
    public int GetHCost() { return hCost; }

    public int GetFCost() { return fCost; }
}

And finally, this is the System code:

using System.Diagnostics;
using Unity.Burst;
using Unity.Collections;
using Unity.Entities;
using Unity.Mathematics;
using UnityEngine.UIElements;

[BurstCompile]
[UpdateInGroup(typeof(InitializationSystemGroup))]
public partial struct SpawnTilesSystem : ISystem
{
    [BurstCompile]
    public void OnCreate(ref SystemState state)
    {
        state.RequireForUpdate<MapProperties>();
    }

    [BurstCompile]
    public void OnDestroy(ref SystemState state)
    {

    }

    [BurstCompile]
    public void OnUpdate(ref SystemState state)
    {
        state.Enabled = false;
        var mapProps = SystemAPI.GetSingletonEntity<MapProperties>();
        var map = SystemAPI.GetAspectRW<MapAspect>(mapProps);

        var ecb = new EntityCommandBuffer(Allocator.Temp);
        var keys = map.Nodes.GetKeyArray(Allocator.Temp);

        for (int i = 0; i < keys.Length; i++)
        {
            Entity x = ecb.Instantiate(map.Nodes[keys[i]].Entity);
        }

        ecb.Playback(state.EntityManager);
    }
}

I think that’s the relevant code. If something else is needed please let me know.

Edit: I’m aware that the GetEntity() return is not the same as an instantiated entity. I’ve been treating the GetEntity() return just like we used to do with prefabs. I’m storing them in the nodes so they can be instantiated later “for real”, which I try to do in the System logic, where the problem happens.

Edit2: That’s probably the issue though, because I’m doing exactly what you said I can’t do. I’m storing the “prefab” entity inside a NativeHashMap container as part of the PathNode structs. If that’s the main problem, what can be done fix this while allowing me to instantiate different entities for each node in the System code?

Thanks for your answer.

4

You can use them as prefabs, however you cannot store them like this in a native container during baking. Entities created during baking this way are invalid during runtime. The system is smart enough to remap them to valid entities but only if they are stored in a component or a dynamic buffer. The baking system will not look into your node container so it cannot remap them correctly. I suspect what is happening is that the entity data for your prefab during baking (just two ints) is the same as the system entity for the ecb-system so that you do not get an error but instantiate this entity instead.
I suggest you store your nodes during baking in a dynamic buffer {int2, Node} and rebuild the map in the ISystem.

5

Oh, that makes a lot of sense. Didn’t know about this dynamic buffer thing. Gonna research about how to use them and give it a go. Thanks for your time!

6

It worked!
You’re awesome. Thanks again!

7

Just a quick thing to add in, if you are modifying an authoring component in a baker, that’s usually a sign that you are doing something wrong. All authoring data should be treated as read-only while baking.

8

Yeah, I was thinking about that actually. To be honest I’m not feeling confortable with how I did it because it sure looks like a hack. I’m thinking about doing something like a “prefab entity” class that has a GameObject field and bakes that into an Entity field, and try to access that from the Systems when needed somehow. Are there “best practices” to be followed about that?

9

Probably this: https://github.com/Unity-Technologies/EntityComponentSystemSamples/tree/master/EntitiesSamples/HelloCube/Assets/4.%20Prefabs

If you don’t believe that maps well to what you are trying to do, you may need to spend some time explaining what you are doing differently and what challenges you face because of it.

10

What I’m trying to do has only one extra complexity when compared to the examples I’ve seen online. I don’t have the prefabs set anywhere.

My understanding of the baking process is that it only works if you have a GameObject field in a MonoBehaviour, then you set up a Baker for that MonoBehavior, and in that baker you set the Entity field of the Component struct to GetEntity(authoring.prefab).

In my case I’m not dragging the prefabs to some GameObject field anywhere, because my prefabs are loaded dynamically using Resources.LoadAll.

In other words, I need a way to convert from GameObject to Entity at runtime, but the “GetEntity()” function is only present inside the Baker, which won’t even fire in my case.

After I get the list from Resources.LoadAll, I don’t know how to convert those prefabs into entities.

That’s why I tried to use a baker function from a singleton that exists in the editor, so it actually runs it’s baker, to convert the dynamically loaded assets into Entities.

It’s working, but I agree that it’s hacky and ugly. I’m sure there is a proper way of doing this, but I don’t know any at the moment.

11

No such thing. It is Editor or bust, unless you use a custom runtime conversion workflow and skip subscene and built-in baking altogether.

Why are you loading them this way? Unity has some mechanisms for entities related to this which may be useful: https://docs.unity3d.com/Packages/com.unity.entities@1.0/manual/content-management.html

12

I’m loading them this way because they are the tiles of the map. The idea is to have many different tiles, hundreds of them. I have a json file that tells the game which ones to load, since not every player will use every tile… so there’s no need to load lots of them when they won’t even get used ingame. And, even if I ignore that, having to manually keep adding new tiles to like a “tile manager” that has a “tile list” dont seem to be a practical way of doing this, if I can get them on demand from the Resources. Gonna check out that documentation though and see if there’s something that can be of help. Thanks for the ideas!

13

Do they all have to be prefabs? If not you could create one (or multiple if you have groups) prefab entity via baking and only load/populate the data during runtime. For a very basic example instead of a green forest tile prefab and a blue sea tile prefab you could have a tile prefab and the color gets set at runtime.

14

hmmm I actually have only 3 types of tiles. Tiles, Spawners and Goals. The difference between them (of the same type) is only the material actually… Maybe I can do something like you said. Gonna give it a go. Thanks!