Copyright	(c) Matt Hunzinger 2025
License	BSD-style (see the LICENSE file in the distribution)
Maintainer	matt@hunzinger.me
Stability	provisional
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Aztecs.ECS.System

Contents

Systems
Internal

Description

Systems to process entities.

Synopsis

type System = SystemT Identity
newtype SystemT m a = System {
- unSystem :: forall t. (MonadTrans t, Monad (t m)) => Job t m a
}
readQuery :: Monad m => QueryT m a -> SystemT m [a]
allDyn :: Monad m => DynamicQueryT m a -> SystemT m [a]
readQueryEntities :: Monad m => [EntityID] -> QueryT m a -> SystemT m [a]
query :: Monad m => QueryT m a -> SystemT m [a]
querySingleMaybe :: Monad m => QueryT m a -> SystemT m (Maybe a)
queryDyn :: Monad m => DynamicQueryT m a -> SystemT m [a]
querySingleMaybeDyn :: Monad m => DynamicQueryT m a -> SystemT m (Maybe a)
runSystemT :: (MonadTrans t, Monad (t m), Monad m) => SystemT m a -> ((Entities -> Entities) -> t m Entities) -> t m a
concurrently :: SystemT IO a -> ((Entities -> Entities) -> IO Entities) -> IO a
data Job t m a where
- Pure :: a -> Job t m a
- Map :: (a -> b) -> Job t m a -> Job t m b
- Ap :: Job t m (a -> b) -> Job t m a -> Job t m b
- Bind :: Job t m a -> (a -> Job t m b) -> Job t m b
- Once :: Task t m a -> Job t m a
newtype Task t (m :: Type -> Type) a = Task {
- runTask :: ((Entities -> Entities) -> t m Entities) -> t m a
}

Systems

type System = SystemT Identity Source #

newtype SystemT m a Source #

System to process entities.

Since: 0.11

Constructors

System
Fields unSystem :: forall t. (MonadTrans t, Monad (t m)) => Job t m a

Instances

Instances details

MonadIO m => MonadIO (SystemT m) Source #	Since: 0.11
Instance details Defined in Aztecs.ECS.System Methods liftIO :: IO a -> SystemT m a #
Monad m => Applicative (SystemT m) Source #	Since: 0.11
Instance details Defined in Aztecs.ECS.System Methods pure :: a -> SystemT m a # (<>) :: SystemT m (a -> b) -> SystemT m a -> SystemT m b # liftA2 :: (a -> b -> c) -> SystemT m a -> SystemT m b -> SystemT m c # (>) :: SystemT m a -> SystemT m b -> SystemT m b # (<*) :: SystemT m a -> SystemT m b -> SystemT m a #
Functor (SystemT m) Source #	Since: 0.11
Instance details Defined in Aztecs.ECS.System Methods fmap :: (a -> b) -> SystemT m a -> SystemT m b # (<$) :: a -> SystemT m b -> SystemT m a #
Monad m => Monad (SystemT m) Source #	Since: 0.11
Instance details Defined in Aztecs.ECS.System Methods (>>=) :: SystemT m a -> (a -> SystemT m b) -> SystemT m b # (>>) :: SystemT m a -> SystemT m b -> SystemT m b # return :: a -> SystemT m a #

Reading

readQuery :: Monad m => QueryT m a -> SystemT m [a] Source #

Match all entities with a QueryT.

Since: 0.11

allDyn :: Monad m => DynamicQueryT m a -> SystemT m [a] Source #

readQueryEntities :: Monad m => [EntityID] -> QueryT m a -> SystemT m [a] Source #

Match entities with a QueryT.

Since: 0.11

Writing

query :: Monad m => QueryT m a -> SystemT m [a] Source #

Match and update all entities with a QueryT.

Since: 0.11

querySingleMaybe :: Monad m => QueryT m a -> SystemT m (Maybe a) Source #

Match and update a single entity with a QueryT, or Nothing.

Since: 0.11

queryDyn :: Monad m => DynamicQueryT m a -> SystemT m [a] Source #

Map all entities with a DynamicQueryT.

Since: 0.11

querySingleMaybeDyn :: Monad m => DynamicQueryT m a -> SystemT m (Maybe a) Source #

Map a single entity with a DynamicQueryT.

Since: 0.11

Running

runSystemT :: (MonadTrans t, Monad (t m), Monad m) => SystemT m a -> ((Entities -> Entities) -> t m Entities) -> t m a Source #

concurrently :: SystemT IO a -> ((Entities -> Entities) -> IO Entities) -> IO a Source #

Internal

data Job t m a where Source #

Job to be interpreted.

Since: 0.11

Constructors

Pure :: a -> Job t m a
Map :: (a -> b) -> Job t m a -> Job t m b
Ap :: Job t m (a -> b) -> Job t m a -> Job t m b
Bind :: Job t m a -> (a -> Job t m b) -> Job t m b
Once :: Task t m a -> Job t m a

newtype Task t (m :: Type -> Type) a Source #

System task.

Since: 0.11

Constructors

Task
Fields runTask :: ((Entities -> Entities) -> t m Entities) -> t m a

Instances

Instances details

Functor (t m) => Functor (Task t m) Source #
Instance details Defined in Aztecs.ECS.System Methods fmap :: (a -> b) -> Task t m a -> Task t m b # (<$) :: a -> Task t m b -> Task t m a #