Apecs.Core

Documentation

newtype Entity

An Entity is really just an Int in a newtype, used to index into a component store.

Constructors

Entity Int

Instances

Eq Entity

Methods

(==) :: Entity -> Entity -> Bool

(/=) :: Entity -> Entity -> Bool

Ord Entity

Methods

compare :: Entity -> Entity -> Ordering

(<) :: Entity -> Entity -> Bool

(<=) :: Entity -> Entity -> Bool

(>) :: Entity -> Entity -> Bool

(>=) :: Entity -> Entity -> Bool

max :: Entity -> Entity -> Entity

min :: Entity -> Entity -> Entity

Show Entity

Methods

showsPrec :: Int -> Entity -> ShowS

show :: Entity -> String

showList :: [Entity] -> ShowS

Component Entity

Associated Types

type Storage Entity :: *

Has w Entity

Methods

getStore :: System w (Storage Entity)

type Storage Entity

type Storage Entity = EntityStore

newtype System w a

A system is a newtype around `ReaderT w IO a`, where w is the game world variable.

Constructors

System

Fields

• unSystem :: ReaderT w IO a

Instances

Monad (System w)

Methods

(>>=) :: System w a -> (a -> System w b) -> System w b

(>>) :: System w a -> System w b -> System w b

return :: a -> System w a

fail :: String -> System w a

Functor (System w)

Methods

fmap :: (a -> b) -> System w a -> System w b

(<$) :: a -> System w b -> System w a

Applicative (System w)

Methods

pure :: a -> System w a

(<*>) :: System w (a -> b) -> System w a -> System w b

liftA2 :: (a -> b -> c) -> System w a -> System w b -> System w c

(*>) :: System w a -> System w b -> System w b

(<*) :: System w a -> System w b -> System w a

MonadIO (System w)

Methods

liftIO :: IO a -> System w a

class (Elem (Storage c) ~ c, Store (Storage c)) => Component c

A component is defined by the type of its storage The storage in turn supplies runtime types for the component. For the component to be valid, its Storage must be an instance of Store.

Associated Types

type Storage c

Instances

Component Entity

Associated Types

type Storage Entity :: *

Component EntityCounter

Associated Types

type Storage EntityCounter :: *

Component c => Component (Maybe c)

Associated Types

type Storage (Maybe c) :: *

Component c => Component (Identity c)

Associated Types

type Storage (Identity c) :: *

Component c => Component (Filter c)

Associated Types

type Storage (Filter c) :: *

Component c => Component (Not c)

Associated Types

type Storage (Not c) :: *

(Component p, Component q) => Component (Either p q)

Associated Types

type Storage (Either p q) :: *

(Component t_0, Component t_1) => Component (t_0, t_1)

Associated Types

type Storage (t_0, t_1) :: *

(Component t_0, Component t_1, Component t_2) => Component (t_0, t_1, t_2)

Associated Types

type Storage (t_0, t_1, t_2) :: *

(Component t_0, Component t_1, Component t_2, Component t_3) => Component (t_0, t_1, t_2, t_3)

Associated Types

type Storage (t_0, t_1, t_2, t_3) :: *

(Component t_0, Component t_1, Component t_2, Component t_3, Component t_4) => Component (t_0, t_1, t_2, t_3, t_4)

Associated Types

type Storage (t_0, t_1, t_2, t_3, t_4) :: *

(Component t_0, Component t_1, Component t_2, Component t_3, Component t_4, Component t_5) => Component (t_0, t_1, t_2, t_3, t_4, t_5)

Associated Types

type Storage (t_0, t_1, t_2, t_3, t_4, t_5) :: *

(Component t_0, Component t_1, Component t_2, Component t_3, Component t_4, Component t_5, Component t_6) => Component (t_0, t_1, t_2, t_3, t_4, t_5, t_6)

Associated Types

type Storage (t_0, t_1, t_2, t_3, t_4, t_5, t_6) :: *

(Component t_0, Component t_1, Component t_2, Component t_3, Component t_4, Component t_5, Component t_6, Component t_7) => Component (t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7)

Associated Types

type Storage (t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7) :: *

class Component c => Has w c where

A world Has a component if it can produce its Storage

Minimal complete definition

getStore

Methods

getStore :: System w (Storage c)

Instances

Has w Entity

Methods

getStore :: System w (Storage Entity)

Has w c => Has w (Identity c)

Methods

getStore :: System w (Storage (Identity c))

