Data.Ecstasy.Types

Documentation

newtype Ent

The key for an entity.

Constructors

Ent

Fields

• unEnt :: Int

Instances

Eq Ent

Methods

(==) :: Ent -> Ent -> Bool

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

Ord Ent

Methods

compare :: Ent -> Ent -> Ordering

(<) :: Ent -> Ent -> Bool

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

(>) :: Ent -> Ent -> Bool

(>=) :: Ent -> Ent -> Bool

max :: Ent -> Ent -> Ent

min :: Ent -> Ent -> Ent

Show Ent

Methods

showsPrec :: Int -> Ent -> ShowS

show :: Ent -> String

showList :: [Ent] -> ShowS

type SystemState w m = (Int, w (WorldOf m))

The internal state of the SystemT monad.

newtype SystemT w m a

A monad transformer over an ECS given a world w.

Constructors

SystemT

Fields

• runSystemT' :: StateT (SystemState w m) m a

Instances

MonadWriter ww m => MonadWriter ww (SystemT w m)

Methods

writer :: (a, ww) -> SystemT w m a

tell :: ww -> SystemT w m ()

listen :: SystemT w m a -> SystemT w m (a, ww)

pass :: SystemT w m (a, ww -> ww) -> SystemT w m a

MonadState s m => MonadState s (SystemT w m)

Methods

get :: SystemT w m s

put :: s -> SystemT w m ()

state :: (s -> (a, s)) -> SystemT w m a

MonadReader r m => MonadReader r (SystemT w m)

Methods

ask :: SystemT w m r

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

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

MonadTrans (SystemT w)

Methods

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

Monad m => Monad (SystemT w m)

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)

Methods

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

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

Monad m => Applicative (SystemT w m)

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)

Methods

liftIO :: IO a -> SystemT w m a

type System w = SystemT w Identity

A monad over an ECS given a world w.

newtype QueryT w m a

A computation to run over a particular entity.

Constructors

QueryT

Fields

• runQueryT' :: ReaderT (Ent, w FieldOf) (MaybeT m) a

Instances

MonadWriter ww m => MonadWriter ww (QueryT w m)

Methods

writer :: (a, ww) -> QueryT w m a

tell :: ww -> QueryT w m ()

listen :: QueryT w m a -> QueryT w m (a, ww)

pass :: QueryT w m (a, ww -> ww) -> QueryT w m a

MonadState s m => MonadState s (QueryT w m)

Methods

get :: QueryT w m s

put :: s -> QueryT w m ()

state :: (s -> (a, s)) -> QueryT w m a

MonadReader r m => MonadReader r (QueryT w m)

Methods

ask :: QueryT w m r

local :: (r -> r) -> QueryT w m a -> QueryT w m a

reader :: (r -> a) -> QueryT w m a

MonadTrans (QueryT w)

Methods

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

Monad m => Monad (QueryT w m)

Methods

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

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

return :: a -> QueryT w m a

fail :: String -> QueryT w m a

Functor m => Functor (QueryT w m)

Methods

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

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

Monad m => Applicative (QueryT w m)

Methods

pure :: a -> QueryT w m a

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

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

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

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

MonadIO m => MonadIO (QueryT w m)

Methods

liftIO :: IO a -> QueryT w m a

Monad m => Alternative (QueryT w m)

Methods

empty :: QueryT w m a

(<|>) :: QueryT w m a -> QueryT w m a -> QueryT w m a

some :: QueryT w m a -> QueryT w m [a]

many :: QueryT w m a -> QueryT w m [a]

Monad m => MonadPlus (QueryT w m)

Methods

mzero :: QueryT w m a

mplus :: QueryT w m a -> QueryT w m a -> QueryT w m a

data VTable m a

A collection of methods necessary to dispatch reads and writes to a Virtual component.

Constructors

VTable

Fields

• vget :: !(Ent -> m (Maybe a))

  Get the value of an entity's component.

• vset :: !(Ent -> Update a -> m ())

  Update the value of an entity's component.

Instances

Applicative m => GSetEntity m (K1 * i (Update a)) (K1 * i' (VTable m a))

Methods

gSetEntity :: K1 * i (Update a) x -> Int -> K1 * i' (VTable m a) x -> m (K1 * i' (VTable m a) x)

