diff --git a/README.md b/README.md index 1661359..5c3c269 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,11 @@

# [DragonECS](https://github.com/DCFApixels/DragonECS) - Auto Injections Extension -Данное ресширение призвано скоратить объем кода, упростив инбъекцию зависимостей, делая их автоматическими. +Расширение призвано сократить объем кода, упростив инбъекцию зависимостей, делая их автоматическими. -## Оглавление +# Оглавление * [Установка](#Установка) + * [Зависимости](#Зависимости) * [Unity-модуль](#Unity-модуль) * [В виде иходников](#В-виде-иходников) * [Инъекция зависимостей](#Инъекция-зависимостей) @@ -15,33 +16,51 @@ * [Не null инъекции](#Не-null-инъекции) # Установка -Сначала убдитесь что в проекте установлен [DragonECS](https://github.com/DCFApixels/DragonECS). +### Зависимости +Убдитесь что в проекте установлен фреймворк [DragonECS](https://github.com/DCFApixels/DragonECS). * ### Unity-модуль Поддерживается установка в виде Unity-модуля в при помощи добавления git-URL [в PackageManager](https://docs.unity3d.com/2023.2/Documentation/Manual/upm-ui-giturl.html) или ручного добавления в `Packages/manifest.json`: ``` -https://github.com/DCFApixels/DragonECS.git +https://github.com/DCFApixels/DragonECS-AutoInjections.git ``` * ### В виде иходников -Фреймворк так же может быть добавлен в проект в виде исходников. +Фреймворк так же может быть добавлен в проект в виде исходников. -## Инъекция зависимостей -Аттрибут `[EcsInject]` скрывает необходимость использования интерфейса `IEcsInject`, поля помеченные таким атрибутом автоматически подхватят зависимости переданные в метод Inject. +# Интеграция +Добавте вызов метода `AutoInject()` для фабрики Pipeline. Пример: +```csharp +_pipeline = EcsPipeline.New() + .Inject(world) + .Inject(_timeService) + .Add(new TestSystem()) + .Add(new VelocitySystem()) + .Add(new ViewSystem()) + .AutoInject() + .BuildAndInit(); +``` + +# Инъекция зависимостей +Аттрибут `[EcsInject]` убирает необходимость использования интерфейса `IEcsInject`, поля помеченные таким атрибутом автоматически подхватят зависимости внедренные в Pipeline. -## Фабрикаа субъектов -Так же данное расширение упрощает построение субъектов, добавляя 3 сппециальных аттрибута `[Inc]`, `[Exc]`, `[Opt]`. Данные атрибуты аналогичны вызовам мтодов `Include`, `Exclude`, `Optional` в фабрике субъекта. Так же еще существует 2 атрибута для неявного задания ограничения `[IncImplicit]`, `[ExcImplicit]`, эти атрибуты в обход кеширования пула, задают ограничения длясубъекта. -Атрибуты -* `[Inc]` - -* `[Exc]` - -* `[Opt]` - +# Фабрикаа субъектов +Так же AutoInjections упрощает построение субъектов. Для работы наследйте субъекты не от `EcsSubject`, а от `EcsSubjectDI`. +Есть 3 атрибтуа для инициализации полей с пулами. В поле будет автоматически закеширован пул, а тип компонента добавится в ограничение субъекта. Используйте аттрибуты: +* `[Inc]` - добавит тип компонента в включающее ограничение, аналог метода `Include`; +* `[Exc]` - добавит тип компонента в исключающее ограничение, аналог метода `Exclude`; +* `[Opt]` - только кеширует пул, аналог метода `Optional`; -## Пример кода +Дополнительные аттрибуты только для задания ограничений субъекта. Их можно применить к самому субъекту, либо к любому полю внутри. Используйте аттрибуты: +* `[IncImplicit(type)]` - добавит в включающее ограничение тип указанный в конструкторе `type`, аналог метода `Include`; +* `[ExcImplicit(type)]` - добавит в исключающее ограничение тип указанный в конструкторе `type`, аналог метода `Exclude`; + +# Пример кода ```csharp class VelocitySystemDI : IEcsRunProcess { class Subject : EcsSubjectDI { - [IncImplicit(typeof(PlayerTag))] + [ExcImplicit(typeof(FreezedTag))] [Inc] public EcsPool poses; [Inc] public EcsPool velocities; } @@ -70,7 +89,7 @@ class VelocitySystem : IEcsRunProcess, IEcsInject, IEcsInject velocities; public Subject(Builder b) { - b.Include(); + b.Exclude(); poses = b.Include(); velocities = b.Include(); } @@ -94,10 +113,12 @@ class VelocitySystem : IEcsRunProcess, IEcsInject, IEcsInject -## Не null инъекции +# Не null инъекции -Чтобы поле помеченное `[EcsInject]` было проинициализированно даже в случае отстувия инъекции, в конструктор атрибута можно передать тип болванку. В примере ниже поле `foo` получит экземпляр класса `Foo` из инъекции или экземпляр `FooDummy` если инъекции небыло. +Чтобы поле помеченное `[EcsInject]` было проинициализированно даже в случае отстувия инъекции, в конструктор атрибута можно передать тип болванку. В примере ниже поле `foo` получит экземпляр класса `Foo` из инъекции или экземпляр `FooDummy : Foo` если инъекции небыло. ``` csharp [EcsInject(typeof(FooDummy))] Foo foo; ``` +> Для корректной работы переданный тип должен иметь конструктор без парамтров и быть либо того же типа что и поле, либо производного типа. + Расширение так же сообщит если по заврешению предварительной инъекции, остались непроинициализированные поля с `[EcsInject]`.