Apecs.Core

Documentation

newtype Entity

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.

Constructors

Entity

Fields

• unEntity :: Int

Instances

Enum Entity

Defined in Apecs.Core

Methods

succ :: Entity -> Entity

pred :: Entity -> Entity

toEnum :: Int -> Entity

fromEnum :: Entity -> Int

enumFrom :: Entity -> [Entity]

enumFromThen :: Entity -> Entity -> [Entity]

enumFromTo :: Entity -> Entity -> [Entity]

enumFromThenTo :: Entity -> Entity -> Entity -> [Entity]

Eq Entity

Defined in Apecs.Core

Methods

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

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

Num Entity

Defined in Apecs.Core

Methods

(+) :: Entity -> Entity -> Entity

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

(*) :: Entity -> Entity -> Entity

negate :: Entity -> Entity

abs :: Entity -> Entity

signum :: Entity -> Entity

fromInteger :: Integer -> Entity

Ord Entity

Defined in Apecs.Core

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

Defined in Apecs.Core

Methods

showsPrec :: Int -> Entity -> ShowS

show :: Entity -> String

showList :: [Entity] -> ShowS

Component Entity

Defined in Apecs.Core

Associated Types

type Storage Entity :: *

Monad m => Has w m Entity

Defined in Apecs.Core

Methods

getStore :: SystemT w m (Storage Entity)

type Storage Entity

Defined in Apecs.Core

type Storage Entity = EntityStore

newtype SystemT w m a

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

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

Constructors

SystemT

Fields

• unSystem :: ReaderT w m a

Instances

Monad m => MonadReader w (SystemT w m)

Defined in Apecs.Core

Methods

ask :: SystemT w m w

local :: (w -> w) -> SystemT w m a -> SystemT w m a

reader :: (w -> a) -> SystemT w m a

MonadTrans (SystemT w)

Defined in Apecs.Core

Methods

lift :: Monad m => m a -> SystemT w m a

Monad m => Monad (SystemT w m)

Defined in Apecs.Core

Methods

(>>=) :: SystemT w m a -> (a -> SystemT w m b) -> SystemT w m b

(>>) :: SystemT w m a -> SystemT w m b -> SystemT w m b

return :: a -> SystemT w m a

fail :: String -> SystemT w m a

Functor m => Functor (SystemT w m)

Defined in Apecs.Core

Methods

fmap :: (a -> b) -> SystemT w m a -> SystemT w m b

(<$) :: a -> SystemT w m b -> SystemT w m a

Applicative m => Applicative (SystemT w m)

Defined in Apecs.Core

Methods

pure :: a -> SystemT w m a

(<*>) :: SystemT w m (a -> b) -> SystemT w m a -> SystemT w m b

liftA2 :: (a -> b -> c) -> SystemT w m a -> SystemT w m b -> SystemT w m c

(*>) :: SystemT w m a -> SystemT w m b -> SystemT w m b

(<*) :: SystemT w m a -> SystemT w m b -> SystemT w m a

MonadIO m => MonadIO (SystemT w m)

Defined in Apecs.Core

Methods

liftIO :: IO a -> SystemT w m a

type System w a = SystemT w IO a

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

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

Associated Types

type Storage c

Instances

Component ()

Defined in Apecs.Core

Associated Types

type Storage () :: *

Component Entity

Defined in Apecs.Core

Associated Types

type Storage Entity :: *

Component EntityCounter

Defined in Apecs.Util

Associated Types

type Storage EntityCounter :: *

Component c => Component (Maybe c)

Defined in Apecs.Core

Associated Types

type Storage (Maybe c) :: *

Component c => Component (Identity c)

Identity component/store. Identity c is equivalent to c, so using it is mostly useless.

Defined in Apecs.Core

Associated Types

type Storage (Identity c) :: *

Component c => Component (Filter c)

Defined in Apecs.Core

Associated Types

type Storage (Filter c) :: *

Component c => Component (Not c)

