diff --git a/README.md b/README.md index 95cf477..57f8c15 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,26 @@ # DragonECS - C# Entity Component System Framework -> **ВАЖНО!** Проект в стадии разработки. API может меняться. README так же не завершен. +> **ВАЖНО!** Проект в стадии разработки. API может меняться. ## Оглавление * [Установка](#Установка) - * [Unity-модуль](#Unity-модуль) - * [В виде иходников](#В-виде-иходников) + * [Unity-модуль](#Unity-модуль) + * [В виде иходников](#В-виде-иходников) * [Основные концепции](#Основные-концепции) - * [Сущность](#Сущность) - * [Компонент](#Компонент) - * [Система](#Система) - * [Pipeline](#Pipeline) - * [Процесс и Раннер](#Процесс-и-Раннер) - * [Группа](#Группа) - * [Субъект](#Субъект) - * [Запрос](#Запрос) + * [Entity](#Entity) + * [Component](#Component) + * [System](#System) +* [Концепции фреймворка](#Концепции-фреймворка) + * [Pipeline](#Pipeline) + * [Процесс](#Процесс) + * [Группа](#Группа) + * [Субъект](#Субъект) + * [Запрос](#Запрос) +* [Debug](#Debug) + * [Атрибуты] + * [EcsDebugUtility] + * [Debug-Сервис] * [Расширения](#Расширения) # Установка @@ -31,12 +36,12 @@ https://github.com/DCFApixels/DragonECS.git Фреймворк так же может быть добавлен в проект в виде исходников. # Основные концепции -## Сущность +## Entity Сущности - это то к чему крепятся данные. Реализованны в виде идентификаторов, которых есть 2 вида: * `int` - однократный идентификатор, применяется в пределах одного тика. Не рекомендуется хранить `int` идентификаторы, в место этого используйте `entlong`; * `entlong` - долговременный идентификатор, содержит в себе полный набор информации для однозначной идентификации; -## Компонент +## Component Компоненты - это данные для сущностей. Обязаны реализовывать интерфейс IEcsComponent или другой указываюший вид компонента. ```c# struct Health : IEcsComponent @@ -49,7 +54,7 @@ struct Health : IEcsComponent * `IEcsComponent` - Компоненты с данными. * `IEcsTagComponent` - Компоненты-теги. Без данных. -## Система +## System Системы - это основная логика, тут задается поведение сущьностей. Существуют в виде пользовательских классов, реализующих как минимум один из IEcsInitProcess, IEcsDestroyProcess, IEcsRunProcess интерфейсов. ```c# class UserSystem : IEcsPreInitProcess, IEcsInitProcess, IEcsRunProcess, IEcsDestroyProcess @@ -69,11 +74,11 @@ class UserSystem : IEcsPreInitProcess, IEcsInitProcess, IEcsRunProcess, IEcsDest //Для реализации дополнительных процессов используйте Раннеры } ``` - +# Концепции фреймворка ## Pipeline -Является двжиком систем, определяя поочередность их вызова, предоставляющий механизм для сообщений между системами и механизм внедрения зависимостей в системы. +Является контейнером и двжиком систем, определяя поочередность их вызова, предоставляющий механизм для сообщений между системами и механизм внедрения зависимостей в системы. -## Процесс и Раннер +## Процесс Процессы - это очереди систем реализующие общий интерфейс. Раннеры запускюат выполнение процессов. Система раннеров и процессов может использоваться для создания реактивного поведения или для управления очередью вызова систем. Встроенные процессы вызываются автоматически, для ручного запуска испольщуйте раннеры получаемые из EcsPipeline.GetRunner(). > Метод GetRunner относительно медленный, поэтому рекомендуется кешировать полученные раннеры. @@ -115,6 +120,18 @@ public sealed class EcsRunRunner : EcsRunner, IEcsRunProcess ## Запросы Используйте метод-запрос `EcsWorld.Where(out TSubject subject)` для получения необходимого системе набора сущностей. Запросы работают в связке с субъектами, субъекты определяют ограничения запросов, результатом запроса становится группа сущностей удовлетворяющия условиям субъекта. По умолчанию запрос делает выборку из всех сущностей в мире, но так же можно сделать выборку из определенной группы сущностей, для этого используйте `EcsWorld.WhereFor(EcsReadonlyGroup sourceGroup, out TSubject subject)` +# Debug +Фреймворк предоставляет дополнительные интрументы для отладки и логирования. +## Атрибуты +В чистом виде атрибуты не имеют применения, но будут использоваться в интеграциях с движками для задания отображения в отладочных интурментах и редакторах. +* `DebugNameAttribute` - Задает пользовательское название типа, по умолчанию используется имя типа. +* `DebugColorAttribute` - Задает цвет типа в системе rgb, где каждый канал принимает занчение от 0 до 255, по умолчанию белый. Задать цвет можно как вручную, так и использовать заранее заготовленные цвета в enum DebugColor. +* `DebugDescriptionAttribute` - Добавляет описание типу. +* `DebugHideAttribute` - Скрывает тип. +## EcsDebugUtility +Статические класс EcsDebugUtility имеет набор методов для упрощения получения данных из Debug-Aтрибутов. +## Debug-Сервис + # Расширения * [Автоматическое внедрение зависимостей](https://github.com/DCFApixels/DragonECS-AutoInjections) * Интеграция с движком Unity (Work in progress)