Applicative m => GGetEntity m (K1 * i (VTable m a)) (K1 * i' (Maybe a))

Methods

gGetEntity :: K1 * i (VTable m a) x -> Int -> m (K1 * i' (Maybe a) x)

(Applicative m, KnownSymbol sym) => GDefault keep (M1 * S (MetaSel (Just Symbol sym) x y z) (K1 * i (VTable m a)))

Methods

gdef :: M1 * S (MetaSel (Just Symbol sym) x y z) (K1 * i (VTable m a)) a

data StorageType

Data kind used to parameterize the ECS record.

Constructors

FieldOf

Used to describe the actual entity.

WorldOf (Type -> Type)

Used to construct the world's storage.

SetterOf

Used to construct a setter to update an entity.

data ComponentType

Data kind used to parameterize the fields of the ECS record.

Constructors

Field

This component can be owned by any entity.

Unique

This component can be owned by only a single entity at a time.

Virtual

This component is owned by another system.

data Update a

Describes how we can change an a.

Constructors

Keep

Keep the current value.

Unset

Delete the current value if it exists.

Set !a

Set the current value.

Instances

Functor Update

Methods

fmap :: (a -> b) -> Update a -> Update b

(<$) :: a -> Update b -> Update a

Foldable Update

Methods

fold :: Monoid m => Update m -> m

foldMap :: Monoid m => (a -> m) -> Update a -> m

foldr :: (a -> b -> b) -> b -> Update a -> b

foldr' :: (a -> b -> b) -> b -> Update a -> b

foldl :: (b -> a -> b) -> b -> Update a -> b

foldl' :: (b -> a -> b) -> b -> Update a -> b

foldr1 :: (a -> a -> a) -> Update a -> a

foldl1 :: (a -> a -> a) -> Update a -> a

toList :: Update a -> [a]

null :: Update a -> Bool

length :: Update a -> Int

elem :: Eq a => a -> Update a -> Bool

maximum :: Ord a => Update a -> a

minimum :: Ord a => Update a -> a

sum :: Num a => Update a -> a

product :: Num a => Update a -> a

Traversable Update

Methods

traverse :: Applicative f => (a -> f b) -> Update a -> f (Update b)

sequenceA :: Applicative f => Update (f a) -> f (Update a)

mapM :: Monad m => (a -> m b) -> Update a -> m (Update b)

sequence :: Monad m => Update (m a) -> m (Update a)

GDefault False (K1 * i (Update c))

Methods

gdef :: K1 * i (Update c) a

GDefault True (K1 * i (Update c))

Methods

gdef :: K1 * i (Update c) a

Applicative m => GSetEntity m (K1 * i (Update a)) (K1 * i' (IntMap a))

Methods

gSetEntity :: K1 * i (Update a) x -> Int -> K1 * i' (IntMap a) x -> m (K1 * i' (IntMap a) x)

Applicative m => GSetEntity m (K1 * i (Update a)) (K1 * i' (VTable m a))

Methods

gSetEntity :: K1 * i (Update a) x -> Int -> K1 * i' (VTable m a) x -> m (K1 * i' (VTable m a) x)

Applicative m => GSetEntity m (K1 * i (Update a)) (K1 * i' (Maybe (Int, a)))

Methods

gSetEntity :: K1 * i (Update a) x -> Int -> K1 * i' (Maybe (Int, a)) x -> m (K1 * i' (Maybe (Int, a)) x)

Eq a => Eq (Update a)

Methods

(==) :: Update a -> Update a -> Bool

(/=) :: Update a -> Update a -> Bool

Ord a => Ord (Update a)

Methods

compare :: Update a -> Update a -> Ordering

(<) :: Update a -> Update a -> Bool

(<=) :: Update a -> Update a -> Bool

(>) :: Update a -> Update a -> Bool

(>=) :: Update a -> Update a -> Bool

max :: Update a -> Update a -> Update a

min :: Update a -> Update a -> Update a

Read a => Read (Update a)

Methods

readsPrec :: Int -> ReadS (Update a)

readList :: ReadS [Update a]

readPrec :: ReadPrec (Update a)

readListPrec :: ReadPrec [Update a]

Show a => Show (Update a)

Methods

showsPrec :: Int -> Update a -> ShowS

show :: Update a -> String

showList :: [Update a] -> ShowS

GConvertSetter (K1 * i (Maybe a)) (K1 * i' (Update a))

Methods

gConvertSetter :: K1 * i (Maybe a) x -> K1 * i' (Update a) x

GConvertSetter (K1 * i a) (K1 * i' (Update a))

Methods

gConvertSetter :: K1 * i a x -> K1 * i' (Update a) x

type family Component (s :: StorageType) (c :: ComponentType) (a :: Type) :: Type where ...

A type family to be used in your ECS recrod.

Equations

Component FieldOf c a = Maybe a

Component SetterOf c a = Update a

Component (WorldOf m) Field a = IntMap a

Component (WorldOf m) Unique a = Maybe (Int, a)

Component (WorldOf m) Virtual a = VTable m a