Defined in Apecs.Core

Associated Types

type Storage (Not c) :: *

(Component ca, Component cb) => Component (Either ca cb)

Defined in Apecs.Core

Associated Types

type Storage (Either ca cb) :: *

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

Defined in Apecs.Core

Associated Types

type Storage (t_0, t_1) :: *

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

Defined in Apecs.Core

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)

Defined in Apecs.Core

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)

Defined in Apecs.Core

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)

Defined in Apecs.Core

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)

Defined in Apecs.Core

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)

Defined in Apecs.Core

Associated Types

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

class (Monad m, Component c) => Has w m c where

Has w m c means that world w can produce a Storage c.

Minimal complete definition

getStore

Methods

getStore :: SystemT w m (Storage c)

Instances

Monad m => Has w m Entity

Defined in Apecs.Core

Methods

getStore :: SystemT w m (Storage Entity)

Monad m => Has w m ()

Defined in Apecs.Core

Methods

getStore :: SystemT w m (Storage ())

Has w m c => Has w m (Identity c)

Defined in Apecs.Core

Methods

getStore :: SystemT w m (Storage (Identity c))

Has w m c => Has w m (Filter c)

Defined in Apecs.Core

Methods

getStore :: SystemT w m (Storage (Filter c))

Has w m c => Has w m (Maybe c)

Defined in Apecs.Core

Methods

getStore :: SystemT w m (Storage (Maybe c))

Has w m c => Has w m (Not c)

Defined in Apecs.Core

Methods

getStore :: SystemT w m (Storage (Not c))

(Has w m ca, Has w m cb) => Has w m (Either ca cb)

Defined in Apecs.Core

Methods

getStore :: SystemT w m (Storage (Either ca cb))

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

Defined in Apecs.Core

Methods

getStore :: SystemT w m (Storage (t_0, t_1))

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

Defined in Apecs.Core

Methods

getStore :: SystemT w m (Storage (t_0, t_1, t_2))

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

Defined in Apecs.Core

Methods

getStore :: SystemT w m (Storage (t_0, t_1, t_2, t_3))

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

Defined in Apecs.Core

Methods

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

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

Defined in Apecs.Core

Methods

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

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

Defined in Apecs.Core

Methods

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

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

Defined in Apecs.Core

Methods

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

type family Elem s

The type of components stored by a store, e.g. Elem (Map c) = c.

Instances

type Elem ()

Defined in Apecs.Core

type Elem () = ()

type Elem EntityStore

Defined in Apecs.Core

type Elem EntityStore = Entity

type Elem (Identity s)

Defined in Apecs.Core

type Elem (Identity s) = Identity (Elem s)

type Elem (FilterStore s)

Defined in Apecs.Core

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

type Elem (MaybeStore s)

Defined in Apecs.Core

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

type Elem (NotStore s)

Defined in Apecs.Core

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

type Elem (Global c)

Defined in Apecs.Stores

type Elem (Global c) = c

type Elem (Unique c)

Defined in Apecs.Stores

type Elem (Unique c) = c

type Elem (Map c)

Defined in Apecs.Stores

type Elem (Map c) = c

type Elem (t_0, t_1)

Defined in Apecs.Core

type Elem (t_0, t_1) = (Elem t_0, Elem t_1)

type Elem (EitherStore sa sb)

Defined in Apecs.Core

type Elem (EitherStore sa sb) = Either (Elem sa) (Elem sb)

type Elem (Cache n s)

Defined in Apecs.Stores

type Elem (Cache n s) = Elem s

type Elem (t_0, t_1, t_2)

Defined in Apecs.Core

type Elem (t_0, t_1, t_2) = (Elem t_0, Elem t_1, Elem t_2)

type Elem (t_0, t_1, t_2, t_3)

Defined in Apecs.Core

type Elem (t_0, t_1, t_2, t_3) = (Elem t_0, Elem t_1, Elem t_2, Elem t_3)

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

Defined in Apecs.Core

