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
- Queries
- Dynamic Queries
  - Reading
  - Writing
Internal
- Running

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 => Query a -> SystemT m [a]
readQueryT :: Monad m => QueryT m a -> SystemT m [a]
readQueryEntities :: Monad m => [EntityID] -> Query a -> SystemT m [a]
readQueryEntitiesT :: Monad m => [EntityID] -> QueryT m a -> SystemT m [a]
query :: Monad m => Query a -> SystemT m [a]
queryT :: Monad m => QueryT m a -> SystemT m [a]
querySingleMaybe :: Monad m => Query a -> SystemT m (Maybe a)
querySingleMaybeT :: Monad m => QueryT m a -> SystemT m (Maybe a)
fromQuery :: Query a -> SystemT m (DynamicQuery a)
fromQueryT :: Monad m => QueryT m a -> SystemT m (DynamicQueryT m a)
readQueryDyn :: Monad m => DynamicQuery a -> SystemT m [a]
readQueryDynT :: Monad m => DynamicQueryT m a -> SystemT m [a]
readQueryEntitiesDyn :: Monad m => [EntityID] -> DynamicQuery a -> SystemT m [a]
readQueryEntitiesDynT :: Monad m => [EntityID] -> DynamicQueryT m a -> SystemT m [a]
queryDyn :: Monad m => DynamicQuery a -> SystemT m [a]
queryDynT :: Monad m => DynamicQueryT m a -> SystemT m [a]
querySingleMaybeDyn :: Monad m => DynamicQuery a -> SystemT m (Maybe a)
querySingleMaybeDynT :: Monad m => DynamicQueryT m a -> SystemT m (Maybe 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
}
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

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 #

Queries

Reading

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

Match all entities with a Query.

Since: 0.11

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

Match all entities with a QueryT.

Since: 0.11

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

Match entities with a QueryT.

Since: 0.11

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

Match entities with a QueryT.

Since: 0.11

Writing

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

Match and update all entities with a QueryT.

Since: 0.11

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

Match and update all entities with a QueryT.

Since: 0.11

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

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

Since: 0.11

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

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

Since: 0.11

Conversion

fromQuery :: Query a -> SystemT m (DynamicQuery a) Source #

Convert a Query to a SystemT.

Since: 0.11

fromQueryT :: Monad m => QueryT m a -> SystemT m (DynamicQueryT m a) Source #

Convert a QueryT to a SystemT.

Since: 0.11

Dynamic Queries

Reading

readQueryDyn :: Monad m => DynamicQuery a -> SystemT m [a] Source #

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

readQueryEntitiesDyn :: Monad m => [EntityID] -> DynamicQuery a -> SystemT m [a] Source #

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

Writing

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

Map all entities with a DynamicQuery.

Since: 0.11

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

Map all entities with a DynamicQueryT.

Since: 0.11

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

Map a single entity with a DynamicQuery.

Since: 0.11

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

Map a single entity with a DynamicQueryT.

Since: 0.11

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 #

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 #