Улучшаем ваш Unity проект. Гайд по ECS для MonoBehavior разработчиков

• Job System - Пишите многопоточный код, даже если вы не знаете что такое "Race condition" или "Context switch".

• Burst Compiler - Ускорьте код в 10 раз, просто добавив атрибут и отказавшись от ссылочных типов.

• Unity Mathematics - Специальная математика, адаптированная под компилятор Burst.

• Native Container - Обертка над неуправляемой памятью. Это такие же List, Array, Queue, но живут в мире без мусора. Мусор - это ваш код. Мусор - это то, что могут оставлять после себя мертвые ссылочные типы. Сборкой мусора в проекте занимается некий дворник - Garbage Collector, но он очень медленный и злой дядька . Да и Greenpeace советует убирать после себя трупы, не правда ли?

Entity - это все, что вас окружает. Ваша кошка, сын маминой подруги, пицца - это все entity.

Component - это то, что делает ваш Entity особенным. У кошки есть хвост, у сына маминой подруги - мозги, у пиццы - кетчуп. Это все - компоненты.

System - логика, которая управляет всеми entity, у которых есть тот или иной набор компонентов. Хвост помогает всем кошкам балансировать в пространстве, мозги помогают всем сыновьям маминой подруги быть круче вас, а кетчуп позволяет любой пицце быть вкусной.

ECS.ME - потрясающий ECS фреймворк для Unity, приготовленный для сетевых игр с элементом отката (RollBack). Эдакий некоммерческий аналог Quantum от Exit Games. Рецепт очень-очень крутой и вкусный. Но чтобы rollback не дал трещину, нужно четко следовать правилам данного фреймворка.

EgoECS - ECS фреймворк с сильнейшей интеграцией в Unity. С его помощью можно готовить MonoBehavior в качестве компонентов. Если вам не важна скорость работы, EgoECS выглядит весьма хорошим рецептом. Каждая система - это всего 1 фильтр, кому-то такой подход может скручивать руки при написании кода.

Svelto ECS - очень амбициозный рецепт, с очень сложным API. Но я должен был его упомянуть. Скорее всего он не подходит новичкам, но если вы заинтересовались, то на habr существует перевод Wiki данного фреймворка.

Actors - изначально разрабатывался как набор утилит. В рецепте присутствует шина событий(глобальный ивенты), которая может нарушить порядок вызовов функций и никак не относится к ECS. Реактивщина в ECS может сбить вас с толку при поиске багов / ошибок в вашей игре.

    void Update()
    {
        var position = transform.localPosition;
        transform.localPosition = new Vector3(position.x, position.y, position.z + 1);
    }

    public void Run()
    {
        for (int idx = 0, idxMax = _filter.GetEntitiesCount(); idx < idxMax; idx++)
        {
            ref var move = ref _filter.Get1(idx);
            move.vec.z += 1;
            move.trans.localPosition = move.vec;
        }
    }

R

    public void Run()
    {
        var newJob = new MoveJob {
            moveVector = Vector3.forward
        };
        var handle = newJob.Schedule(this.transforms);
        // JobHandle.ScheduleBatchedJobs();
        handle.Complete();
     }

[BurstCompile] // Атрибут Burst не увеличил производительность. 
public struct MoveJob : IJobParallelForTransform {
    public Vector3 moveVector;
    public void Execute(int index, TransformAccess transform) => transform.position += this.moveVector;
}

Добавьте ссылку в Packages/manifest.json

"com.leopotam.ecs": "https://github.com/Leopotam/ecs.git",
"com.voody.UniLeo": "https://github.com/voody2506/UniLeo.git",

Или Unity Editor -> Window -> Package Manager

using Leopotam.Ecs;

using Voody.UniLeo;

[Serializable] // <- Данный атрибут необходим, чтобы управлять компонентом из редактора

public struct PlayerComponent {    

 public float health; 

}

[Serializable]

public struct UnityExampleComponent {    

 public Rigidbody rigidBody; 

 public Transform transform

 public GameObject unityObject 

}

public sealed class PlayerComponentProvider : MonoProvider<PlayerComponent> { }

class PlayerHealthSystem : IEcsInitSystem, IEcsRunSystem {
    // Переменная _world автоматически инициализируется
    EcsWorld _world = null;
    // В фильтре просто описываем с каким компонентом 
    будет работать система 
    EcsFilter<PlayerComponent> _filter = null;

    public void Init () {
    		// Сработает на старте
    }

    public void Run () {
        foreach (var i in _filter) {
            // entity которые содержат PlayerComponent.
            ref var entity = ref _filter.GetEntity (i); 

            // Get1 вернет ссылку на "PlayerComponent".
            ref var player = ref _filter.Get1 (i);
            player.helth = player.helth - 10; 
        }
    }
}

class Startup : MonoBehaviour {
    EcsWorld _world;
    EcsSystems _systems;

    void Start () {
        // create ecs environment.
        _world = new EcsWorld ();
        _systems = new EcsSystems (_world)
            .ConvertScene() // Этот метод сконвертирует GO в Entity
            .Add (new PlayerHealthSystem ());
        _systems.Init ();
    }
    
    void Update () {
        // process all dependent systems.
        _systems.Run ();
    }

    void OnDestroy () {
        // destroy systems logical group.
        _systems.Destroy ();
        // destroy world.
        _world.Destroy ();
    }
}

Convert And Inject - Создаст entity на основе компонентов, повешанных на игровой объект.

Convert And Destroy - После превращения GO в Entity , объект автоматически удалится. Может быть полезно, когда необходимо просто добавить определенные компоненты в ECS мир..

Вы можете порождать prefab любым известным вам способом, конвертация пройдет автоматически.

GameObject.Instantiate(gameObject, position, rotation);
PhotonNetwork.Instantiate <- рабоатет и в сторонних библиотеках

В ECS всё - данные . Ивенты тоже, необходимо просто создать компонент и запустить его в нужный момент. Ну и создать систему, которая бы реагировала на этот ивент.

// MonoBehavior 
void OnCollisionEnter(Collision collision)
{
		// Создаем новый entity и добавляем компонент
    // Переменная _world хранится в Startup классе
    EcsEntity entity = _world.NewEntity (); 
    var event = new EventComponent ();
		entity.Replace (event);
  
  	// Теперь просто можно перехватить этот ивент в любой системе

}

В ECS очень важно не нарушать порядок, при котором выполняются системы, асинхронное срабатывание может привести к большим проблемам в будущем.

Очень часто ивент-компоненты нужно очищать в конце кадра, для этого в LeoECS есть готовый механизм.

void Start () {
    var world = new EcsWorld ();
    _update = new EcsSystems (world);
    _update
        .Add (new CalculateSystem ())
        .Add (new UpdateSystem ())
        .OneFrame<EventComponent> () // Этот компонент удалится
        											  самостоятельно в этот момент времени
        .Init ();
}

У Leo ECS есть готовая интеграция , которая позволяет запускать системы в разных потоках. Она не использует Job System и Burst Compiler , а использует стандартную библиотеку System.Threading.

Но вы вполне можете использовать и пакеты от компании Unity, они дадут намного больше производительности, но интеграция с ними не так легка.

На хабре уже существует отличный пост про Job систему. Вам необходимо вызвать ее внутри ваших Run методов в LeoECS.

Пример работы с Job System есть выше, в разделе про тестирование.

Готовой интеграции для LeoECS с популярными сетевыми библиотеками на данный момент не существует, но передача данных осуществляется через ивенты, а как работать с ивентами я уже отвечал.

В любом случается, на данный момент вам придется самостоятельно придумать как лучше всего интегрировать то или иное решение с ECS.