Работа с entlong
+ ``` c# // Конвертация int в entlong. entlong entity = _world.GetEntityLong(entityID); -// или +// упрощенная версия entlong entity = (_world, entityID); // Проверка что сущность еще жива. @@ -148,6 +174,8 @@ if (entity.TryGetID(out int entityID)) { } ```
+
+{
+ // Аспекты описаны в соответствующей главе
+ class Aspect : EcsAspect
+ {
+ public EcsPool DamageRequests = Inc;
+ public EcsPool Healths = Inc;
+ }
+ // Мир - хранилище сущностей, так же описан в соответствующей главе
+ EcsDefaultWorld world;
+ // Процесс Run
+ public void Run()
+ {
+ // Итерируемся по сущностям, в рамках Run можно использовать int идентификаторы сущностей
+ foreach (int e in world.Where(out Aspect a))
+ {
+ // Логика нанесения урона
+ a.Healths[e].Points -= a.DamageRequests[e].Points;
+ }
+ }
+ // Процесс Inject. Получение инстанса EcsDefaultWorld
+ void IEcsInject.Inject(EcsDefaultWorld obj) => world = obj;
+}
+// Компоненты
+public struct DamageRequest : IEcsComponent
+{
+ public float Points;
+}
+public struct Health : IEcsComponent
+{
+ public float Points;
+}
+```
+
+
+
# Концепции фреймворка
@@ -466,10 +536,13 @@ poses.Del(entityID);
## Маска
-Применяется для фильтрации сущностей по наличию или отсутствию компонентов.
+Набор требований к компонентам сущности: какие компоненты должны присутствовать, а какие отсутствовать. Маска — это просто данные, она не выполняет поиск, а используется запросами для фильтрации сущностей.
+
+Обычно маски не используются в чистом виде, а являются частью [Аспекта](#Аспект).
+
``` c#
-// Создание маски которая проверяет что у сущностей есть компоненты
-// SomeCmp1 и SomeCmp2, но нет компонента SomeCmp3.
+// Создание маски с улосвием наличия компонентов SomeCmp1 и SomeCmp2,
+// и с улосвием отсутсвия компонента SomeCmp3.
EcsMask mask = EcsMask.New(_world)
// Inc - Условие наличия компонента.
.IncПример системы
+ + +``` c# +// Система +class DamageSystem : IEcsRun, IEcsInject
- poses;
public EcsPool velocities;
protected override void Init(Builder b)
{
- poses = b.Include();
- velocities = b.Include();
- b.Exclude();
+ poses = b.IncludePool();
+ velocities = b.IncludePool();
+ b.ExcludePool();
}
}
```
@@ -546,10 +624,8 @@ class Aspect : EcsAspect
(1);
// Хотя для OtherAspect1 метод Combine был вызван раньше, сначала будет скомбинирован с OtherAspect2, так как по умолчанию order = 0.
otherAspect2 = b.Combine();
- // Если в OtherAspect1 или в OtherAspect2 было ограничение b.Exclude() тут оно будет заменено на b.Include().
+ // Если в OtherAspect1 или в OtherAspect2 было условие b.Exclude() тут оно будет заменено на b.Include().
poses = b.Include();
}
}
@@ -578,11 +654,11 @@ class Aspect : EcsAspect
## Запросы
-Фильтруют сущности и выдают коллекции сущностей удовлетворяющие определенным условиям. Встроенный запрос `Where` фильтрует на соответствие условиям маски компонентов и имеет несколько перегрузок:
+Запросы позволяют отфильтровать и получать коллекции сущностей, удовлетворяющих заданным условиям. Основной метод — `Where`, который фильтрует по маске компонентов и имеет несколько перегрузок:
++ `EcsWorld.Where(out TAspect aspect)` - Фильтрация по маске, определённой в аспекте, плюс получение самого аспекта с закешированными пулами.
+ `EcsWorld.Where(EcsMask mask)` - Обычная фильтрация по маске;
-+ `EcsWorld.Where(out TAspect aspect)` - Сочетает в себе фильтрацию по маске из аспекта и получение аспекта;
-Запрос `Where` применим как к `EcsWorld` так и коллекциям фреймворка (в этом плане Where чем-то похож на аналогичный из Linq). Так же имеются перегрузки для сортировки сущностей по `Comparison`.
+`Where` можно вызывать не только у мира, но и у любых коллекций фреймворка (в этом плане Where чем-то похож на аналогичный из Linq). Также доступны перегрузки для сортировки сущностей с помощью `Comparison`.
Пример системы:
``` c#
@@ -597,10 +673,9 @@ public class SomeDamageSystem : IEcsRun, IEcsInject
public EcsTagPool isDiedSignals = Opt;
}
EcsDefaultWorld _world;
- public void Inject(EcsDefaultWorld world) => _world = world;
-
public void Run()
{
+ // Запрашиваем сущности удовлетворяющее маске из Aspect
foreach (var e in _world.Where(out Aspect a))
{
// Сюда попадают сущности с компонентами Health, DamageSignal и без IsInvulnerable.
@@ -615,6 +690,7 @@ public class SomeDamageSystem : IEcsRun, IEcsInject
}
}
}
+ public void Inject(EcsDefaultWorld world) => _world = world;
}
```
@@ -623,7 +699,7 @@ public class SomeDamageSystem : IEcsRun, IEcsInject
## Коллекции
### EcsSpan
-Коллекция сущностей, доступная только для чтения и выделяемая только в стеке. Состоит из ссылки на массив, длинны и идентификатора мира. Аналог `ReadOnlySpan`.
+`ref struct` коллекция сущностей, доступная только для чтения. Состоит из ссылки на массив, длинны и идентификатора мира. Аналог `ReadOnlySpan`.
``` c#
// Запрос Where возвращает сущности в виде EcsSpan.
EcsSpan es = _world.Where(out Aspect a);
@@ -641,7 +717,7 @@ for (int i = 0; i < es.Count; i++)
> Хотя `EcsSpan` является просто массивом, в нем не допускается дублирование сущностей.
### EcsGroup
-Вспомогательная коллекция основанная на Sparse Set для хранения множества сущностей с O(1) операциями добавления/удаления/проверки и т.д.
+Вспомогательная коллекция основанная на Sparse Set для хранения множества сущностей с `O(1)` операциями добавления/удаления/проверки и т.д.
``` c#
// Получаем новую группу. EcsWorld содержит в себе пул групп,
// поэтому будет переиспользована свободная или создана новая.
@@ -1011,6 +1087,23 @@ public struct WorldComponent : IEcsWorldComponent
## Опубликованные проекты:
+
-# Расширения
-* Пакеты:
- * [Интеграция с движком Unity](https://github.com/DCFApixels/DragonECS-Unity)
- * [Автоматическое внедрение зависимостей](https://github.com/DCFApixels/DragonECS-AutoInjections)
- * [Классическая C# многопоточность](https://github.com/DCFApixels/DragonECS-ClassicThreads)
- * [Recursivity](https://github.com/DCFApixels/DragonECS-Recursivity)
- * [Hybrid](https://github.com/DCFApixels/DragonECS-Hybrid)
- * [Графы](https://github.com/DCFApixels/DragonECS-Graphs)
-* Утилиты:
- * [Упрощенный синтаксис](https://gist.github.com/DCFApixels/d7bfbfb8cb70d141deff00be24f28ff0)
- * [Однокадровые компоненты](https://gist.github.com/DCFApixels/46d512dbcf96c115b94c3af502461f60)
- * [Шаблоны кода IDE](https://gist.github.com/ctzcs/0ba948b0e53aa41fe1c87796a401660b) и [для Unity](https://gist.github.com/ctzcs/d4c7730cf6cd984fe6f9e0e3f108a0f1)
-> *Твое расширение? Если разрабатываешь расширение для DragonECS, пиши [сюда](#обратная-связь).
-
-
# FAQ
+
## 'ReadOnlySpan<>' could not be found
В версии Unity 2020.1.х в консоли может выпадать ошибка:
```
diff --git a/README-ZH.md b/README-ZH.md
index 7266641..6e6777c 100644
--- a/README-ZH.md
+++ b/README-ZH.md
@@ -19,7 +19,7 @@
-
+
Русский
@@ -31,7 +31,7 @@
-
+
中文
diff --git a/README.md b/README.md
index 8edb090..c3f9193 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,7 @@
-
+
Русский
@@ -33,7 +33,7 @@
-
+
中文
Явный синтаксис (результат идентичен примеру выше):
+Инициализация через метод (результат идентичен примеру выше):
``` c# -using DCFApixels.DragonECS; -// ... class Aspect : EcsAspect { public EcsPoolКомбинирование аспектов
-В аспекты можно добавлять другие аспекты, тем самым комбинируя их. Ограничения так же будут скомбинированы. +В аспекты можно добавлять другие аспекты, тем самым комбинируя их. Маски так же будут скомбинированы. ``` c# -using DCFApixels.DragonECS; -// ... class Aspect : EcsAspect { public OtherAspect1 otherAspect1; @@ -562,7 +638,7 @@ class Aspect : EcsAspect otherAspect1 = b.Combine|
+
+ Crystal Siege
+ |
+
+
+ Order matters
+ |
+
|
@@ -1019,33 +1112,17 @@ public struct WorldComponent : IEcsWorldComponent |
-
- ㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤ
+ _____________
|