AlicizaX/DragonECS-Graphs
1
0
Fork 0
mirror of https://github.com/DCFApixels/DragonECS-Graphs.git synced 2025-09-17 19:24:36 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README-RU.md

Browse Source
This commit is contained in:
Mikhail 2024-11-22 13:46:44 +08:00 committed by GitHub
parent 58f570c731
commit 10633f0b49
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 33 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README-RU.md
View File

@ -35,7 +35,7 @@
</br>
Реализация связи сущностей в виде графа. Связывающие ребра графа представлены в виде сущностей, что позволяет создавать отношения вида многие ко многим, а с помощью компонентной композиции можно настраивать вид этих отношений.
Реализация отношений сущностей в виде графа. Связывающие ребра графа представлены в виде сущностей, что позволяет создавать отношения вида многие ко многим, а с помощью компонентной композиции можно настраивать вид этих отношений.
> [!WARNING]
> Проект в стадии разработки. API может меняться.
@ -70,7 +70,7 @@ https://github.com/DCFApixels/DragonECS-Graphs.git
</br>
# Инициализация
# Граф
Для начала нужно создать граф реализованный классом `EntityGraph`. Графу требуется 2 мира: обычный мир и мир для сущностей-связей. Пример создания `EntityGraph`:
```c#
// Обычный мир.
@ -88,7 +88,7 @@ _pipeline = EcsPipeline.New()
// ...
.Build()
```
Можно использовать один мир для обычных сущностей и для сущностей связей.
Можно использовать один мир для обычных сущностей и для сущностей-связей.
```c#
_world = new EcsDefaultWorld();
// Создание EntityGraph завязанный на одном мире.
@ -96,3 +96,33 @@ EntityGraph graph = _world.CreateGraph();
```
# Сущность-связь
Как и обычная сущность, но управляется и создается в `EntityGraph` и предназначена для данных об отношении двух сущностей.
> Отношения имеют направление, поэтому чтобы разделять сущности, далее будет использованы понятия: начальная сущность(`Start Entity`) от нее исходит сущность-связъ(`Relation Entity`) к конечной сущности(`End Entity`).
```
(Start Entity) ─── (Relation Entity) ──► (End Entity)
```
Пример работы с связями:
```c#
// Получаем или создаем новую сущность-связь от сущности `startE` к `endE`.
// Сущность создается в мире _graph.GraphWorld и регистрируется в графе.
var relE = _graph.GetOrNewRelation(startE, endE);
// Кроме создания и удаления, в остальном сущности-свящи - это обычные сущности.
ref var someCmp = ref _somePool.Add(relE);
// Вернет true если была создана через EntityGraph.GetOrNewRelation(startE, endE)
// и false если через EcsWorld.NewEntity().
bool isRelation = _graph.IsRelation(relE);
// Взять сущность-связь для отношения в обратном направлении, от `endE` к `startE`.
_graph.GetOrNewInverseRelation(relE);
// Удаляем сущность связь.
_graph.DelRelation(relE);
```
# Запрос