API Reference ECSx v0.5.1

modules

Modules

ECSx is an Entity-Component-System (ECS) framework for Elixir.

A store to which clients can write, for communication with the ECSx backend.

A Component labels an entity as having a certain attribute, and holds any data needed to model that attribute.

The Manager for your ECSx application.

By default, ECSx persists component data by writing a binary file to disk, then reading the file when the server restarts. If you would like to use a different method, you can create a module which implements this behaviour, and update the ECSx configuration to use your module instead of the default.

A fragment of game logic which reads and updates Components.

A component type which does not require a value. This is useful when the mere presence or absence of a component is all the information we need.

mix-tasks

Mix Tasks

Generates a new Component type for an ECSx application.

Generates a new System for an ECSx application.

Generates a new ECSx Tag - a Component type which doesn't store any value.

Generates the Manager process which runs an ECSx application.