Games.ECS.System

Infrastructure for defining ECS Systems.

Documentation

class (World w, Monad m, KnownSymbol (AppendSymbol name " started"), KnownSymbol (AppendSymbol name " finished")) => System (name :: Symbol) (sys :: k) (w :: Access -> Type) (m :: Type -> Type) | name -> sys, sys -> name where

A system which operates on entities which matches certain constraints on components.

Minimal complete definition

Nothing

Associated Types

type RunsAfter (sys :: k) :: [Symbol]

What this systems runs after

type RunsAfter (sys :: k) = '[] :: [Symbol]

type RunsBefore (sys :: k) :: [Symbol]

What this systems runs before

type RunsBefore (sys :: k) = '[] :: [Symbol]

type ComponentFilters (name :: Symbol) (sys :: k) (w :: Access -> Type) (m :: Type -> Type)

Constraints required to run the system.

type ComponentFilters (name :: Symbol) (sys :: k) (w :: Access -> Type) (m :: Type -> Type) = ()

Methods

componentFilter :: (ComponentFilters name sys w m, Monoid r) => Getting r (w 'Storing) IntersectionOfEntities

The filter on components which the system affects

processPredicate :: w 'Individual -> Bool

Should this entity be processed?

processEntity :: w 'Individual -> m (w 'Individual)

Process a single entity

initialiseSystem :: w 'Storing -> m (w 'Storing)

Initialise the system with preliminary data based on a fresh world. The system is allowed to modify the world if it wishes.

runSystem :: w 'Storing -> m (w 'Storing)

Run the system. By default, it runs processEntity for each entity.

postTickCleanup :: w 'Storing -> m (w 'Storing)

Run any cleanup necessary at the end of a tick, such as clearing cached data only necessary for the tick, or marking things as dirty.

runAfterEffects :: w 'Storing -> m (w 'Storing)

Ran after the effect system has finished. This is so that one can, for example, collect all effects to apply during the effect system processing; and once all effects are collected, apply them all at once. This can eliminate redundant processing, as well as later effects not overriding previously-processed effects.