Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eliasku/ecx
ECX is Entity Component System framework for Haxe
https://github.com/eliasku/ecx
Last synced: about 1 month ago
JSON representation
ECX is Entity Component System framework for Haxe
- Host: GitHub
- URL: https://github.com/eliasku/ecx
- Owner: eliasku
- Archived: true
- Created: 2016-07-02T09:51:13.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2019-09-06T19:12:46.000Z (over 5 years ago)
- Last Synced: 2024-04-12T17:16:33.095Z (8 months ago)
- Language: Haxe
- Size: 194 KB
- Stars: 52
- Watchers: 9
- Forks: 10
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-haxe-gamedev - ecx - `ECS` - An Entity Component System framework. (Architecture)
- awesome-game-engine-dev - Ecx - Entity component system framework for Haxe. (Libraries / Haxe)
README
# ecx
[](http://haxe.org)
[](https://github.com/eliasku/ecx)
[](https://github.com/eliasku/ecx/blob/master/haxelib.json)
[](http://opensource.org/licenses/MIT)
[](https://travis-ci.org/eliasku/ecx)
[](https://ci.appveyor.com/project/eliasku/ecx)
ECX is Entity Component System framework for Haxe
- [Asteroids Example](https://github.com/eliasku/ecx-richardlord-asteroids)
- [Documentation](https://eliasku.github.io/ecx/api-minimal)
- [Benchmarks](https://github.com/eliasku/ecx-benchmarks)
Libraries (work in progress):
- [ecx-common](https://github.com/eliasku/ecx-common): Common utilities
- [ecx-scene2d](https://github.com/eliasku/ecx-scene2d): Scene graph library example
## World
### Initialization
```haxe
var config = new WorldConfig([...]);
var world = Engine.createWorld(config, ?capacity);
```
## Entity
Entity is just integer id value. `0` is reserved as invalid id.
## Service
All services are known at world creation. World provides possibility to resolve services. `World::resolve` use constant `Class` for resolving. At compile-time these expressions will be translated to lookup array access by constant index with unsafe cast (pseudo example: `cast _services[8]`). For `hxcpp` poiter trick is used to avoid generating `dynamic_cast`.
### Injection
Each service could have dependencies on different services. With `Wire` you could inject your dependencies to instance fields.
For example we need to inject TimeSystem system to our MovementSystem
```haxe
class MovementSystem extends System {
var _time:Wire;
...
override function update() {
var dt = _time.dt;
...
}
}
```
### Family
For all `System` types.
For example we need to track all active(live) entities with components: Transform, Node and Renderable.
```haxe
class MovementSystem extends System {
var _entities:Family;
...
override function update() {
// Note: typeof _entities is Array
for(entity in _entities) {
// only entities with required component will be displayed
trace(entity.id);
}
}
}
```
Sometimes it could be useful to mark some optional component in Family declaration just for readability.
You can wrap each optional Component type in parentheses `()` and it will be ignored by Family, but
will be notated.
```haxe
var _entities:Family;
```
### System Flags
* `IDLE`: System doesn't override `update` method. Should not be updated.
* `CONFIG`: System is defined with `@:config` meta. This system is just configurator. It will be deleted after World initialization phase.
## Component
Component is a way to associate [data] per `Entity`. You could just use component-builders to define your own components.
```haxe
class Position extends AutoComp {}
/// later just use it like Point class per entity
_position.get(entity).x = 10;
```
Or you could create any custom crazy ComponentStorage / ComponentManager.
```haxe
class Color extends Service implements Component {
// BitmapData is used just to demonstrate that you are not limited to anything to store per
// Each pixel is color for entity
var _colors:BitmapData;
...
inline public function get(entity:Entity):Int {
_colors.getPixel32(entity.id % _stride, Std.int(entity.id / _stride));
}
....
}
```
**Injection:** World `Component` is `Service`, so you are able to invoke all messages directly to other services.
**Implementation:** `Component` is just interface, you could iterate all registered components and access their base API per entity. It's handy for automatically cloning or serialization.
## CTTI
`ServiceType`, `ServiceSpec`, `ComponentType`, `ClassMacroTools`
## RTTI
`TypeManager` (WIP)
## Debug
`-D ecx_debug` for debugging
`-D ecx_macro_debug` for macro debugging
`-D ecx_report` to get and analyse `ecx_wires.html` and `ecx_matrix.html` report files generated during compilation
## TODO:
- Rethink world initialization:
- - Are we are ok that instance of service could be created outside by default?
- Rethink system-flags
- Delete configurator services
- Add more information on specific cases of AutoComp
- Pack for dense storage
- Entity Generations