type Elem (t_0, t_1, t_2, t_3, t_4) = (Elem t_0, Elem t_1, Elem t_2, Elem t_3, Elem t_4)

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

Defined in Apecs.Core

type Elem (t_0, t_1, t_2, t_3, t_4, t_5) = (Elem t_0, Elem t_1, Elem t_2, Elem t_3, Elem t_4, Elem t_5)

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

Defined in Apecs.Core

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

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

Defined in Apecs.Core

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

class ExplInit m s where

Indicates that the store s can be initialized. Generally, "base" stores like Map c can be initialized, but composite stores like MaybeStore s cannot.

Minimal complete definition

explInit

Methods

explInit :: m s

Initialize a new empty store.

Instances

Monoid c => ExplInit IO (Global c)

Defined in Apecs.Stores

Methods

explInit :: IO (Global c)

ExplInit IO (Unique c)

Defined in Apecs.Stores

Methods

explInit :: IO (Unique c)

ExplInit IO (Map c)

Defined in Apecs.Stores

Methods

explInit :: IO (Map c)

(ExplInit IO s, KnownNat n, Cachable s) => ExplInit IO (Cache n s)

Defined in Apecs.Stores

Methods

explInit :: IO (Cache n s)

class Monad m => ExplGet m s where

Stores that we can read using explGet and explExists. For some entity e, eplGet s e is only guaranteed to be safe if explExists s e returns True.

Minimal complete definition

explGet, explExists

Methods

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

Reads a component from the store. What happens if the component does not exist is left undefined, and might not necessarily crash.

explExists :: s -> Int -> m Bool

Returns whether there is a component for the given index.

Instances

Monad m => ExplGet m EntityStore

Defined in Apecs.Core

Methods

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

explExists :: EntityStore -> Int -> m Bool

Monad m => ExplGet m ()

Defined in Apecs.Core

Methods

explGet :: () -> Int -> m (Elem ())

explExists :: () -> Int -> m Bool

ExplGet IO (Global c)

Defined in Apecs.Stores

Methods

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

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

ExplGet IO (Unique c)

Defined in Apecs.Stores

Methods

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

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

ExplGet IO (Map c)

Defined in Apecs.Stores

Methods

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

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

ExplGet m s => ExplGet m (Identity s)

Defined in Apecs.Core

Methods

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

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

ExplGet m s => ExplGet m (FilterStore s)

Defined in Apecs.Core

Methods

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

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

ExplGet m s => ExplGet m (MaybeStore s)

Defined in Apecs.Core

Methods

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

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

ExplGet m s => ExplGet m (NotStore s)

Defined in Apecs.Core

Methods

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

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

ExplGet IO s => ExplGet IO (Cache n s)

Defined in Apecs.Stores

Methods

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

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

(ExplGet m sa, ExplGet m sb) => ExplGet m (EitherStore sa sb)

Defined in Apecs.Core

Methods

explGet :: EitherStore sa sb -> Int -> m (Elem (EitherStore sa sb))

explExists :: EitherStore sa sb -> Int -> m Bool

(ExplGet m t_0, ExplGet m t_1) => ExplGet m (t_0, t_1)

Defined in Apecs.Core

Methods

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

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

(ExplGet m t_0, ExplGet m t_1, ExplGet m t_2) => ExplGet m (t_0, t_1, t_2)

Defined in Apecs.Core

Methods

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

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

(ExplGet m t_0, ExplGet m t_1, ExplGet m t_2, ExplGet m t_3) => ExplGet m (t_0, t_1, t_2, t_3)

Defined in Apecs.Core

Methods

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

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

(ExplGet m t_0, ExplGet m t_1, ExplGet m t_2, ExplGet m t_3, ExplGet m t_4) => ExplGet m (t_0, t_1, t_2, t_3, t_4)

Defined in Apecs.Core

Methods

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

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

