Documentation

The typical way to create a world record, associated Has instances, and initialization function.

makeWorld "MyWorld" [''Component1, ''Component2, ...]

turns into

data MyWorld = MyWorld Component1 Component2 ... EntityCounter
instance MyWorld `Has` Component1 where ...
instance MyWorld `Has` Component2 where ...
...
instance MyWorld `Has` EntityCounter where ...

initMyWorld :: IO MyWorld
initMyWorld = MyWorld <$> initStore <*> initStore <*> ... <*> initStore

Explicitly invoke the garbage collector

Writes the given components to a new entity without yelding the result. Used mostly for convenience.

Writes the given components to a new entity, and yields that entity. The return value is often ignored.

Convenience entity, for use in places where the entity value does not matter, i.e. a global store.

Component used by newEntity to track the number of issued entities. Automatically added to any world created with makeWorld

Collect matching components into a list by using the specified test/process function. You can use this to preprocess data before returning. And you can do a test here that depends on data from multiple components. Pass Just to simply collect all the items.

Monadically fold over the game world. Strict in the accumulator.

Monadically fold over the game world. Strict in the accumulator.

Fold over the game world; for example, cfold max (minBound :: Foo) will find the maximum value of Foo. Strict in the accumulator.

Monadically iterates over all entites with a cx

Monadically iterates over all entites with a cx, and writes their cy.

Maps a function over all entities with a cx, and writes their cy.

modify operator

Applies a function, if possible.

Applies a function, if possible.

Destroys component c for the given entity.

Returns whether the given entity has component c

set operator

Writes a Component to a given Entity. Will overwrite existing Components.

Writes a Component to a given Entity. Will overwrite existing Components.

Read a Component

Run a system in a game world

Run a system in a game world

Pseudocomponent indicating the absence of a. Mainly used as e.g. cmap $ (a, Not b) -> c to iterate over entities with an a but no b. Can also be used to delete components, like cmap $ a -> (Not :: Not a) to delete every a component.

A cache around another store. Caches store their members in a fixed-size vector, so read/write operations become O(1). Caches can provide huge performance boosts, especially when working with large numbers of components.

The cache size is given as a type-level argument.

Note that iterating over a cache is linear in cache size, so sparsely populated caches might decrease performance. In general, the exact size of the cache does not matter as long as it reasonably approximates the number of components present.

The cache uses entity (-2) internally to represent missing entities. If you manually manipulate Entity values, be careful that you do not use (-2)

The actual cache is not necessarily the given argument, but the next biggest power of two. This is allows most operations to be expressed as bit masks, for a large potential performance boost.

An Entity is just an integer, used to index into a component store. In general, use newEntity, cmap, and component tags instead of manipulating these directly.

For performance reasons, negative values like (-1) are reserved for stores to represent special values, so avoid using these.

A SystemT is a newtype around `ReaderT w m a`, where w is the game world variable. Systems serve to

• Allow type-based lookup of a component's store through getStore.
• Lift side effects into their host Monad.

A component is defined by specifying how it is stored. The constraint ensures that stores and components are mapped one-to-one.

Has w m c means that world w can produce a Storage c. It is parameterized over m to allow stores to be foreign.

Initialize a new empty store.

Retrieves a function of the current environment.

Proxy is a type that holds no data, but has a phantom parameter of arbitrary type (or even kind). Its use is to provide type information, even though there is no value available of that type (or it may be too costly to create one).

Historically, Proxy :: Proxy a is a safer alternative to the undefined :: a idiom.

>>> Proxy :: Proxy (Void, Int -> Int)
Proxy

Proxy can even hold types of higher kinds,

>>> Proxy :: Proxy Either
Proxy

>>> Proxy :: Proxy Functor
Proxy

>>> Proxy :: Proxy complicatedStructure
Proxy

Lift a computation from the IO monad. This allows us to run IO computations in any monadic stack, so long as it supports these kinds of operations (i.e. IO is the base monad for the stack).

Example

import Control.Monad.Trans.State -- from the "transformers" library

printState :: Show s => StateT s IO ()
printState = do
  state <- get
  liftIO $ print state

• Couldn't match type ‘IO’ with ‘StateT s IO’
 Expected type: StateT s IO ()
   Actual type: IO ()

> evalStateT printState "hello"
"hello"

> evalStateT printState 3
3

Lift a computation from the argument monad to the constructed monad.

Retrieves the monad environment.