AlicizaX/DragonECS
1
0
Fork 0
mirror of https://github.com/DCFApixels/DragonECS.git synced 2025-09-18 01:44:35 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Mikhail 2023-05-29 03:06:47 +08:00 committed by GitHub
parent ae29615525
commit 2a8a511bf2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -17,6 +17,7 @@
* [Концепции фреймворка](#Концепции-фреймворка) * [Концепции фреймворка](#Концепции-фреймворка)
* [Pipeline](#Pipeline) * [Pipeline](#Pipeline)
* [Процесс](#Процесс) * [Процесс](#Процесс)
* [World](#World)
* [Группа](#Группа) * [Группа](#Группа)
* [Субъект](#Субъект) * [Субъект](#Субъект)
* [Запрос](#Запрос) * [Запрос](#Запрос)
@ -42,7 +43,7 @@ https://github.com/DCFApixels/DragonECS.git
* `entlong` - долговременный идентификатор, содержит в себе полный набор информации для однозначной идентификации; * `entlong` - долговременный идентификатор, содержит в себе полный набор информации для однозначной идентификации;
## Component ## Component
Компоненты - это данные для сущностей. Обязаны реализовывать интерфейс IEcsComponent или другой указываюший вид компонента. Компоненты - это данные для сущностей. Обязаны реализовывать интерфейс IEcsComponent или другой указываюший вид компонента.
```c# ```c#
struct Health : IEcsComponent struct Health : IEcsComponent
{ {
@ -50,7 +51,7 @@ struct Health : IEcsComponent
public int armor; public int armor;
} }
``` ```
### Виды компонентов ### Встроенные виды компонентов
* `IEcsComponent` - Компоненты с данными. * `IEcsComponent` - Компоненты с данными.
* `IEcsTagComponent` - Компоненты-теги. Без данных. * `IEcsTagComponent` - Компоненты-теги. Без данных.
@ -76,13 +77,13 @@ class UserSystem : IEcsPreInitProcess, IEcsInitProcess, IEcsRunProcess, IEcsDest
``` ```
# Концепции фреймворка # Концепции фреймворка
## Pipeline ## Pipeline
Является контейнером и двжиком систем, определяя поочередность их вызова, предоставляющий механизм для сообщений между системами и механизм внедрения зависимостей в системы. Класс EcsPipeline является контейнером и двжиком систем, определяя поочередность их вызова, предоставляющий механизм для сообщений между системами и механизм внедрения зависимостей в системы.
## Процесс ## Process
Процессы - это очереди систем реализующие общий интерфейс. Раннеры запускюат выполнение процессов. Система раннеров и процессов может использоваться для создания реактивного поведения или для управления очередью вызова систем. Встроенные процессы вызываются автоматически, для ручного запуска испольщуйте раннеры получаемые из EcsPipeline.GetRunner<TInterface>(). Процессы - это очереди систем реализующие общий интерфейс, например IEcsRunProcess. Для запуска процессов используются Runner-ы. Система ранеров и процессов может использоваться для создания реактивного поведения или для управления очередью вызова систем. Встроенные процессы вызываются автоматически, для ручного запуска испольщуйте раннеры получаемые из EcsPipeline.GetRunner<TInterface>().
> Метод GetRunner относительно медленный, поэтому рекомендуется кешировать полученные раннеры. > Метод GetRunner относительно медленный, поэтому рекомендуется кешировать полученные раннеры.
Встроенные процессы: ### Встроенные процессы:
* `IEcsPreInitProcess`, `IEcsInitProcess`, `IEcsRunProcess`, `IEcsDestroyProcess` - процессы жизненого цикла Pipeline * `IEcsPreInitProcess`, `IEcsInitProcess`, `IEcsRunProcess`, `IEcsDestroyProcess` - процессы жизненого цикла Pipeline
* `IEcsPreInject`, `IEcsInject<T>` - процессы системы внедрения зависимостей для Pipeline. Через них прокидываются зависимости * `IEcsPreInject`, `IEcsInject<T>` - процессы системы внедрения зависимостей для Pipeline. Через них прокидываются зависимости
* `IEcsPreInitInjectProcess` - Так же процесс системы внедрения зависимостей, но работает в пределах до выполнения IEcsInitProcess, сигнализирует о инициализации предварительных внедрений и окончании. * `IEcsPreInitInjectProcess` - Так же процесс системы внедрения зависимостей, но работает в пределах до выполнения IEcsInitProcess, сигнализирует о инициализации предварительных внедрений и окончании.
@ -105,6 +106,9 @@ public sealed class EcsRunRunner : EcsRunner<IEcsRunProcess>, IEcsRunProcess
> * Наследуемый класс `EcsRunner<TInterface>,` в качестве `TInterface` должен принимать реализованный интерфейс; > * Наследуемый класс `EcsRunner<TInterface>,` в качестве `TInterface` должен принимать реализованный интерфейс;
> * Раннер не может быть размещен внутри другого класса. > * Раннер не может быть размещен внутри другого класса.
## World
Является контейнером для сущностей и компонентов.
## Группа ## Группа
Группы это структуры данных для хранения списка сущностей и с быстрыми операциями добавления/удаления/проверки наличия и т.д. Реализованы классом EcsGroup и структурой EcsReadonlyGroup. Группы это структуры данных для хранения списка сущностей и с быстрыми операциями добавления/удаления/проверки наличия и т.д. Реализованы классом EcsGroup и структурой EcsReadonlyGroup.