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-RU.md

Browse Source
This commit is contained in:
Mikhail 2023-05-30 17:31:34 +08:00 committed by GitHub
parent 13e3b6466e
commit 3d717b4db3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README-RU.md
View File

@ -23,7 +23,7 @@
* [Концепции фреймворка](#Концепции-фреймворка)
* [Pipeline](#Pipeline)
* [Процесс](#Процесс)
* [World](#World)
* [Мир](#Мир)
* [Группа](#Группа)
* [Субъект](#Субъект)
* [Запрос](#Запрос)
@ -85,7 +85,7 @@ class UserSystem : IEcsPreInitProcess, IEcsInitProcess, IEcsRunProcess, IEcsDest
## Pipeline
Класс EcsPipeline является контейнером и двжиком систем, определяя поочередность их вызова, предоставляющий механизм для сообщений между системами и механизм внедрения зависимостей в системы.
## Process
## Процесс
Процессы - это очереди систем реализующие общий интерфейс, например IEcsRunProcess. Для запуска процессов используются Runner-ы. Система ранеров и процессов может использоваться для создания реактивного поведения или для управления очередью вызова систем. Встроенные процессы вызываются автоматически, для ручного запуска испольщуйте раннеры получаемые из EcsPipeline.GetRunner<TInterface>().
> Метод GetRunner относительно медленный, поэтому рекомендуется кешировать полученные раннеры.
@ -112,7 +112,7 @@ public sealed class EcsRunRunner : EcsRunner<IEcsRunProcess>, IEcsRunProcess
> * Наследуемый класс `EcsRunner<TInterface>,` в качестве `TInterface` должен принимать реализованный интерфейс;
> * Раннер не может быть размещен внутри другого класса.
## World
## Мир
Является контейнером для сущностей и компонентов.
## Группа
@ -131,18 +131,27 @@ public sealed class EcsRunRunner : EcsRunner<IEcsRunProcess>, IEcsRunProcess
Используйте метод-запрос `EcsWorld.Where<TSubject>(out TSubject subject)` для получения необходимого системе набора сущностей. Запросы работают в связке с субъектами, субъекты определяют ограничения запросов, результатом запроса становится группа сущностей удовлетворяющия условиям субъекта. По умолчанию запрос делает выборку из всех сущностей в мире, но так же можно сделать выборку из определенной группы сущностей, для этого используйте `EcsWorld.WhereFor<TSubject>(EcsReadonlyGroup sourceGroup, out TSubject subject)`
# Debug
Фреймворк предоставляет дополнительные интрументы для отладки и логирования.
Фреймворк предоставляет дополнительные интрументы для отладки и логирования, не зависящие от среды.
## Атрибуты
В чистом виде атрибуты не имеют применения, но будут использоваться в интеграциях с движками для задания отображения в отладочных интурментах и редакторах.
* `DebugNameAttribute` - Задает пользовательское название типа, по умолчанию используется имя типа.
* `DebugColorAttribute` - Задает цвет типа в системе rgb, где каждый канал принимает занчение от 0 до 255, по умолчанию белый. Задать цвет можно как вручную, так и использовать заранее заготовленные цвета в enum DebugColor.
* `DebugDescriptionAttribute` - Добавляет описание типу.
* `DebugHideAttribute` - Скрывает тип.
В чистом виде атрибуты не имеют применения, но испольщуются в интеграциях с движками для задания отображения в отладочных интурментах и редакторах.
``` csharp
// Задает пользовательское название типа, по умолчанию используется имя типа.
[DebugName("SomeComponent")]
// Задает цвет типа в системе rgb, где каждый канал принимает занчение от 0 до 255, по умолчанию белый.
// ВЫбрать цвет можно как вручную задав rgb значения, так и использовать заранее заготовленные цвета в enum DebugColor.
[DebugColor(DebugColor.Red)]
// Добавляет описание типу.
[DebugDescription("The quick brown fox jumps over the lazy dog")]
// Скрывает тип.
[DebugHide]
public struct Component { }
```
## EcsDebugUtility
Статические класс EcsDebugUtility имеет набор методов для упрощения получения данных из Debug-Aтрибутов.
Имеет набор методов для упрощения получения данных из Debug-Aтрибутов.
## EcsDebug
EcsDebug Содержит в себе
Имеет набор методов для отладки и логирования. Реализован как статический класс вызывающий методы Debug-сервисов. Debug-сервисы являются посредниками между системами отладки среды и EcsDebug. Это позволяет не изменяя отладочный код проекта, переносить его на другие движки, достаточно только реализовать специальный Debug-сервис.
По умолчанию используется `DefaultDebugService` который выводит логи в консоль. Для реализации пользовательского создайте класс наследуемый от `DebugService` и реализайте абстрактные члены класса.
# Расширения
* [Автоматическое внедрение зависимостей](https://github.com/DCFApixels/DragonECS-AutoInjections)
* Интеграция с движком Unity (Work in progress)