(ExplGet m t_0, ExplGet m t_1, ExplGet m t_2, ExplGet m t_3, ExplGet m t_4, ExplGet m t_5) => ExplGet m (t_0, t_1, t_2, t_3, t_4, t_5)

Defined in Apecs.Core

Methods

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

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

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

Defined in Apecs.Core

Methods

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

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

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

Defined in Apecs.Core

Methods

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

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

class Monad m => ExplSet m s where

Stores that can be written.

Minimal complete definition

explSet

Methods

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

Writes a component to the store.

Instances

Monad m => ExplSet m ()

Defined in Apecs.Core

Methods

explSet :: () -> Int -> Elem () -> m ()

ExplSet IO (Global c)

Defined in Apecs.Stores

Methods

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

ExplSet IO (Unique c)

Defined in Apecs.Stores

Methods

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

ExplSet IO (Map c)

Defined in Apecs.Stores

Methods

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

ExplSet m s => ExplSet m (Identity s)

Defined in Apecs.Core

Methods

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

(ExplDestroy m s, ExplSet m s) => ExplSet m (MaybeStore s)

Defined in Apecs.Core

Methods

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

ExplDestroy m s => ExplSet m (NotStore s)

Defined in Apecs.Core

Methods

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

ExplSet IO s => ExplSet IO (Cache n s)

Defined in Apecs.Stores

Methods

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

(ExplSet m sa, ExplSet m sb) => ExplSet m (EitherStore sa sb)

Defined in Apecs.Core

Methods

explSet :: EitherStore sa sb -> Int -> Elem (EitherStore sa sb) -> m ()

(ExplSet m t_0, ExplSet m t_1) => ExplSet m (t_0, t_1)

Defined in Apecs.Core

Methods

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

(ExplSet m t_0, ExplSet m t_1, ExplSet m t_2) => ExplSet m (t_0, t_1, t_2)

Defined in Apecs.Core

Methods

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

(ExplSet m t_0, ExplSet m t_1, ExplSet m t_2, ExplSet m t_3) => ExplSet m (t_0, t_1, t_2, t_3)

Defined in Apecs.Core

Methods

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

(ExplSet m t_0, ExplSet m t_1, ExplSet m t_2, ExplSet m t_3, ExplSet m t_4) => ExplSet m (t_0, t_1, t_2, t_3, t_4)

Defined in Apecs.Core

Methods

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

(ExplSet m t_0, ExplSet m t_1, ExplSet m t_2, ExplSet m t_3, ExplSet m t_4, ExplSet m t_5) => ExplSet m (t_0, t_1, t_2, t_3, t_4, t_5)

Defined in Apecs.Core

Methods

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

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

Defined in Apecs.Core

Methods

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

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

Defined in Apecs.Core

Methods

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

class Monad m => ExplDestroy m s where

Stores that components can be removed from.

Minimal complete definition

explDestroy

Methods

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

Destroys the component for a given index.

Instances

Monad m => ExplDestroy m ()

Defined in Apecs.Core

Methods

explDestroy :: () -> Int -> m ()

ExplDestroy IO (Unique c)

Defined in Apecs.Stores

Methods

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

ExplDestroy IO (Map c)

Defined in Apecs.Stores

Methods

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

ExplDestroy m s => ExplDestroy m (Identity s)

Defined in Apecs.Core

Methods

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

ExplDestroy IO s => ExplDestroy IO (Cache n s)

Defined in Apecs.Stores

Methods

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

(ExplDestroy m sa, ExplDestroy m sb) => ExplDestroy m (EitherStore sa sb)

Defined in Apecs.Core

Methods

explDestroy :: EitherStore sa sb -> Int -> m ()

(ExplDestroy m t_0, ExplDestroy m t_1) => ExplDestroy m (t_0, t_1)

Defined in Apecs.Core

Methods

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

(ExplDestroy m t_0, ExplDestroy m t_1, ExplDestroy m t_2) => ExplDestroy m (t_0, t_1, t_2)

Defined in Apecs.Core

Methods

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