Has w c => Has w (Filter c)

Methods

getStore :: System w (Storage (Filter c))

Has w c => Has w (Maybe c)

Methods

getStore :: System w (Storage (Maybe c))

Has w c => Has w (Not c)

Methods

getStore :: System w (Storage (Not c))

(Has w p, Has w q) => Has w (Either p q)

Methods

getStore :: System w (Storage (Either p q))

(Has w t_0, Has w t_1) => Has w (t_0, t_1)

Methods

getStore :: System w (Storage (t_0, t_1))

(Has w t_0, Has w t_1, Has w t_2) => Has w (t_0, t_1, t_2)

Methods

getStore :: System w (Storage (t_0, t_1, t_2))

(Has w t_0, Has w t_1, Has w t_2, Has w t_3) => Has w (t_0, t_1, t_2, t_3)

Methods

getStore :: System w (Storage (t_0, t_1, t_2, t_3))

(Has w t_0, Has w t_1, Has w t_2, Has w t_3, Has w t_4) => Has w (t_0, t_1, t_2, t_3, t_4)

Methods

getStore :: System w (Storage (t_0, t_1, t_2, t_3, t_4))

(Has w t_0, Has w t_1, Has w t_2, Has w t_3, Has w t_4, Has w t_5) => Has w (t_0, t_1, t_2, t_3, t_4, t_5)

Methods

getStore :: System w (Storage (t_0, t_1, t_2, t_3, t_4, t_5))

(Has w t_0, Has w t_1, Has w t_2, Has w t_3, Has w t_4, Has w t_5, Has w t_6) => Has w (t_0, t_1, t_2, t_3, t_4, t_5, t_6)

Methods

getStore :: System w (Storage (t_0, t_1, t_2, t_3, t_4, t_5, t_6))

(Has w t_0, Has w t_1, Has w t_2, Has w t_3, Has w t_4, Has w t_5, Has w t_6, Has w t_7) => Has w (t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7)

Methods

getStore :: System w (Storage (t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7))

class Store s where

Holds components indexed by entities

Laws:

• For all entities in exmplMembers s, explExists s ety must be true.
• If for some entity explExists s ety, explGet s ety should safely return a non-bottom value.

Minimal complete definition

initStore, explSet, explGet, explDestroy, explMembers

Associated Types

type Elem s

The type of components stored by this Store

Methods

initStore :: IO s

Initialize the store with its initialization arguments.

explSet :: s -> Int -> Elem s -> IO ()

Writes a component

explGet :: s -> Int -> IO (Elem s)

Reads a component from the store. What happens if the component does not exist is left undefined.

explDestroy :: s -> Int -> IO ()

Destroys the component for a given index.

explMembers :: s -> IO (Vector Int)

Returns an unboxed vector of member indices

explExists :: s -> Int -> IO Bool

Returns whether there is a component for the given index

Instances

Store EntityStore

Associated Types

type Elem EntityStore :: *

Methods

initStore :: IO EntityStore

explSet :: EntityStore -> Int -> Elem EntityStore -> IO ()

explGet :: EntityStore -> Int -> IO (Elem EntityStore)

explDestroy :: EntityStore -> Int -> IO ()

explMembers :: EntityStore -> IO (Vector Int)

explExists :: EntityStore -> Int -> IO Bool

Store s => Store (Identity s)

Associated Types

type Elem (Identity s) :: *

Methods

initStore :: IO (Identity s)

explSet :: Identity s -> Int -> Elem (Identity s) -> IO ()

explGet :: Identity s -> Int -> IO (Elem (Identity s))

explDestroy :: Identity s -> Int -> IO ()

explMembers :: Identity s -> IO (Vector Int)

explExists :: Identity s -> Int -> IO Bool

Store s => Store (FilterStore s)

Associated Types

type Elem (FilterStore s) :: *

Methods

initStore :: IO (FilterStore s)

explSet :: FilterStore s -> Int -> Elem (FilterStore s) -> IO ()

explGet :: FilterStore s -> Int -> IO (Elem (FilterStore s))

explDestroy :: FilterStore s -> Int -> IO ()

explMembers :: FilterStore s -> IO (Vector Int)

explExists :: FilterStore s -> Int -> IO Bool

Store s => Store (MaybeStore s)

Associated Types

type Elem (MaybeStore s) :: *

Methods

initStore :: IO (MaybeStore s)

