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
d5c3fe4f84
commit
b06676e8a7
40
README-RU.md
40
README-RU.md
@ -56,14 +56,14 @@ https://github.com/DCFApixels/DragonECS.git
|
||||
|
||||
# Основные концепции
|
||||
## Entity
|
||||
**Сущности** - это то к чему крепятся данные. Реализованны в виде идентификаторов, которых есть 2 вида:
|
||||
**Сущности** - это то к чему крепятся данные. Реализованы в виде идентификаторов, которых есть 2 вида:
|
||||
* `int` - однократный идентификатор, применяется в пределах одного тика. Не рекомендуется хранить `int` идентификаторы, в место этого используйте `entlong`;
|
||||
* `entlong` - долговременный идентификатор, содержит в себе полный набор информации для однозначной идентификации;
|
||||
``` csharp
|
||||
// Создаие новой сущности в мире.
|
||||
// Создание новой сущности в мире.
|
||||
int entityID = _world.NewEmptyEntity();
|
||||
|
||||
// Удаление сушности.
|
||||
// Удаление сущности.
|
||||
_world.DelEntity(entityID);
|
||||
|
||||
// Копирование компонентов одной сущности в другую.
|
||||
@ -77,12 +77,12 @@ int newEntityID = _world.CloneEntity(entityID);
|
||||
<summary>Работа с entlong</summary>
|
||||
|
||||
``` csharp
|
||||
// конвертация int в entlong.
|
||||
// Конвертация int в entlong.
|
||||
entlong entity = _world.GetEntityLong(entityID);
|
||||
// или
|
||||
entlong entity = entityID.ToEntityLong(_world);
|
||||
|
||||
// Проверка что сущность еще жива
|
||||
// Проверка что сущность еще жива.
|
||||
if (entity.IsAlive) { }
|
||||
|
||||
// Конвертация entlong в int. Если сущность уже не существует, будет брошено исключение.
|
||||
@ -94,7 +94,7 @@ if (entity.TryGetID(out int entityID)) { }
|
||||
|
||||
</details>
|
||||
|
||||
> ВАЖНО! Сущности не могут существовать без компонентов, пустые сущности будут автоматически удаляться сразу после удаления последнего компонента либо в конце тика.
|
||||
> **NOTICE:** Сущности не могут существовать без компонентов, пустые сущности будут автоматически удаляться сразу после удаления последнего компонента либо в конце тика.
|
||||
## Component
|
||||
**Компоненты** - это данные для сущностей. Обязаны реализовывать интерфейс `IEcsComponent` или другой указываюший вид компонента.
|
||||
```c#
|
||||
@ -108,7 +108,7 @@ struct PlayerTag : IEcsTagComponent {}
|
||||
Встроенные виды компонентов:
|
||||
* `IEcsComponent` - Компоненты с данными.
|
||||
* `IEcsTagComponent` - Компоненты-теги. Без данных.
|
||||
> Компоненты-теги хоть и не имеют данных, само наличие или отсутсвие такого компонента у сущности уже несет ифномрацию и может применяться для определения типа сущности.
|
||||
> Компоненты-теги хоть и не имеют данных, само наличие или отсутствие компонента-тега у сущности уже несет информацию и может применяться для определения типа сущности.
|
||||
|
||||
## System
|
||||
**Системы** - это основная логика, тут задается поведение сущностей. Существуют в виде пользовательских классов, реализующих как минимум один из интерфейсов процессов. Основные процессы:
|
||||
@ -131,7 +131,7 @@ class SomeSystem : IEcsPreInitProcess, IEcsInitProcess, IEcsRunProcess, IEcsDest
|
||||
> Для реализации дополнительных процессов перейдите к разделу [Процессы](#Процессы).
|
||||
# Концепции фреймворка
|
||||
## Пайплайн
|
||||
Является контейнером и двжиком систем, определяя поочередность их вызова, предоставляющий механизм для сообщений между системами и механизм внедрения зависимостей. Реализован в виде класса `EcsPipeline`.
|
||||
Является контейнером и движком систем, определяя поочередность их вызова, предоставляющий механизм для сообщений между системами и механизм внедрения зависимостей. Реализован в виде класса `EcsPipeline`.
|
||||
### Построение
|
||||
За построение пайплайна отвечает Builder. В Builder добавляются системы, а в конце строится пайплайн. Пример:
|
||||
```c#
|
||||
@ -152,7 +152,7 @@ pipeline.Init(); // Инициализация пайплайна
|
||||
``` c#
|
||||
EcsPipelone pipeline = EcsPipeline.New()
|
||||
//...
|
||||
.Inject(_someData) // Внедрит в системы экземлпяр _someData
|
||||
.Inject(_someData) // Внедрит в системы экземпляр _someData
|
||||
//...
|
||||
.BuildAndInit();
|
||||
```
|
||||
@ -178,7 +178,7 @@ EcsPipelone pipeline = EcsPipeline.New()
|
||||
.BuildAndInit();
|
||||
```
|
||||
### Слои
|
||||
Очередь систем можно разбить на слои. Слой определяет место в очереди для вставки систем. Если необходимо чтобы какая-то система была вставлена в конце очереди, внезависимости от места добавления, эту систему можно добавить в слой EcsConsts.END_LAYER.
|
||||
Очередь систем можно разбить на слои. Слой определяет место в очереди для вставки систем. Если необходимо чтобы какая-то система была вставлена в конце очереди, вне зависимости от места добавления, эту систему можно добавить в слой EcsConsts.END_LAYER.
|
||||
``` c#
|
||||
const string SOME_LAYER = nameof(SOME_LAYER);
|
||||
EcsPipelone pipeline = EcsPipeline.New()
|
||||
@ -237,7 +237,7 @@ sealed class DoSomethingProcessRunner : EcsRunner<IDoSomethingProcess>, IDoSomet
|
||||
Является контейнером для сущностей и компонентов.
|
||||
> **NOTICE:** Необходимо вызывать EcsWorld.Destroy() у экземпляра мира если он больше не нужен.
|
||||
### Компоненты мира
|
||||
С помощью компонентов можно прикреплять дополнитеьные данные к мирам. Компоненты можно применять создания расширений в связке с методами расширений.
|
||||
С помощью компонентов можно прикреплять дополнительные данные к мирам. Компоненты можно применять создания расширений в связке с методами расширений.
|
||||
``` csharp
|
||||
WorldComponent component = _world.Get<WorldComponent>();
|
||||
```
|
||||
@ -245,32 +245,32 @@ WorldComponent component = _world.Get<WorldComponent>();
|
||||
## Пул
|
||||
Является контейнером для компонентов, предоставляет методы для добавления/чтения/редактирования/удаления компонентов на сущности. Есть несколько видов пулов, для разных целей
|
||||
* `EcsPool` - универсальный пул, хранит struct-компоненты реализующие интерфейс IEcsComponent;
|
||||
* `EcsTagPool` - подходит для хранения пустых компонентов-тегов, в сравнении с EcsPool имеет лучше оптимизацию памяти и дейсвий с пулом, хранит в себе struct-компоненты реализующие IEcsTagComponent;
|
||||
* `EcsTagPool` - подходит для хранения пустых компонентов-тегов, в сравнении с EcsPool имеет лучше оптимизацию памяти и действий с пулом, хранит в себе struct-компоненты реализующие IEcsTagComponent;
|
||||
|
||||
Имеется возможность реализации пользовательского пула
|
||||
> эта функция будет описана в ближайщее время
|
||||
> эта функция будет описана в ближайшее время
|
||||
|
||||
## Субъект
|
||||
Это классы наследуемые от EcsSubject, которые используются как посредник для взаимодейсвия с сушностями.
|
||||
Это классы наследуемые от EcsSubject, которые используются как посредник для взаимодействия с сущностями.
|
||||
|
||||
## Запросы
|
||||
Используйте метод-запрос `EcsWorld.Where<TSubject>(out TSubject subject)` для получения необходимого системе набора сущностей. Запросы работают в связке с субъектами, субъекты определяют ограничения запросов, результатом запроса становится группа сущностей удовлетворяющия условиям субъекта. По умолчанию запрос делает выборку из всех сущностей в мире, но так же можно сделать выборку из определенной группы сущностей, для этого используйте `EcsWorld.WhereFor<TSubject>(EcsReadonlyGroup sourceGroup, out TSubject subject)`
|
||||
Используйте метод-запрос `EcsWorld.Where<TSubject>(out TSubject subject)` для получения необходимого системе набора сущностей. Запросы работают в связке с субъектами, субъекты определяют ограничения запросов, результатом запроса становится группа сущностей удовлетворяющая условиям субъекта. По умолчанию запрос делает выборку из всех сущностей в мире, но так же можно сделать выборку из определенной группы сущностей, для этого используйте `EcsWorld.WhereFor<TSubject>(EcsReadonlyGroup sourceGroup, out TSubject subject)`
|
||||
|
||||
## Группа
|
||||
Группы это структуры данных для хранения списка сущностей и с быстрыми операциями добавления/удаления/проверки наличия и т.д. Реализованы классом `EcsGroup` и структурой `EcsReadonlyGroup`.
|
||||
Группы могут использоваться для реактивной фильтрации сущностей
|
||||
|
||||
# Debug
|
||||
Фреймворк предоставляет дополнительные интрументы для отладки и логирования, не зависящие от среды.
|
||||
Фреймворк предоставляет дополнительные инструменты для отладки и логирования, не зависящие от среды.
|
||||
## Атрибуты
|
||||
В чистом виде атрибуты не имеют применения, но испольщуются в интеграциях с движками для задания отображения в отладочных интурментах и редакторах.
|
||||
В чистом виде атрибуты не имеют применения, но используются в интеграциях с движками для задания отображения в отладочных инструментах и редакторах.
|
||||
``` c#
|
||||
// Задает пользовательское название типа, по умолчанию используется имя типа.
|
||||
using DCFApixels.DragonECS;
|
||||
...
|
||||
[DebugName("SomeComponent")]
|
||||
// Задает цвет типа в системе rgb, где каждый канал принимает занчение от 0 до 255, по умолчанию белый.
|
||||
// ВЫбрать цвет можно как вручную задав rgb значения, так и использовать заранее заготовленные цвета в enum DebugColor.
|
||||
// Задает цвет типа в системе rgb, где каждый канал принимает значение от 0 до 255, по умолчанию белый.
|
||||
// Выбрать цвет можно как вручную задав rgb значения, так и использовать заранее заготовленные цвета в enum DebugColor.
|
||||
[DebugColor(DebugColor.Red)]
|
||||
// Добавляет описание типу.
|
||||
[DebugDescription("The quick brown fox jumps over the lazy dog")]
|
||||
@ -280,7 +280,7 @@ public struct Component { }
|
||||
```
|
||||
## EcsDebug
|
||||
Имеет набор методов для отладки и логирования. Реализован как статический класс вызывающий методы Debug-сервисов. Debug-сервисы являются посредниками между системами отладки среды и EcsDebug. Это позволяет не изменяя отладочный код проекта, переносить его на другие движки, достаточно только реализовать специальный Debug-сервис.
|
||||
По умолчанию используется `DefaultDebugService` который выводит логи в консоль. Для реализации пользовательского создайте класс наследуемый от `DebugService` и реализайте абстрактные члены класса.
|
||||
По умолчанию используется `DefaultDebugService` который выводит логи в консоль. Для реализации пользовательского создайте класс наследуемый от `DebugService` и реализуйте абстрактные члены класса.
|
||||
# Расширения
|
||||
* [Автоматическое внедрение зависимостей](https://github.com/DCFApixels/DragonECS-AutoInjections)
|
||||
* Интеграция с движком Unity (Work in progress)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user