(ExplDestroy m t_0, ExplDestroy m t_1, ExplDestroy m t_2, ExplDestroy m t_3) => ExplDestroy m (t_0, t_1, t_2, t_3)

Defined in Apecs.Core

Methods

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

(ExplDestroy m t_0, ExplDestroy m t_1, ExplDestroy m t_2, ExplDestroy m t_3, ExplDestroy m t_4) => ExplDestroy m (t_0, t_1, t_2, t_3, t_4)

Defined in Apecs.Core

Methods

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

(ExplDestroy m t_0, ExplDestroy m t_1, ExplDestroy m t_2, ExplDestroy m t_3, ExplDestroy m t_4, ExplDestroy m t_5) => ExplDestroy m (t_0, t_1, t_2, t_3, t_4, t_5)

Defined in Apecs.Core

Methods

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

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

Defined in Apecs.Core

Methods

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

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

Defined in Apecs.Core

Methods

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

class Monad m => ExplMembers m s where

Stores that we can request a list of member entities for.

Minimal complete definition

explMembers

Methods

explMembers :: s -> m (Vector Int)

Returns an unboxed vector of member indices

Instances

ExplMembers IO (Unique c)

Defined in Apecs.Stores

Methods

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

ExplMembers IO (Map c)

Defined in Apecs.Stores

Methods

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

ExplMembers m s => ExplMembers m (Identity s)

Defined in Apecs.Core

Methods

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

ExplMembers m s => ExplMembers m (FilterStore s)

Defined in Apecs.Core

Methods

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

ExplMembers IO s => ExplMembers IO (Cache n s)

Defined in Apecs.Stores

Methods

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

(ExplMembers m t_0, ExplGet m t_1) => ExplMembers m (t_0, t_1)

Defined in Apecs.Core

Methods

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

(ExplMembers m t_0, ExplGet m t_1, ExplGet m t_2) => ExplMembers m (t_0, t_1, t_2)

Defined in Apecs.Core

Methods

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

(ExplMembers m t_0, ExplGet m t_1, ExplGet m t_2, ExplGet m t_3) => ExplMembers m (t_0, t_1, t_2, t_3)

Defined in Apecs.Core

Methods

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

(ExplMembers m t_0, ExplGet m t_1, ExplGet m t_2, ExplGet m t_3, ExplGet m t_4) => ExplMembers m (t_0, t_1, t_2, t_3, t_4)

Defined in Apecs.Core

Methods

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

(ExplMembers m t_0, ExplGet m t_1, ExplGet m t_2, ExplGet m t_3, ExplGet m t_4, ExplGet m t_5) => ExplMembers m (t_0, t_1, t_2, t_3, t_4, t_5)

Defined in Apecs.Core

Methods

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

(ExplMembers m t_0, ExplGet m t_1, ExplGet m t_2, ExplGet m t_3, ExplGet m t_4, ExplGet m t_5, ExplGet m t_6) => ExplMembers m (t_0, t_1, t_2, t_3, t_4, t_5, t_6)

Defined in Apecs.Core

Methods

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

(ExplMembers m t_0, ExplGet m t_1, ExplGet m t_2, ExplGet m t_3, ExplGet m t_4, ExplGet m t_5, ExplGet m t_6, ExplGet m t_7) => ExplMembers m (t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7)

Defined in Apecs.Core

Methods

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

type Get w m c = (Has w m c, ExplGet m (Storage c))

type Set w m c = (Has w m c, ExplSet m (Storage c))

type Members w m c = (Has w m c, ExplMembers m (Storage c))

type Destroy w m c = (Has w m c, ExplDestroy m (Storage c))

data Not a

Psuedocomponent 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.

Constructors

Not

Instances

Has w m c => Has w m (Not c)

Defined in Apecs.Core

Methods

getStore :: SystemT w m (Storage (Not c))

Component c => Component (Not c)

Defined in Apecs.Core

Associated Types

type Storage (Not c) :: *

type Storage (Not c)

Defined in Apecs.Core

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