explSet :: MaybeStore s -> Int -> Elem (MaybeStore s) -> IO ()

explGet :: MaybeStore s -> Int -> IO (Elem (MaybeStore s))

explDestroy :: MaybeStore s -> Int -> IO ()

explMembers :: MaybeStore s -> IO (Vector Int)

explExists :: MaybeStore s -> Int -> IO Bool

Store s => Store (NotStore s)

Associated Types

type Elem (NotStore s) :: *

Methods

initStore :: IO (NotStore s)

explSet :: NotStore s -> Int -> Elem (NotStore s) -> IO ()

explGet :: NotStore s -> Int -> IO (Elem (NotStore s))

explDestroy :: NotStore s -> Int -> IO ()

explMembers :: NotStore s -> IO (Vector Int)

explExists :: NotStore s -> Int -> IO Bool

Monoid c => Store (Global c)

Associated Types

type Elem (Global c) :: *

Methods

initStore :: IO (Global c)

explSet :: Global c -> Int -> Elem (Global c) -> IO ()

explGet :: Global c -> Int -> IO (Elem (Global c))

explDestroy :: Global c -> Int -> IO ()

explMembers :: Global c -> IO (Vector Int)

explExists :: Global c -> Int -> IO Bool

Store (Unique c)

Associated Types

type Elem (Unique c) :: *

Methods

initStore :: IO (Unique c)

explSet :: Unique c -> Int -> Elem (Unique c) -> IO ()

explGet :: Unique c -> Int -> IO (Elem (Unique c))

explDestroy :: Unique c -> Int -> IO ()

explMembers :: Unique c -> IO (Vector Int)

explExists :: Unique c -> Int -> IO Bool

Store (Map c)

Associated Types

type Elem (Map c) :: *

Methods

initStore :: IO (Map c)

explSet :: Map c -> Int -> Elem (Map c) -> IO ()

explGet :: Map c -> Int -> IO (Elem (Map c))

explDestroy :: Map c -> Int -> IO ()

explMembers :: Map c -> IO (Vector Int)

explExists :: Map c -> Int -> IO Bool

(Store t_0, Store t_1) => Store (t_0, t_1)

Associated Types

type Elem (t_0, t_1) :: *

Methods

initStore :: IO (t_0, t_1)

explSet :: (t_0, t_1) -> Int -> Elem (t_0, t_1) -> IO ()

explGet :: (t_0, t_1) -> Int -> IO (Elem (t_0, t_1))

explDestroy :: (t_0, t_1) -> Int -> IO ()

explMembers :: (t_0, t_1) -> IO (Vector Int)

explExists :: (t_0, t_1) -> Int -> IO Bool

(Store sp, Store sq) => Store (EitherStore sp sq)

Associated Types

type Elem (EitherStore sp sq) :: *

Methods

initStore :: IO (EitherStore sp sq)

explSet :: EitherStore sp sq -> Int -> Elem (EitherStore sp sq) -> IO ()

explGet :: EitherStore sp sq -> Int -> IO (Elem (EitherStore sp sq))

explDestroy :: EitherStore sp sq -> Int -> IO ()

explMembers :: EitherStore sp sq -> IO (Vector Int)

explExists :: EitherStore sp sq -> Int -> IO Bool

(KnownNat n, Cachable s) => Store (Cache n s)

Associated Types

type Elem (Cache n s) :: *

Methods

initStore :: IO (Cache n s)

explSet :: Cache n s -> Int -> Elem (Cache n s) -> IO ()

explGet :: Cache n s -> Int -> IO (Elem (Cache n s))

explDestroy :: Cache n s -> Int -> IO ()

explMembers :: Cache n s -> IO (Vector Int)

explExists :: Cache n s -> Int -> IO Bool

(Store t_0, Store t_1, Store t_2) => Store (t_0, t_1, t_2)

Associated Types

type Elem (t_0, t_1, t_2) :: *

Methods

initStore :: IO (t_0, t_1, t_2)

explSet :: (t_0, t_1, t_2) -> Int -> Elem (t_0, t_1, t_2) -> IO ()

explGet :: (t_0, t_1, t_2) -> Int -> IO (Elem (t_0, t_1, t_2))

explDestroy :: (t_0, t_1, t_2) -> Int -> IO ()

explMembers :: (t_0, t_1, t_2) -> IO (Vector Int)

explExists :: (t_0, t_1, t_2) -> Int -> IO Bool

