Safe Haskell | None |
---|---|
Language | Haskell2010 |
This module forms the apecs Prelude. It selectively re-exports the user-facing functions from the submodules.
Synopsis
- module Data.Proxy
- newtype SystemT w m a = SystemT {}
- type System w a = SystemT w IO a
- class Elem (Storage c) ~ c => Component c where
- type Storage c
- newtype Entity = Entity {}
- class (Monad m, Component c) => Has w m c where
- data Not a = Not
- 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 Destroy w m c = (Has w m c, ExplDestroy m (Storage c))
- type Members w m c = (Has w m c, ExplMembers m (Storage c))
- data Map c
- data Unique c
- data Global c
- data Cache (n :: Nat) s
- explInit :: ExplInit s => IO s
- get :: forall w m c. Get w m c => Entity -> SystemT w m c
- set :: forall w m c. Set w m c => Entity -> c -> SystemT w m ()
- getAll :: forall w m c. (Get w m c, Members w m c) => SystemT w m [c]
- cmap :: forall w m cx cy. (Get w m cx, Members w m cx, Set w m cy) => (cx -> cy) -> SystemT w m ()
- cmapM :: forall w m cx cy. (Get w m cx, Set w m cy, Members w m cx) => (cx -> SystemT w m cy) -> SystemT w m ()
- cmapM_ :: forall w m c a. (Get w m c, Members w m c) => (c -> SystemT w m a) -> SystemT w m ()
- cfold :: forall w m c a. (Members w m c, Get w m c) => (a -> c -> a) -> a -> SystemT w m a
- cfoldM :: forall w m c a. (Members w m c, Get w m c) => (a -> c -> SystemT w m a) -> a -> SystemT w m a
- cfoldM_ :: forall w m c a. (Members w m c, Get w m c) => (a -> c -> SystemT w m a) -> a -> SystemT w m ()
- modify :: forall w m c. (Get w m c, Set w m c) => Entity -> (c -> c) -> SystemT w m ()
- destroy :: forall w m c. Destroy w m c => Entity -> Proxy c -> SystemT w m ()
- exists :: forall w m c. Get w m c => Entity -> Proxy c -> SystemT w m Bool
- runSystem :: SystemT w m a -> w -> m a
- runWith :: w -> SystemT w m a -> m a
- runGC :: System w ()
- data EntityCounter
- newEntity :: (Set w m c, Get w m EntityCounter, Set w m EntityCounter) => c -> SystemT w m Entity
- global :: Entity
- makeWorld :: String -> [Name] -> Q [Dec]
- makeWorldAndComponents :: String -> [Name] -> Q [Dec]
- asks :: MonadReader r m => (r -> a) -> m a
- ask :: MonadReader r m => m r
- liftIO :: MonadIO m => IO a -> m a
- lift :: (MonadTrans t, Monad m) => m a -> t m a
Documentation
module Data.Proxy
Core types
newtype SystemT w m a Source #
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
.
Instances
Monad m => MonadReader w (SystemT w m) Source # | |
MonadTrans (SystemT w) Source # | |
Defined in Apecs.Core | |
Monad m => Monad (SystemT w m) Source # | |
Functor m => Functor (SystemT w m) Source # | |
Applicative m => Applicative (SystemT w m) Source # | |
Defined in Apecs.Core | |
MonadIO m => MonadIO (SystemT w m) Source # | |
Defined in Apecs.Core |
class Elem (Storage c) ~ c => Component c Source #
A component is defined by specifying how it is stored. The constraint ensures that stores and components are mapped one-to-one.
Instances
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.
class (Monad m, Component c) => Has w m c where Source #
Has w m c
means that world w
can produce a Storage c
.
Instances
Monad m => Has w m Entity Source # | |
Monad m => Has w m () Source # | |
Has w m c => Has w m (Identity c) Source # | |
Has w m c => Has w m (Filter c) Source # | |
Has w m c => Has w m (Maybe c) Source # | |
Has w m c => Has w m (Not c) Source # | |
(Has w m ca, Has w m cb) => Has w m (Either ca cb) Source # | |
(Has w m t_0, Has w m t_1) => Has w m (t_0, t_1) Source # | |
(Has w m t_0, Has w m t_1, Has w m t_2) => Has w m (t_0, t_1, t_2) Source # | |
(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) Source # | |
(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) Source # | |
(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) Source # | |
(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) Source # | |
(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) Source # | |
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.
Stores
A map based on Data.IntMap.Strict
. O(log(n)) for most operations.
Instances
ExplMembers IO (Map c) Source # | |
Defined in Apecs.Stores | |
ExplMembers STM (Map c) Source # | |
Defined in Apecs.Stores | |
ExplDestroy IO (Map c) Source # | |
Defined in Apecs.Stores | |
ExplDestroy STM (Map c) Source # | |
Defined in Apecs.Stores | |
ExplSet IO (Map c) Source # | |
ExplSet STM (Map c) Source # | |
ExplGet IO (Map c) Source # | |
ExplGet STM (Map c) Source # | |
ExplInit (Map c) Source # | |
Cachable (Map s) Source # | |
Defined in Apecs.Stores | |
type Elem (Map c) Source # | |
Defined in Apecs.Stores |
A Unique contains zero or one component.
Writing to it overwrites both the previous component and its owner.
Its main purpose is to be a Map
optimized for when only ever one component inhabits it.
Instances
ExplMembers IO (Unique c) Source # | |
Defined in Apecs.Stores | |
ExplMembers STM (Unique c) Source # | |
Defined in Apecs.Stores | |
ExplDestroy IO (Unique c) Source # | |
Defined in Apecs.Stores | |
ExplDestroy STM (Unique c) Source # | |
Defined in Apecs.Stores | |
ExplSet IO (Unique c) Source # | |
ExplSet STM (Unique c) Source # | |
ExplGet IO (Unique c) Source # | |
ExplGet STM (Unique c) Source # | |
ExplInit (Unique c) Source # | |
type Elem (Unique c) Source # | |
Defined in Apecs.Stores |
A Global contains exactly one component.
The initial value is mempty
from the component's Monoid
instance.
When operating on a global, any entity arguments are ignored.
For example, we can get a global component with get 0
or get 1
or even get undefined
.
data Cache (n :: Nat) s Source #
A cache around another store. Caches store their members in a fixed-size vector, so operations run in O(1). Caches can provide huge performance boosts, especially for 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 actually 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 (-1) to internally represent missing entities, so be wary when manually manipulating entities.
Instances
ExplMembers IO s => ExplMembers IO (Cache n s) Source # | |
Defined in Apecs.Stores | |
ExplDestroy IO s => ExplDestroy IO (Cache n s) Source # | |
Defined in Apecs.Stores | |
ExplSet IO s => ExplSet IO (Cache n s) Source # | |
ExplGet IO s => ExplGet IO (Cache n s) Source # | |
(ExplInit s, KnownNat n, Cachable s) => ExplInit (Cache n s) Source # | |
(KnownNat n, Cachable s) => Cachable (Cache n s) Source # | |
Defined in Apecs.Stores | |
type Elem (Cache n s) Source # | |
Defined in Apecs.Stores |
Systems
set :: forall w m c. Set w m c => Entity -> c -> SystemT w m () Source #
Writes a component to a given entity. Will overwrite existing components. The type was originally 'Entity c -> c -> SystemT w m ()', but is relaxed to 'Entity e' so you don't always have to write 'set . cast'
getAll :: forall w m c. (Get w m c, Members w m c) => SystemT w m [c] Source #
Get all components c
.
Call as [(c,Entity)]
to also read the entity index.
cmap :: forall w m cx cy. (Get w m cx, Members w m cx, Set w m cy) => (cx -> cy) -> SystemT w m () Source #
Maps a function over all entities with a cx
, and writes their cy
.
cmapM :: forall w m cx cy. (Get w m cx, Set w m cy, Members w m cx) => (cx -> SystemT w m cy) -> SystemT w m () Source #
Monadically iterates over all entites with a cx
, and writes their cy
.
cmapM_ :: forall w m c a. (Get w m c, Members w m c) => (c -> SystemT w m a) -> SystemT w m () Source #
Monadically iterates over all entites with a cx
cfold :: forall w m c a. (Members w m c, Get w m c) => (a -> c -> a) -> a -> SystemT w m a Source #
Fold over the game world; for example, cfold max (minBound :: Foo)
will find the maximum value of Foo
.
Strict in the accumulator.
cfoldM :: forall w m c a. (Members w m c, Get w m c) => (a -> c -> SystemT w m a) -> a -> SystemT w m a Source #
Monadically fold over the game world. Strict in the accumulator.
cfoldM_ :: forall w m c a. (Members w m c, Get w m c) => (a -> c -> SystemT w m a) -> a -> SystemT w m () Source #
Monadically fold over the game world. Strict in the accumulator.
modify :: forall w m c. (Get w m c, Set w m c) => Entity -> (c -> c) -> SystemT w m () Source #
Applies a function, if possible.
destroy :: forall w m c. Destroy w m c => Entity -> Proxy c -> SystemT w m () Source #
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 m c. Get w m c => Entity -> Proxy c -> SystemT w m Bool Source #
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
data EntityCounter Source #
Component used by newEntity to track the number of issued entities.
Automatically added to any world created with makeWorld
Instances
Eq EntityCounter Source # | |
Defined in Apecs.Util (==) :: EntityCounter -> EntityCounter -> Bool # (/=) :: EntityCounter -> EntityCounter -> Bool # | |
Show EntityCounter Source # | |
Defined in Apecs.Util showsPrec :: Int -> EntityCounter -> ShowS # show :: EntityCounter -> String # showList :: [EntityCounter] -> ShowS # | |
Semigroup EntityCounter Source # | |
Defined in Apecs.Util (<>) :: EntityCounter -> EntityCounter -> EntityCounter # sconcat :: NonEmpty EntityCounter -> EntityCounter # stimes :: Integral b => b -> EntityCounter -> EntityCounter # | |
Monoid EntityCounter Source # | |
Defined in Apecs.Util mempty :: EntityCounter # mappend :: EntityCounter -> EntityCounter -> EntityCounter # mconcat :: [EntityCounter] -> EntityCounter # | |
Component EntityCounter Source # | |
Defined in Apecs.Util type Storage EntityCounter :: * Source # | |
type Storage EntityCounter Source # | |
Defined in Apecs.Util |
newEntity :: (Set w m c, Get w m EntityCounter, Set w m EntityCounter) => c -> SystemT w m Entity Source #
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.
makeWorld :: String -> [Name] -> Q [Dec] Source #
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
|
makeWorldAndComponents :: String -> [Name] -> Q [Dec] Source #
Same as makeWorld, but also makes a component instance:
Re-exports
:: 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.
lift :: (MonadTrans t, Monad m) => m a -> t m a #
Lift a computation from the argument monad to the constructed monad.