Apecs

This module forms the apecs Prelude. It selectively re-exports the user-facing functions from the submodules.

Types

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) :: *

newtype Entity

An Entity is really just an Int in a newtype.

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

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))

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)

data Map c

A map from Data.Intmap.Strict. O(log(n)) for most operations. Yields safe runtime representations of type Maybe c.

Instances

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

Cachable (Map s)

type Elem (Map c)

type Elem (Map c) = c

data Unique c

A Unique contains at most one component. Writing to it overwrites both the previous component and its owner.

Instances

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

type Elem (Unique c)

type Elem (Unique c) = c

data Global c

A Global contains exactly one component. Initialized with mempty

Instances

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

type Elem (Global c)

type Elem (Global c) = c

Store wrapper functions

initStore :: Store s => IO s

get :: forall w c. Has w c => Entity -> System w c

set :: forall w c. Has w c => Entity -> c -> System w ()

Writes a component to a given entity. Will overwrite existing components. The type was originally 'Entity c -> c -> System w ()', but is relaxed to 'Entity e' so you don't always have to write 'set . cast'

cmap :: forall world cx cy. (Has world cx, Has world cy) => (cx -> cy) -> System world ()

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

cmapM :: forall world c a. Has world c => (c -> System world a) -> System world [a]

Monadically iterates over all entites with a cx

cmapM_ :: forall world c a. Has world c => (c -> System world a) -> System world ()

Monadically iterates over all entites with a cx

modify :: forall w c. Has w c => Entity -> (c -> c) -> System w ()

Applies a function, if possible.

destroy :: forall w c. Has w c => Entity -> c -> System w ()

Destroys component c for the given entity. Note that c is a phantom argument, used only to convey the type of the entity to be destroyed.

exists :: forall w c. Has w c => Entity -> c -> System w Bool

Returns whether the given entity has component c Note that c is a phantom argument, used only to convey the type of the entity to be queried.

Other

runSystem :: System w a -> w -> IO a

Run a system with a game world

runWith :: w -> System w a -> IO a

Run a system with a game world

runGC :: System w ()

Explicitly invoke the garbage collector

data EntityCounter

Secretly just an int in a newtype

Instances

Eq EntityCounter

Methods

(==) :: EntityCounter -> EntityCounter -> Bool

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

Show EntityCounter

Methods

showsPrec :: Int -> EntityCounter -> ShowS

show :: EntityCounter -> String

showList :: [EntityCounter] -> ShowS

Monoid EntityCounter

Methods

mempty :: EntityCounter

mappend :: EntityCounter -> EntityCounter -> EntityCounter

mconcat :: [EntityCounter] -> EntityCounter

Component EntityCounter

Associated Types

type Storage EntityCounter :: *

type Storage EntityCounter

type Storage EntityCounter = Global EntityCounter

newEntity :: (Store (Storage c), Has w c, Has w EntityCounter) => c -> System w Entity

Writes the given components to a new entity, and yields that entity

global :: Entity

proxy :: forall t. t

makeWorld :: String -> [Name] -> Q [Dec]

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

turns into

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

initWorldName :: IO WorldName
initWorldName = WorldName <$> initStore <*> initStore <*> ... <*> initStore

|

Re-exports

asks

Arguments

:: MonadReader r m

=> (r -> a)

The selector function to apply to the environment.

-> m a

Retrieves a function of the current environment.

ask :: MonadReader r m => m r

Retrieves the monad environment.

liftIO :: MonadIO m => forall a. IO a -> m a

Lift a computation from the IO monad.

lift :: MonadTrans t => forall (m :: * -> *) a. Monad m => m a -> t m a

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