(Store t_0, Store t_1, Store t_2, Store t_3) => Store (t_0, t_1, t_2, t_3)

Associated Types

type Elem (t_0, t_1, t_2, t_3) :: *

Methods

initStore :: IO (t_0, t_1, t_2, t_3)

explSet :: (t_0, t_1, t_2, t_3) -> Int -> Elem (t_0, t_1, t_2, t_3) -> IO ()

explGet :: (t_0, t_1, t_2, t_3) -> Int -> IO (Elem (t_0, t_1, t_2, t_3))

explDestroy :: (t_0, t_1, t_2, t_3) -> Int -> IO ()

explMembers :: (t_0, t_1, t_2, t_3) -> IO (Vector Int)

explExists :: (t_0, t_1, t_2, t_3) -> Int -> IO Bool

(Store t_0, Store t_1, Store t_2, Store t_3, Store t_4) => Store (t_0, t_1, t_2, t_3, t_4)

Associated Types

type Elem (t_0, t_1, t_2, t_3, t_4) :: *

Methods

initStore :: IO (t_0, t_1, t_2, t_3, t_4)

explSet :: (t_0, t_1, t_2, t_3, t_4) -> Int -> Elem (t_0, t_1, t_2, t_3, t_4) -> IO ()

explGet :: (t_0, t_1, t_2, t_3, t_4) -> Int -> IO (Elem (t_0, t_1, t_2, t_3, t_4))

explDestroy :: (t_0, t_1, t_2, t_3, t_4) -> Int -> IO ()

explMembers :: (t_0, t_1, t_2, t_3, t_4) -> IO (Vector Int)

explExists :: (t_0, t_1, t_2, t_3, t_4) -> Int -> IO Bool

(Store t_0, Store t_1, Store t_2, Store t_3, Store t_4, Store t_5) => Store (t_0, t_1, t_2, t_3, t_4, t_5)

Associated Types

type Elem (t_0, t_1, t_2, t_3, t_4, t_5) :: *

Methods

initStore :: IO (t_0, t_1, t_2, t_3, t_4, t_5)

explSet :: (t_0, t_1, t_2, t_3, t_4, t_5) -> Int -> Elem (t_0, t_1, t_2, t_3, t_4, t_5) -> IO ()

explGet :: (t_0, t_1, t_2, t_3, t_4, t_5) -> Int -> IO (Elem (t_0, t_1, t_2, t_3, t_4, t_5))

explDestroy :: (t_0, t_1, t_2, t_3, t_4, t_5) -> Int -> IO ()

explMembers :: (t_0, t_1, t_2, t_3, t_4, t_5) -> IO (Vector Int)

explExists :: (t_0, t_1, t_2, t_3, t_4, t_5) -> Int -> IO Bool

(Store t_0, Store t_1, Store t_2, Store t_3, Store t_4, Store t_5, Store t_6) => Store (t_0, t_1, t_2, t_3, t_4, t_5, t_6)

Associated Types

type Elem (t_0, t_1, t_2, t_3, t_4, t_5, t_6) :: *

Methods

initStore :: IO (t_0, t_1, t_2, t_3, t_4, t_5, t_6)

explSet :: (t_0, t_1, t_2, t_3, t_4, t_5, t_6) -> Int -> Elem (t_0, t_1, t_2, t_3, t_4, t_5, t_6) -> IO ()

explGet :: (t_0, t_1, t_2, t_3, t_4, t_5, t_6) -> Int -> IO (Elem (t_0, t_1, t_2, t_3, t_4, t_5, t_6))

explDestroy :: (t_0, t_1, t_2, t_3, t_4, t_5, t_6) -> Int -> IO ()

explMembers :: (t_0, t_1, t_2, t_3, t_4, t_5, t_6) -> IO (Vector Int)

explExists :: (t_0, t_1, t_2, t_3, t_4, t_5, t_6) -> Int -> IO Bool

(Store t_0, Store t_1, Store t_2, Store t_3, Store t_4, Store t_5, Store t_6, Store t_7) => Store (t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7)

Associated Types

type Elem (t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7) :: *

Methods

initStore :: IO (t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7)

explSet :: (t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7) -> Int -> Elem (t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7) -> IO ()

explGet :: (t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7) -> Int -> IO (Elem (t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7))

explDestroy :: (t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7) -> Int -> IO ()

explMembers :: (t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7) -> IO (Vector Int)

explExists :: (t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7) -> Int -> IO Bool

