From f9f51302f371b753db9b52a5b1aa647cb23cdc62 Mon Sep 17 00:00:00 2001 From: Mikhail <99481254+DCFApixels@users.noreply.github.com> Date: Sat, 19 Oct 2024 19:47:20 +0800 Subject: [PATCH 1/3] Update README-RU.md --- README-RU.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 46 insertions(+), 6 deletions(-) diff --git a/README-RU.md b/README-RU.md index b55dad2..4c3bfde 100644 --- a/README-RU.md +++ b/README-RU.md @@ -47,9 +47,10 @@ - [Debug Модуль](#debug-модуль) - [Debug Сервис](#debug-сервис) - [Визуальная отладка](#визуальная-отладка) -- [Шаблоны](#шаблоны) +- [Шаблон Сущности](#шаблон-сущности) - [Связь с GameObject](#связь-с-gameobject) - [World Provider](#world-provider) +- [Шаблон Пайплайна](#шаблон-пайплайна) - [FixedUpdate LateUpdate ](#fixedupdate-lateupdate) - [Документация проекта](#документация-проекта) - [Окно настроек](#окно-настроек) @@ -147,7 +148,7 @@ EcsDebug.Break(); ----- * ### `EntityMonitor` -Показывает состояние сущности мира. На каждую сущность в мире создается отдельный монитор. Все мониторы сущностей помещаются в монитор мира. +Показывает состояние сущности мира, позволяет добавлять/изменять/удалять компоненты по время Play Mode. На каждую сущность в мире создается отдельный монитор. Все мониторы сущностей помещаются в монитор мира.

@@ -157,8 +158,8 @@ EcsDebug.Break();
-# Шаблоны -Шаблоны - это настраиваемые наборы компонентов которые можно применить к сущностям. Шаблоны должны реализовывать интерфейс `ITemplateNode`. +# Шаблон Сущности +Настраиваемый набор компонентов которые можно применить к сущностям. Шаблоны должны реализовывать интерфейс `ITemplateNode`. ```c# ITemplateNode someTemplate = /*...*/; //... @@ -260,8 +261,7 @@ class SomeComponentTemplate : IComponentTemplate
- -### Кастомизирование отображения +### Кастомизация отображения типов В раскрывающемся при нажатии `Add Component` меню выбора компонента поддерживается иерархическое группирование. Производится группирование на основе мета-атрибута `[MetaGroup]`. Компоненты в инспекторе по умолчанию отображаются окрашенными в случайный цвет сгенерированный на основе имени компонента, выбрать другой режим окраски можно в [окне настроек](#окно-настроек) фреймворка. Задать конкретный цвет можно при помощи мета-атрибута `[MetaColor]`. @@ -411,6 +411,37 @@ public class EcsMyWorldSingletonProvider : EcsWorldProvider
+# Шаблон Пайплайна +Пайплайн как и сущности можно собирать из шаблонов. Шаблоны пайплайна это модули, реализующие интерфейс `IEcsModule`。 + +По умолчанию расширение содержит 2 вида шаблонов: `ScriptablePipelineTemplate`, `MonoPipelineTemplate`. + +## ScriptablePipelineTemplate +Хранится как отдельный ассет. Наследуется от `ScriptableObject`. Действия чтобы создать `ScriptableEntityTemplate` ассет: `Asset > Create > DragonECS > ScriptablePipelineTemplate`. + +

+ +

+ +## MonoPipelineTemplate +Крепится к `GameObject`. Наследуется от `MonoBehaviour`. Повесить компонент: `Add Component > DragonECS > MonoPipelineTemplate`. + +

+ +

+ +
+ +# EcsRootUnity +Упрощенная реализация Ecs Root для юнити, собирает пайплайн из шаблонов пайплайна. Наследуется от `MonoBehaviour`. Чтобы повесить GameObject: `Add Component > DragonECS > EcsRootUnity`. + +

+ +

+ +
+ + # FixedUpdate LateUpdate ```c# using DCFApixels.DragonECS; @@ -458,6 +489,15 @@ public class EcsRoot : MonoBehaviour
+# Инструмент для восстановления Missing Reference +Расширение активно задействует `[SerializeReference]`, у которого есть известная проблема с потерей типов при переименовании. Чтобы упростить восстановление потерянных типов имеется специальный инструмент `Reference Repairer`. Он может собирать все ассеты с потерянными типами, после предоставляет окно для указания новых имен потерянны типов. Далее проведет восстановление потерянных типов в собранных ассетах. Открыть окно инструмента: `Tools > DragonECS > Reference Repairer`. +> Если потерянные типы были с атрибутом `[MetaID(id)]` то инструмент автоматически определит новое имя типа. +

+ +

+ +
+ # FAQ ## Не могу повесить EcsEntityConncet или другие компоненты Такое иногда может происходить после обновления пакета, решается либо через `Assets -> Reimport All` или перезапуск окна Unity с удалением папки `*project name*/Library`. From 792e294458ecedd67e10a1977341934bcdd2a390 Mon Sep 17 00:00:00 2001 From: Mikhail <99481254+DCFApixels@users.noreply.github.com> Date: Sat, 19 Oct 2024 19:54:38 +0800 Subject: [PATCH 2/3] Update README-RU.md --- README-RU.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README-RU.md b/README-RU.md index 4c3bfde..f6c1601 100644 --- a/README-RU.md +++ b/README-RU.md @@ -420,14 +420,14 @@ public class EcsMyWorldSingletonProvider : EcsWorldProvider Хранится как отдельный ассет. Наследуется от `ScriptableObject`. Действия чтобы создать `ScriptableEntityTemplate` ассет: `Asset > Create > DragonECS > ScriptablePipelineTemplate`.

- +

## MonoPipelineTemplate Крепится к `GameObject`. Наследуется от `MonoBehaviour`. Повесить компонент: `Add Component > DragonECS > MonoPipelineTemplate`.

- +


@@ -436,9 +436,10 @@ public class EcsMyWorldSingletonProvider : EcsWorldProvider Упрощенная реализация Ecs Root для юнити, собирает пайплайн из шаблонов пайплайна. Наследуется от `MonoBehaviour`. Чтобы повесить GameObject: `Add Component > DragonECS > EcsRootUnity`.

- +

+
@@ -493,7 +494,7 @@ public class EcsRoot : MonoBehaviour Расширение активно задействует `[SerializeReference]`, у которого есть известная проблема с потерей типов при переименовании. Чтобы упростить восстановление потерянных типов имеется специальный инструмент `Reference Repairer`. Он может собирать все ассеты с потерянными типами, после предоставляет окно для указания новых имен потерянны типов. Далее проведет восстановление потерянных типов в собранных ассетах. Открыть окно инструмента: `Tools > DragonECS > Reference Repairer`. > Если потерянные типы были с атрибутом `[MetaID(id)]` то инструмент автоматически определит новое имя типа.

- +


From 9c268a5aa7f6e175c24d20e73ae9b84b8129d2b8 Mon Sep 17 00:00:00 2001 From: Mikhail <99481254+DCFApixels@users.noreply.github.com> Date: Sat, 19 Oct 2024 19:59:04 +0800 Subject: [PATCH 3/3] Update README-RU.md --- README-RU.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README-RU.md b/README-RU.md index f6c1601..e07a823 100644 --- a/README-RU.md +++ b/README-RU.md @@ -420,14 +420,14 @@ public class EcsMyWorldSingletonProvider : EcsWorldProvider Хранится как отдельный ассет. Наследуется от `ScriptableObject`. Действия чтобы создать `ScriptableEntityTemplate` ассет: `Asset > Create > DragonECS > ScriptablePipelineTemplate`.

- +

## MonoPipelineTemplate Крепится к `GameObject`. Наследуется от `MonoBehaviour`. Повесить компонент: `Add Component > DragonECS > MonoPipelineTemplate`.

- +


@@ -436,7 +436,7 @@ public class EcsMyWorldSingletonProvider : EcsWorldProvider Упрощенная реализация Ecs Root для юнити, собирает пайплайн из шаблонов пайплайна. Наследуется от `MonoBehaviour`. Чтобы повесить GameObject: `Add Component > DragonECS > EcsRootUnity`.

- +

@@ -494,7 +494,7 @@ public class EcsRoot : MonoBehaviour Расширение активно задействует `[SerializeReference]`, у которого есть известная проблема с потерей типов при переименовании. Чтобы упростить восстановление потерянных типов имеется специальный инструмент `Reference Repairer`. Он может собирать все ассеты с потерянными типами, после предоставляет окно для указания новых имен потерянны типов. Далее проведет восстановление потерянных типов в собранных ассетах. Открыть окно инструмента: `Tools > DragonECS > Reference Repairer`. > Если потерянные типы были с атрибутом `[MetaID(id)]` то инструмент автоматически определит новое имя типа.

- +