mirror of
https://github.com/DCFApixels/DragonECS-Unity.git
synced 2025-09-17 17:34:34 +08:00
correct spelling
This commit is contained in:
parent
fa683322a3
commit
c68d33afa1
28
README-RU.md
28
README-RU.md
@ -14,7 +14,7 @@
|
|||||||
| Languages: | [Русский](https://github.com/DCFApixels/DragonECS-Unity/blob/main/README-RU.md) | [English(WIP)](https://github.com/DCFApixels/DragonECS-Unity) |
|
| Languages: | [Русский](https://github.com/DCFApixels/DragonECS-Unity/blob/main/README-RU.md) | [English(WIP)](https://github.com/DCFApixels/DragonECS-Unity) |
|
||||||
| :--- | :--- | :--- |
|
| :--- | :--- | :--- |
|
||||||
|
|
||||||
Расширение добавит набор инструментов для дебага и связи с движком Unity.
|
Расширение добавит набор инструментов для отладки и связи с движком Unity.
|
||||||
|
|
||||||
> [!WARNING]
|
> [!WARNING]
|
||||||
> Проект в стадии разработки. API может меняться.
|
> Проект в стадии разработки. API может меняться.
|
||||||
@ -43,7 +43,7 @@
|
|||||||
+ Минимальная версия C# 7.3;
|
+ Минимальная версия C# 7.3;
|
||||||
+ Минимальная версия Unity 2021.2.0;
|
+ Минимальная версия Unity 2021.2.0;
|
||||||
|
|
||||||
Протестированно:
|
Протестировано:
|
||||||
+ **Unity:** Минимальная версия 2021.2.0;
|
+ **Unity:** Минимальная версия 2021.2.0;
|
||||||
|
|
||||||
## Установка для Unity
|
## Установка для Unity
|
||||||
@ -52,7 +52,7 @@
|
|||||||
```
|
```
|
||||||
https://github.com/DCFApixels/DragonECS-Unity.git
|
https://github.com/DCFApixels/DragonECS-Unity.git
|
||||||
```
|
```
|
||||||
* ### В виде иходников
|
* ### В виде исходников
|
||||||
Фреймворк так же может быть добавлен в проект в виде исходников.
|
Фреймворк так же может быть добавлен в проект в виде исходников.
|
||||||
|
|
||||||
</br>
|
</br>
|
||||||
@ -72,17 +72,17 @@ _pipeline = EcsPipeline.New()
|
|||||||
.BuildAndInit();
|
.BuildAndInit();
|
||||||
```
|
```
|
||||||
## Debug Сервис
|
## Debug Сервис
|
||||||
`UnityDebugService`- реализация [Debug-сервиса для `EcsDebug`](https://github.com/DCFApixels/DragonECS/blob/main/README-RU.md#ecsdebug). В редакторе по умолчанию автоматически инициализируется и связывает `EcsDebug.Print` с консолью юнити, `EcsProfilerMarker` c профайлером и т.д.
|
`UnityDebugService`- реализация [Debug-сервиса для `EcsDebug`](https://github.com/DCFApixels/DragonECS/blob/main/README-RU.md#ecsdebug). В редакторе по умолчанию автоматически инициализируется и связывает `EcsDebug.Print` с консолью Unity, `EcsProfilerMarker` c профайлером и т.д.
|
||||||
```c#
|
```c#
|
||||||
//Ручная активация.
|
//Ручная активация.
|
||||||
UnityDebugService.Activate();
|
UnityDebugService.Activate();
|
||||||
|
|
||||||
//Выведет сообщение в консоле Unity.
|
//Выведет сообщение в консоли Unity.
|
||||||
EcsDebug.Print();
|
EcsDebug.Print();
|
||||||
|
|
||||||
var someMarker = new EcsProfilerMarker("SomeMarker");
|
var someMarker = new EcsProfilerMarker("SomeMarker");
|
||||||
someMarker.Begin();
|
someMarker.Begin();
|
||||||
//время выполнения этого участка будет отражено в профайлере юнити.
|
//время выполнения этого участка будет отражено в профайлере Unity.
|
||||||
someMarker.End();
|
someMarker.End();
|
||||||
|
|
||||||
//Остановка игрового режима.
|
//Остановка игрового режима.
|
||||||
@ -107,7 +107,7 @@ EcsDebug.Break();
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
* ### `PipelineProcessMonitor`
|
* ### `PipelineProcessMonitor`
|
||||||
Отображает в виде матрицы процессы и сситемы. Системы отображабтся в порядке их выполнения. Точка в пересечении системы и процесса означает что эта система является частью этого процесса.
|
Отображает в виде матрицы процессы и системы. Системы отображаются в порядке их выполнения. Точка в пересечении системы и процесса означает что эта система является частью этого процесса.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="https://github.com/DCFApixels/DragonECS-Unity/assets/99481254/c1a7960a-d65a-4f22-9597-fd863ff2b00c">
|
<img src="https://github.com/DCFApixels/DragonECS-Unity/assets/99481254/c1a7960a-d65a-4f22-9597-fd863ff2b00c">
|
||||||
@ -125,7 +125,7 @@ EcsDebug.Break();
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
* ### `EntityMonitor`
|
* ### `EntityMonitor`
|
||||||
Показывает состояние сущности мира. На кажду сущность в мире создается отдельынй монитор. Все мониторы сущностей помещаются в монитор мира.
|
Показывает состояние сущности мира. На каждую сущность в мире создается отдельный монитор. Все мониторы сущностей помещаются в монитор мира.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="https://github.com/DCFApixels/DragonECS-Unity/assets/99481254/509ff472-05b5-4fd8-a0e6-739d7fa81ab1">
|
<img src="https://github.com/DCFApixels/DragonECS-Unity/assets/99481254/509ff472-05b5-4fd8-a0e6-739d7fa81ab1">
|
||||||
@ -153,7 +153,7 @@ int e = _world.NewEntity(someSamplate);
|
|||||||
По умолчанию расширение содержит 2 вида шаблонов: `ScriptableEntityTemplate`, `MonoEntityTemplate`.
|
По умолчанию расширение содержит 2 вида шаблонов: `ScriptableEntityTemplate`, `MonoEntityTemplate`.
|
||||||
|
|
||||||
## ScriptableEntityTemplate
|
## ScriptableEntityTemplate
|
||||||
Хранится как отдельынй ассет. Наследуется от `ScriptableObject`.
|
Хранится как отдельный ассет. Наследуется от `ScriptableObject`.
|
||||||
Дейсвия чтобы создать `ScriptableEntityTemplate` ассет:
|
Дейсвия чтобы создать `ScriptableEntityTemplate` ассет:
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
@ -237,7 +237,7 @@ class SomeComponentTemplate : IComponentTemplate
|
|||||||
|
|
||||||
В раскрывающемся при нажатии `Add Component` меню выбора компонента поддерживается иерархическое группирование. Производится группирование на основе мета-атрибута `[MetaGroup]`.
|
В раскрывающемся при нажатии `Add Component` меню выбора компонента поддерживается иерархическое группирование. Производится группирование на основе мета-атрибута `[MetaGroup]`.
|
||||||
|
|
||||||
Компоненты в инспектрре по умолчанию отображаются окрашенными в случайный цвет сгенерированный на основе имени компонента, выбрать другой режим окраски можно в настройках фреймворка. Задать конкретный цвет можно при помощи мета-атрибута `[MetaColor]`.
|
Компоненты в инспекторе по умолчанию отображаются окрашенными в случайный цвет сгенерированный на основе имени компонента, выбрать другой режим окраски можно в настройках фреймворка. Задать конкретный цвет можно при помощи мета-атрибута `[MetaColor]`.
|
||||||
|
|
||||||
Если редактор смог автоматически определить связанный с компонентом скрипт, то слева от крестика удаления компонента будет иконка файла. Клик по иконке выделит файл скрипта в папке проекта, двойной клик откроет скрип для редактирования. Связанный файл ищется по сопоставлению имени типа и имени файла скрипта.
|
Если редактор смог автоматически определить связанный с компонентом скрипт, то слева от крестика удаления компонента будет иконка файла. Клик по иконке выделит файл скрипта в папке проекта, двойной клик откроет скрип для редактирования. Связанный файл ищется по сопоставлению имени типа и имени файла скрипта.
|
||||||
|
|
||||||
@ -269,11 +269,11 @@ EcsEntityConnect connect = /*...*/;
|
|||||||
entlong entity = _world.NewEntityLong();
|
entlong entity = _world.NewEntityLong();
|
||||||
|
|
||||||
// Связывание сущности с GameObject.
|
// Связывание сущности с GameObject.
|
||||||
// Автоматически добавляется GameObjectConnect в сущность.
|
// Автоматически добавляется GameObjectConnect в сущность
|
||||||
// Автоматическки применяются шаблоны.
|
// и применяются шаблоны.
|
||||||
connect.ConnectWith(entity);
|
connect.ConnectWith(entity);
|
||||||
|
|
||||||
// Или создать без применения шаблнов.
|
// Или создать без применения шаблонов.
|
||||||
connect.ConnectWith(entity, false);
|
connect.ConnectWith(entity, false);
|
||||||
|
|
||||||
// Отвязать.
|
// Отвязать.
|
||||||
@ -299,7 +299,7 @@ connect.Disconnect();
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
`AutoEntityCreator` автоматический создает сущность и связывает с GameObject. В инспекторе ему нужно указать `EcsEntityConnect` с которым связывать сущность и [Провайдер мира](#world-provider) в котормо создать сущность.
|
`AutoEntityCreator` автоматический создает сущность и связывает с GameObject. В инспекторе ему нужно указать `EcsEntityConnect` с которым связывать сущность и [Провайдер мира](#world-provider) в котором создать сущность.
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>Повесить компонент: Add Component > DragonECS > AutoEntityCreator.</summary>
|
<summary>Повесить компонент: Add Component > DragonECS > AutoEntityCreator.</summary>
|
||||||
|
Loading…
Reference in New Issue
Block a user