DragonECS-AutoInjections/README.md

81 lines
2.8 KiB
Markdown
Raw Normal View History

2023-05-28 19:41:33 +08:00
<p align="center">
2023-05-31 04:46:51 +08:00
<img width="400" src="https://github.com/DCFApixels/DragonECS-AutoInjections/assets/99481254/11868b2e-21f7-4f47-8970-03ad6329cf0e.png">
2023-05-28 19:41:33 +08:00
</p>
2023-05-29 04:07:37 +08:00
<p align="center">
<img alt="Version" src="https://img.shields.io/github/package-json/v/DCFApixels/DragonECS-AutoInjections?color=%23ff4e85&style=for-the-badge">
2023-05-31 04:50:35 +08:00
<img alt="License" src="https://img.shields.io/github/license/DCFApixels/DragonECS-AutoInjections?color=ff4e85&style=for-the-badge">
2023-05-29 04:07:37 +08:00
<!--<img alt="Discord" src="https://img.shields.io/discord/1111696966208999525?color=%23ff4e85&label=Discord&logo=Discord&logoColor=%23ff4e85&style=for-the-badge">-->
</p>
2023-05-29 22:41:26 +08:00
# Auto Injections for [DragonECS](https://github.com/DCFApixels/DragonECS)
2023-05-28 20:45:07 +08:00
2023-05-31 04:20:54 +08:00
| Languages: | [Русский](https://github.com/DCFApixels/DragonECS-AutoInjections/blob/main/README-RU.md) | [English(WIP)](https://github.com/DCFApixels/DragonECS-AutoInjections) |
| :--- | :--- | :--- |
2023-05-28 20:45:07 +08:00
2023-05-31 04:20:54 +08:00
The extension is designed to reduce the amount of code by simplifying dependency injection by doing injections automatically.
> **NOTICE:** The project is a work in progress, API may change.
2023-06-12 15:08:11 +08:00
> While the English version of the README is incomplete, you can view the [Russian version](https://github.com/DCFApixels/DragonECS-AutoInjections/blob/main/README-RU.md).
2023-05-28 20:29:42 +08:00
2023-05-31 04:23:11 +08:00
# Versioning
DragonECS uses this versioning semantics: [Open](https://gist.github.com/DCFApixels/c3b178a308b411f530361d1d56f1f929#versioning)
2023-05-31 04:20:54 +08:00
# Code Example
2023-05-28 15:44:29 +08:00
```csharp
class VelocitySystemDI : IEcsRunProcess
{
2023-06-22 23:20:13 +08:00
class Aspect : EcsAspectAuto
2023-05-28 15:44:29 +08:00
{
2023-05-28 22:10:54 +08:00
[ExcImplicit(typeof(FreezedTag))]
2023-05-28 15:44:29 +08:00
[Inc] public EcsPool<Pose> poses;
[Inc] public EcsPool<Velocity> velocities;
}
[EcsInject] EcsDefaultWorld _world;
[EcsInject] TimeService _time;
public void Run(EcsPipeline pipeline)
{
2023-06-22 23:20:13 +08:00
foreach (var e in _world.Where(out Aspect s))
2023-05-28 15:44:29 +08:00
{
s.poses.Write(e).position += s.velocities.Read(e).value * _time.DeltaTime;
}
}
}
```
2023-05-28 20:45:07 +08:00
<details>
2023-05-31 04:20:54 +08:00
<summary>Same code but without AutoInjections</summary>
2023-05-28 20:45:07 +08:00
2023-05-28 15:44:29 +08:00
```csharp
class VelocitySystem : IEcsRunProcess, IEcsInject<EcsDefaultWorld>, IEcsInject<TimeService>
{
2023-06-22 23:20:13 +08:00
class Aspect : EcsAspect
2023-05-28 15:44:29 +08:00
{
public EcsPool<Pose> poses;
public EcsPool<Velocity> velocities;
2023-06-22 23:20:13 +08:00
public Aspect(Builder b)
2023-05-28 15:44:29 +08:00
{
2023-05-28 22:10:54 +08:00
b.Exclude<FreezedTag>();
2023-05-28 15:44:29 +08:00
poses = b.Include<Pose>();
velocities = b.Include<Velocity>();
}
}
EcsDefaultWorld _world;
TimeService _time;
public void Inject(EcsDefaultWorld obj) => _world = obj;
public void Inject(TimeService obj) => _time = obj;
public void Run(EcsPipeline pipeline)
{
2023-06-22 23:20:13 +08:00
foreach (var e in _world.Where(out Aspect s))
2023-05-28 15:44:29 +08:00
{
s.poses.Write(e).position += s.velocities.Read(e).value * _time.DeltaTime;
}
}
}
```
2023-05-28 20:45:07 +08:00
</details>