Entity

Сущность - служит для идентификации объекта в игровом мире и доступа к прикрепленным компонентам

• Представлена в виде структуры размером 4 байт

---

Создание:

// Создание одной сущности

// Способ 1 - создание "пустой" сущности
W.Entity entity = W.Entity.New();

// Способ 2 - с указанием типа компонента (методы перегрузки от 1-5 компонентов)
W.Entity entity = W.Entity.New<Position>();
W.Entity entity = W.Entity.New<Position, Velocity, Name>();

// Способ 3 - с указанием значения компонента (методы перегрузки от 1-8 компонентов)
W.Entity entity = W.Entity.New(new Position(x: 1, y: 1, z: 2));
W.Entity entity = W.Entity.New(
            new Name { Val = "SomeName" },
            new Velocity { Val = 1f },
            new Position { Val = Vector3.One }
);

// Создание множества сущностей
// Способ 1 - с указанием типа компонента (методы перегрузки от 1-5 компонентов)
uint count = 100;
W.Entity.NewOnes<Position>(count);

// Способ 2 - с указанием типа компонента (методы перегрузки от 1-5 компонентов) + делегата инициализации каждой сущности
uint count = 100;
W.Entity.NewOnes<Position>(count, static entity => {
    // some init logic for each entity
});

// Способ 3 - с указанием значения компонента (методы перегрузки от 1-5 компонентов)
uint count = 100;
W.Entity.NewOnes(count, new Position(x: 1, y: 1, z: 2));

// Способ 4 - с указанием значения компонента (методы перегрузки от 1-5 компонентов) + делегата инициализации каждой сущности
uint count = 100;
W.Entity.NewOnes(count, new Position(x: 1, y: 1, z: 2), static entity => {
    // some init logic for each entity
});

// При создании сущности можно передать идентификатор кластера (по умолчанию сущность создается в дефолтном кластере W.DEFAULT_CLUSTER = 0)
var npc = W.Entity.New(clusterId: W.DEFAULT_CLUSTER);

// Попытаться создать сущность в кластере, если мир зависим и в нем не осталось свободных идентификаторов сущностей то вернутся false
var created = W.Entity.TryNew(out var ent, clusterId: ENVIRONMENT_CLUSTER);

// Для всех перегрузок добавлен опциональный параметр идентификатора кластера
W.Entity.New(
    new Position(),
    new Name(),
    clusterId: NPC_CLUSTER
);

// При создании сущности можно передать индекс чанка (без указания, выбор чанка определяется миром)
var entity = W.Entity.New(chunkIdx: chunkIdx);

// Попытаться создать сущность в чанке, если чанк полон вернется false
var created = W.Entity.TryNew(out var ent, chunkIdx: chunkIdx);

---

Основные операции:

W.Entity entity = W.Entity.New(
            new Name { Val = "SomeName" },
            new Velocity { Val = 1f },
            new Position { Val = Vector3.One }
);

entity.Disable();                              // Отключить сущность (отключенная сущность по умолчанию не находится при запросах (смотри Query))
entity.Enable();                               // Включить сущность
      
bool enabled = entity.IsEnabled();             // Проверить включена ли сущность в мире
bool disabled = entity.IsDisabled();           // Проверить выключена ли сущность в мире
      
bool actual = entity.IsNotDestroyed();         // Проверить не уничтожена ли сущность в мире
short version = entity.Version();              // Получить версию сущности
W.Entity clone = entity.Clone();               // Клонировать сущность и все компоненты, теги
entity.Unload();                               // Выгрузить сущность из памяти
entity.Destroy();                              // Удалить сущность и все компоненты, теги
      
W.Entity entity2 = W.Entity.New<Name>();      
clone.CopyTo(entity2);                         // Копировать все компоненты, теги в указанную сущность
      
W.Entity entity3 = W.Entity.New<Name>();      
entity2.MoveTo(entity3);                       // Перенести все компоненты, теги в указанную сущность и удалить текущую
      
EntityGID gid = entity3.Gid();                 // Получить глобальный идентификатор сущности
      
var str = entity3.ToPrettyString;              // Получить строку со всей информацией о сущности

BoxedEntity<WorldType> boxed = entity3.Box();  // Получить класс-сущность реализующую IEntity

---

Дополнительно:

При инициализации мира можно передать функцию, которая будет выполняться при создании любой новой сущности

Пример:

W.Create(WorldConfig.Default());
//...
W.OnCreateEntity(entity => entity.Add<Position, Rotation, Scale>());
//...
W.Initialize();