data Not a

Psuedocomponent indicating the absence of a.

Constructors

Not

Instances

Has w c => Has w (Not c)

Methods

getStore :: System w (Storage (Not c))

Component c => Component (Not c)

Associated Types

type Storage (Not c) :: *

type Storage (Not c)

type Storage (Not c) = NotStore (Storage c)

newtype NotStore s

Pseudostore used to produce values of type Not a

Constructors

NotStore s

Instances

Store s => Store (NotStore s)

Associated Types

type Elem (NotStore s) :: *

Methods

initStore :: IO (NotStore s)

explSet :: NotStore s -> Int -> Elem (NotStore s) -> IO ()

explGet :: NotStore s -> Int -> IO (Elem (NotStore s))

explDestroy :: NotStore s -> Int -> IO ()

explMembers :: NotStore s -> IO (Vector Int)

explExists :: NotStore s -> Int -> IO Bool

type Elem (NotStore s)

type Elem (NotStore s) = Not (Elem s)

newtype MaybeStore s

Pseudostore used to produce values of type Maybe a

Constructors

MaybeStore s

Instances

Store s => Store (MaybeStore s)

Associated Types

type Elem (MaybeStore s) :: *

Methods

initStore :: IO (MaybeStore s)

explSet :: MaybeStore s -> Int -> Elem (MaybeStore s) -> IO ()

explGet :: MaybeStore s -> Int -> IO (Elem (MaybeStore s))

explDestroy :: MaybeStore s -> Int -> IO ()

explMembers :: MaybeStore s -> IO (Vector Int)

explExists :: MaybeStore s -> Int -> IO Bool

type Elem (MaybeStore s)

type Elem (MaybeStore s) = Maybe (Elem s)

data EitherStore sp sq

Pseudostore used to produce values of type Either p q

Constructors

EitherStore sp sq

Instances

(Store sp, Store sq) => Store (EitherStore sp sq)

Associated Types

type Elem (EitherStore sp sq) :: *

Methods

initStore :: IO (EitherStore sp sq)

explSet :: EitherStore sp sq -> Int -> Elem (EitherStore sp sq) -> IO ()

explGet :: EitherStore sp sq -> Int -> IO (Elem (EitherStore sp sq))

explDestroy :: EitherStore sp sq -> Int -> IO ()

explMembers :: EitherStore sp sq -> IO (Vector Int)

explExists :: EitherStore sp sq -> Int -> IO Bool

type Elem (EitherStore sp sq)

type Elem (EitherStore sp sq) = Either (Elem sp) (Elem sq)

data Filter c

Constructors

Filter

Instances

Has w c => Has w (Filter c)

Methods

getStore :: System w (Storage (Filter c))

Eq (Filter c)

Methods

(==) :: Filter c -> Filter c -> Bool

(/=) :: Filter c -> Filter c -> Bool

Show (Filter c)

Methods

showsPrec :: Int -> Filter c -> ShowS

show :: Filter c -> String

showList :: [Filter c] -> ShowS

Component c => Component (Filter c)

Associated Types

type Storage (Filter c) :: *

type Storage (Filter c)

type Storage (Filter c) = FilterStore (Storage c)

newtype FilterStore s

Constructors

FilterStore s

Instances

Store s => Store (FilterStore s)

Associated Types

type Elem (FilterStore s) :: *

Methods

initStore :: IO (FilterStore s)

explSet :: FilterStore s -> Int -> Elem (FilterStore s) -> IO ()

explGet :: FilterStore s -> Int -> IO (Elem (FilterStore s))

explDestroy :: FilterStore s -> Int -> IO ()

explMembers :: FilterStore s -> IO (Vector Int)

explExists :: FilterStore s -> Int -> IO Bool

type Elem (FilterStore s)

type Elem (FilterStore s) = Filter (Elem s)

data EntityStore

Pseudostore used to produce components of type Entity

Constructors

EntityStore

Instances

Store EntityStore

Associated Types

type Elem EntityStore :: *

Methods

initStore :: IO EntityStore

explSet :: EntityStore -> Int -> Elem EntityStore -> IO ()

explGet :: EntityStore -> Int -> IO (Elem EntityStore)

explDestroy :: EntityStore -> Int -> IO ()

explMembers :: EntityStore -> IO (Vector Int)

explExists :: EntityStore -> Int -> IO Bool

type Elem EntityStore

type Elem EntityStore = Entity