newtype NotStore s

Pseudostore used to produce values of type Not a, inverts explExists, and destroys instead of explSet.

Constructors

NotStore s

Instances

ExplDestroy m s => ExplSet m (NotStore s)

Defined in Apecs.Core

Methods

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

ExplGet m s => ExplGet m (NotStore s)

Defined in Apecs.Core

Methods

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

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

type Elem (NotStore s)

Defined in Apecs.Core

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

newtype MaybeStore s

Pseudostore used to produce values of type Maybe a. Will always return True for explExists. Writing can both set and delete a component using Just and Nothing respectively.

Constructors

MaybeStore s

Instances

(ExplDestroy m s, ExplSet m s) => ExplSet m (MaybeStore s)

Defined in Apecs.Core

Methods

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

ExplGet m s => ExplGet m (MaybeStore s)

Defined in Apecs.Core

Methods

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

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

type Elem (MaybeStore s)

Defined in Apecs.Core

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

data EitherStore sa sb

Used for Either, a logical disjunction between two components. As expected, Either is used to model error values. Getting an Either a b will first attempt to get a b and return it as Right b, or if it does not exist, get an a as Left a. Can also be used to set one of two things.

Constructors

EitherStore sa sb

Instances

(ExplDestroy m sa, ExplDestroy m sb) => ExplDestroy m (EitherStore sa sb)

Defined in Apecs.Core

Methods

explDestroy :: EitherStore sa sb -> Int -> m ()

(ExplSet m sa, ExplSet m sb) => ExplSet m (EitherStore sa sb)

Defined in Apecs.Core

Methods

explSet :: EitherStore sa sb -> Int -> Elem (EitherStore sa sb) -> m ()

(ExplGet m sa, ExplGet m sb) => ExplGet m (EitherStore sa sb)

Defined in Apecs.Core

Methods

explGet :: EitherStore sa sb -> Int -> m (Elem (EitherStore sa sb))

explExists :: EitherStore sa sb -> Int -> m Bool

type Elem (EitherStore sa sb)

Defined in Apecs.Core

type Elem (EitherStore sa sb) = Either (Elem sa) (Elem sb)

data Filter c

Pseudocomponent that functions normally for explExists and explMembers, but always return Filter for explGet. Can be used in cmap as cmap $ (Filter :: Filter a) -> b. Since the above can be written more consicely as cmap $ (_ :: a) -> b, it is rarely directly. More interestingly, we can define reusable filters like movables = Filter :: Filter (Position, Velocity).

Constructors

Filter

Instances

Has w m c => Has w m (Filter c)

Defined in Apecs.Core

Methods

getStore :: SystemT w m (Storage (Filter c))

Eq (Filter c)

Defined in Apecs.Core

Methods

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

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

Show (Filter c)

Defined in Apecs.Core

Methods

showsPrec :: Int -> Filter c -> ShowS

show :: Filter c -> String

showList :: [Filter c] -> ShowS

Component c => Component (Filter c)

Defined in Apecs.Core

Associated Types

type Storage (Filter c) :: *

type Storage (Filter c)

Defined in Apecs.Core

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

newtype FilterStore s

Constructors

FilterStore s

Instances

ExplMembers m s => ExplMembers m (FilterStore s)

Defined in Apecs.Core

Methods

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

ExplGet m s => ExplGet m (FilterStore s)

Defined in Apecs.Core

Methods

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

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

type Elem (FilterStore s)

Defined in Apecs.Core

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

data EntityStore

Pseudostore used to produce components of type Entity. Always returns True for explExists, and echoes back the entity argument for explGet. Used in e.g. cmap $ (a, ety :: Entity) -> b to access the current entity.

Constructors

EntityStore

Instances

Monad m => ExplGet m EntityStore

Defined in Apecs.Core

Methods

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

explExists :: EntityStore -> Int -> m Bool

type Elem EntityStore

Defined in Apecs.Core

type Elem EntityStore = Entity