mirror of
https://github.com/DCFApixels/DragonECS.git
synced 2025-09-18 01:44:35 +08:00
Update README-RU.md
This commit is contained in:
Mikhail
GitHub
parent
f74a2dbf15
commit
9d159ca37a
97
README-RU.md
97
README-RU.md
@ -20,20 +20,23 @@
|
||||
* [Установка](#Установка)
|
||||
* [Unity-модуль](#Unity-модуль)
|
||||
* [В виде иходников](#В-виде-иходников)
|
||||
* [Версионирование](#Версионирование)
|
||||
* [Версионирование](#Версионирование)
|
||||
* [Основные концепции](#Основные-концепции)
|
||||
* [Entity](#Entity)
|
||||
* [Component](#Component)
|
||||
* [System](#System)
|
||||
* [Концепции фреймворка](#Концепции-фреймворка)
|
||||
* [Пайплайн](#Пайплайн)
|
||||
* [Построение](#Построение)
|
||||
* [Внедрение зависимостей](#Внедрение-зависимостей)
|
||||
* [Модули](#Модули)
|
||||
* [Слои](#Слои)
|
||||
* [Процессы](#Процессы)
|
||||
* [Мир](#Мир)
|
||||
* [Группа](#Группа)
|
||||
* [Субъект](#Субъект)
|
||||
* [Запрос](#Запрос)
|
||||
* [Модули](#Модули)
|
||||
* [Рекомендации](#Рекомендации)
|
||||
* [Debug](#Debug)
|
||||
* [Атрибуты](#Атрибуты)
|
||||
* [Debug-Сервис](#Debug-Сервис)
|
||||
@ -48,14 +51,50 @@ https://github.com/DCFApixels/DragonECS.git
|
||||
* ### В виде иходников
|
||||
Фреймворк так же может быть добавлен в проект в виде исходников.
|
||||
|
||||
# Версионирование
|
||||
### Версионирование
|
||||
В DragonECS применяется следующая семантика версионирования: [Открыть](https://gist.github.com/DCFApixels/e53281d4628b19fe5278f3e77a7da9e8#%D0%B2%D0%B5%D1%80%D1%81%D0%B8%D0%BE%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5)
|
||||
|
||||
# Основные концепции
|
||||
## Entity
|
||||
**Сущности** - это то к чему крепятся данные. Реализованны в виде идентификаторов, которых есть 2 вида:
|
||||
* `int` - однократный идентификатор, применяется в пределах одного тика. Не рекомендуется хранить `int` идентификаторы, в место этого используйте `entlong`;
|
||||
* `entlong` - долговременный идентификатор, содержит в себе полный набор информации для однозначной идентификации;
|
||||
``` csharp
|
||||
// Создаие новой сущности в мире.
|
||||
int entityID = _world.NewEmptyEntity();
|
||||
|
||||
// Удаление сушности.
|
||||
_world.DelEntity(entityID);
|
||||
|
||||
// Копирование компонентов одной сущности в другую.
|
||||
_world.CopyEntity(entityID, otherEntityID);
|
||||
|
||||
// Клонирование сущности.
|
||||
int newEntityID = _world.CloneEntity(entityID);
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>Работа с entlong</summary>
|
||||
|
||||
``` csharp
|
||||
// конвертация int в entlong.
|
||||
entlong entity = _world.GetEntityLong(entityID);
|
||||
// или
|
||||
entlong entity = entityID.ToEntityLong(_world);
|
||||
|
||||
// Проверка что сущность еще жива
|
||||
if (entity.IsAlive) { }
|
||||
|
||||
// Конвертация entlong в int. Если сущность уже не существует, будет брошено исключение.
|
||||
int entityID = entity.ID;
|
||||
|
||||
// Конвертация entlong в int. Вернет true и ее int идентификатор, если сущность еще жива.
|
||||
if (entity.TryGetID(out int entityID)) { }
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
> ВАЖНО! Сущности не могут существовать без компонентов, пустые сущности будут автоматически удаляться сразу после удаления последнего компонента либо в конце тика.
|
||||
## Component
|
||||
**Компоненты** - это данные для сущностей. Обязаны реализовывать интерфейс `IEcsComponent` или другой указываюший вид компонента.
|
||||
```c#
|
||||
@ -89,14 +128,13 @@ class SomeSystem : IEcsPreInitProcess, IEcsInitProcess, IEcsRunProcess, IEcsDest
|
||||
public void Destroy (EcsPipeline pipeline) { }
|
||||
}
|
||||
```
|
||||
> Для реализации дополнительных процессов перейдите к разделу [Процессы](#Процессы)
|
||||
> Для реализации дополнительных процессов перейдите к разделу [Процессы](#Процессы).
|
||||
# Концепции фреймворка
|
||||
## Пайплайн
|
||||
Является контейнером и двжиком систем, определяя поочередность их вызова, предоставляющий механизм для сообщений между системами и механизм внедрения зависимостей в системы.
|
||||
Является контейнером и двжиком систем, определяя поочередность их вызова, предоставляющий механизм для сообщений между системами и механизм внедрения зависимостей. Реализован в виде класса `EcsPipeline`.
|
||||
### Построение
|
||||
За построение пайплайна отвечает Builder. В Builder добавляются системы, а в конце строится пайплайн. Пример:
|
||||
```c#
|
||||
const string SOME_LAYER = nameof(SOME_LAYER);
|
||||
EcsPipelone pipeline = EcsPipeline.New() //Создает Builder пайплайна
|
||||
// Добавляет систему System1 в очередь систем
|
||||
.Add(new System1())
|
||||
@ -109,21 +147,6 @@ EcsPipelone pipeline = EcsPipeline.New() //Создает Builder пайплай
|
||||
pipeline.Init(); // Инициализация пайплайна
|
||||
```
|
||||
> Есть упрощенная инициализация пайплайна сразу в момент построение, для используйте Builder.BuildAndInit();
|
||||
### Слои
|
||||
Очередь систем можно разбить на слои
|
||||
``` c#
|
||||
EcsPipelone pipeline = EcsPipeline.New()
|
||||
//...
|
||||
.Layers.Insert(EcsConsts.END_LAYER, SOME_LAYER) // Вставляет новый слой перед конечным слоем EcsConsts.END_LAYER
|
||||
//...
|
||||
.BuildAndInit();
|
||||
```
|
||||
Встроенные слои расположены в следующем порядке:
|
||||
* `EcsConst.PRE_BEGIN_LAYER`
|
||||
* `EcsConst.BEGIN_LAYER`
|
||||
* `EcsConst.BASIC_LAYER` (Если при добавблении системы не казать слой, то она будет доавблена сюда)
|
||||
* `EcsConst.END_LAYER`
|
||||
* `EcsConst.POST_END_LAYER`
|
||||
### Внедрение зависимостей
|
||||
Внедрение зависимостей - это процесс который запускается вместе с инициализацией пайплайна и внедряет данные переданные в Builder.
|
||||
``` c#
|
||||
@ -142,7 +165,7 @@ class Module : IEcsModule
|
||||
public void Import(EcsPipeline.Builder b)
|
||||
{
|
||||
b.Add(new System1());
|
||||
b.Add(new System2(), EcsConsts.END_LAYER);
|
||||
b.Add(new System2(), EcsConsts.END_LAYER); // данная система будет добавлена в слой EcsConsts.END_LAYER
|
||||
b.Add(new System3());
|
||||
}
|
||||
}
|
||||
@ -154,17 +177,37 @@ EcsPipelone pipeline = EcsPipeline.New()
|
||||
//...
|
||||
.BuildAndInit();
|
||||
```
|
||||
### Слои
|
||||
Очередь систем можно разбить на слои. Слой определяет место в очереди для вставки систем. Если необходимо чтобы какая-то система была вставлена в конце очереди, внезависимости от места добавления, эту систему можно добавить в слой EcsConsts.END_LAYER.
|
||||
``` c#
|
||||
const string SOME_LAYER = nameof(SOME_LAYER);
|
||||
EcsPipelone pipeline = EcsPipeline.New()
|
||||
//...
|
||||
.Layers.Insert(EcsConsts.END_LAYER, SOME_LAYER) // Вставляет новый слой перед конечным слоем EcsConsts.END_LAYER
|
||||
//...
|
||||
.BuildAndInit();
|
||||
```
|
||||
Встроенные слои расположены в следующем порядке:
|
||||
* `EcsConst.PRE_BEGIN_LAYER`
|
||||
* `EcsConst.BEGIN_LAYER`
|
||||
* `EcsConst.BASIC_LAYER` (Если при добавблении системы не казать слой, то она будет доавблена сюда)
|
||||
* `EcsConst.END_LAYER`
|
||||
* `EcsConst.POST_END_LAYER`
|
||||
|
||||
## Процессы
|
||||
Процессы - это очереди систем реализующие общий интерфейс, например IEcsRunProcess. Для запуска процессов используются Runner-ы. Система ранеров и процессов может использоваться для создания реактивного поведения или для управления очередью вызова систем. Встроенные процессы вызываются автоматически, для ручного запуска испольщуйте раннеры получаемые из EcsPipeline.GetRunner<TInterface>().
|
||||
> Метод GetRunner относительно медленный, поэтому рекомендуется кешировать полученные раннеры.
|
||||
|
||||
### Встроенные процессы:
|
||||
<details>
|
||||
<summary>Встроенные процессы:</summary>
|
||||
|
||||
* `IEcsPreInitProcess`, `IEcsInitProcess`, `IEcsRunProcess`, `IEcsDestroyProcess` - процессы жизненого цикла Pipeline
|
||||
* `IEcsPreInject`, `IEcsInject<T>` - процессы системы внедрения зависимостей для Pipeline. Через них прокидываются зависимости
|
||||
* `IEcsPreInject`, `IEcsInject<T>` - процессы системы [внедрения зависимостей](#Внедрение-зависимостей) для Pipeline.
|
||||
* `IEcsPreInitInjectProcess` - Так же процесс системы внедрения зависимостей, но работает в пределах до выполнения IEcsInitProcess, сигнализирует о инициализации предварительных внедрений и окончании.
|
||||
|
||||
### Пользовательские Раннеры и Процессы
|
||||
</details>
|
||||
|
||||
### Пользовательские Процессы
|
||||
Для добавления нового процесса создайте интерфейс наследованный от IEcsSystem и создайте раннер для него. Раннеры это классы реализующие интерфейс запускаемого процесса и наследуемые от EcsRunner<TInterface>. Пример реализации раннера для IEcsRunProcess:
|
||||
```c#
|
||||
public sealed class EcsRunRunner : EcsRunner<IEcsRunProcess>, IEcsRunProcess
|
||||
@ -200,10 +243,6 @@ public sealed class EcsRunRunner : EcsRunner<IEcsRunProcess>, IEcsRunProcess
|
||||
## Запросы
|
||||
Используйте метод-запрос `EcsWorld.Where<TSubject>(out TSubject subject)` для получения необходимого системе набора сущностей. Запросы работают в связке с субъектами, субъекты определяют ограничения запросов, результатом запроса становится группа сущностей удовлетворяющия условиям субъекта. По умолчанию запрос делает выборку из всех сущностей в мире, но так же можно сделать выборку из определенной группы сущностей, для этого используйте `EcsWorld.WhereFor<TSubject>(EcsReadonlyGroup sourceGroup, out TSubject subject)`
|
||||
|
||||
# Рекомендации
|
||||
## Рекомендации по реаоизации систем
|
||||
Системы делать максимально независимыми, без ссылок на другие системы.
|
||||
|
||||
# Debug
|
||||
Фреймворк предоставляет дополнительные интрументы для отладки и логирования, не зависящие от среды.
|
||||
## Атрибуты
|
||||
|
||||
Loading…
Reference in New Issue
Block a user