Safe Haskell	Safe-Inferred
Language	Haskell2010

Aztecs.ECS.Query

Contents

Queries
- Running
- Conversion
Filters
Reads and writes

Synopsis

newtype Query i o = Query {
- runQuery :: Components -> (ReadsWrites, Components, DynamicQuery i o)
}
class Arrow arr => ArrowQueryReader arr where
- fetch :: Component a => arr () a
- fetchMaybe :: Component a => arr () (Maybe a)
class ArrowQueryReader arr => ArrowQuery arr where
- set :: Component a => arr a a
class Arrow arr => ArrowDynamicQueryReader arr where
- entity :: arr () EntityID
- fetchDyn :: Component a => ComponentID -> arr () a
- fetchMaybeDyn :: Component a => ComponentID -> arr () (Maybe a)
class ArrowDynamicQueryReader arr => ArrowDynamicQuery arr where
- setDyn :: Component a => ComponentID -> arr a a
all :: i -> Query i a -> Entities -> ([a], Entities)
map :: i -> Query i a -> Entities -> ([a], Entities)
fromReader :: QueryReader i o -> Query i o
toReader :: Query i o -> QueryReader i o
newtype QueryFilter = QueryFilter {
- runQueryFilter :: Components -> (DynamicQueryFilter, Components)
}
with :: forall a. Component a => QueryFilter
without :: forall a. Component a => QueryFilter
data ReadsWrites = ReadsWrites {
- reads :: !(Set ComponentID)
- writes :: !(Set ComponentID)
}
disjoint :: ReadsWrites -> ReadsWrites -> Bool

Queries

newtype Query i o Source #

Query for matching entities.

Do notation:

move :: (ArrowQuery arr) => arr () Position
move = proc () -> do
  Velocity v <- Q.fetch -< ()
  Position p <- Q.fetch -< ()
  Q.set -< Position $ p + v

Arrow combinators:

move :: (ArrowQuery arr) => arr () Position
move = Q.fetch &&& Q.fetch >>> arr (\(Position p, Velocity v) -> Position $ p + v) >>> Q.set

Applicative combinators:

move :: (ArrowQuery arr) => arr () Position
move = (,) <$> Q.fetch <*> Q.fetch >>> arr (\(Position p, Velocity v) -> Position $ p + v) >>> Q.set

Constructors

Query
Fields runQuery :: Components -> (ReadsWrites, Components, DynamicQuery i o)

Instances

Instances details

ArrowQuery Query Source #
Instance details Defined in Aztecs.ECS.Query Methods set :: Component a => Query a a Source #
ArrowDynamicQuery Query Source #
Instance details Defined in Aztecs.ECS.Query Methods setDyn :: Component a => ComponentID -> Query a a Source #
ArrowDynamicQueryReader Query Source #
Instance details Defined in Aztecs.ECS.Query Methods entity :: Query () EntityID Source # fetchDyn :: Component a => ComponentID -> Query () a Source # fetchMaybeDyn :: Component a => ComponentID -> Query () (Maybe a) Source #
ArrowQueryReader Query Source #
Instance details Defined in Aztecs.ECS.Query Methods fetch :: Component a => Query () a Source # fetchMaybe :: Component a => Query () (Maybe a) Source #
Arrow Query Source #
Instance details Defined in Aztecs.ECS.Query Methods arr :: (b -> c) -> Query b c # first :: Query b c -> Query (b, d) (c, d) # second :: Query b c -> Query (d, b) (d, c) # (***) :: Query b c -> Query b' c' -> Query (b, b') (c, c') # (&&&) :: Query b c -> Query b c' -> Query b (c, c') #
ArrowChoice Query Source #
Instance details Defined in Aztecs.ECS.Query Methods left :: Query b c -> Query (Either b d) (Either c d) # right :: Query b c -> Query (Either d b) (Either d c) # (+++) :: Query b c -> Query b' c' -> Query (Either b b') (Either c c') # (\|\|\|) :: Query b d -> Query c d -> Query (Either b c) d #
Category Query Source #
Instance details Defined in Aztecs.ECS.Query Methods id :: forall (a :: k). Query a a # (.) :: forall (b :: k) (c :: k) (a :: k). Query b c -> Query a b -> Query a c #
Monad m => ArrowSystem Query (SystemT m) Source #
Instance details Defined in Aztecs.ECS.System Methods map :: Query i a -> SystemT m i [a] Source # map_ :: Query i o -> SystemT m i () Source # filterMap :: Query i a -> QueryFilter -> SystemT m i [a] Source # mapSingle :: Query i a -> SystemT m i a Source # mapSingleMaybe :: Query i a -> SystemT m i (Maybe a) Source #
Applicative (Query i) Source #
Instance details Defined in Aztecs.ECS.Query Methods pure :: a -> Query i a # (<>) :: Query i (a -> b) -> Query i a -> Query i b # liftA2 :: (a -> b -> c) -> Query i a -> Query i b -> Query i c # (>) :: Query i a -> Query i b -> Query i b # (<*) :: Query i a -> Query i b -> Query i a #
Functor (Query i) Source #
Instance details Defined in Aztecs.ECS.Query Methods fmap :: (a -> b) -> Query i a -> Query i b # (<$) :: a -> Query i b -> Query i a #

class Arrow arr => ArrowQueryReader arr where Source #

Arrow for queries that can read from entities.

Minimal complete definition

fetch

Methods

fetch :: Component a => arr () a Source #

Fetch a Component by its type.

fetchMaybe :: Component a => arr () (Maybe a) Source #

Fetch a Component by its type, returning Nothing if it doesn't exist.

Instances

Instances details

ArrowQueryReader Query Source #
Instance details Defined in Aztecs.ECS.Query Methods fetch :: Component a => Query () a Source # fetchMaybe :: Component a => Query () (Maybe a) Source #
ArrowQueryReader QueryReader Source #
Instance details Defined in Aztecs.ECS.Query.Reader Methods fetch :: Component a => QueryReader () a Source # fetchMaybe :: Component a => QueryReader () (Maybe a) Source #

class ArrowQueryReader arr => ArrowQuery arr where Source #

Arrow for queries that can update entities.

Methods

set :: Component a => arr a a Source #

Set a Component by its type.

Instances

Instances details

ArrowQuery Query Source #
Instance details Defined in Aztecs.ECS.Query Methods set :: Component a => Query a a Source #

class Arrow arr => ArrowDynamicQueryReader arr where Source #

Minimal complete definition

entity, fetchDyn

Methods

entity :: arr () EntityID Source #

Fetch the currently matched EntityID.

fetchDyn :: Component a => ComponentID -> arr () a Source #

Fetch a Component by its ComponentID.

fetchMaybeDyn :: Component a => ComponentID -> arr () (Maybe a) Source #

Try to fetch a Component by its ComponentID.

Instances

Instances details

ArrowDynamicQueryReader Query Source #
Instance details Defined in Aztecs.ECS.Query Methods entity :: Query () EntityID Source # fetchDyn :: Component a => ComponentID -> Query () a Source # fetchMaybeDyn :: Component a => ComponentID -> Query () (Maybe a) Source #
ArrowDynamicQueryReader DynamicQuery Source #
Instance details Defined in Aztecs.ECS.Query.Dynamic Methods entity :: DynamicQuery () EntityID Source # fetchDyn :: Component a => ComponentID -> DynamicQuery () a Source # fetchMaybeDyn :: Component a => ComponentID -> DynamicQuery () (Maybe a) Source #
ArrowDynamicQueryReader DynamicQueryReader Source #
Instance details Defined in Aztecs.ECS.Query.Dynamic.Reader Methods entity :: DynamicQueryReader () EntityID Source # fetchDyn :: Component a => ComponentID -> DynamicQueryReader () a Source # fetchMaybeDyn :: Component a => ComponentID -> DynamicQueryReader () (Maybe a) Source #
ArrowDynamicQueryReader QueryReader Source #
Instance details Defined in Aztecs.ECS.Query.Reader Methods entity :: QueryReader () EntityID Source # fetchDyn :: Component a => ComponentID -> QueryReader () a Source # fetchMaybeDyn :: Component a => ComponentID -> QueryReader () (Maybe a) Source #

class ArrowDynamicQueryReader arr => ArrowDynamicQuery arr where Source #

Methods

setDyn :: Component a => ComponentID -> arr a a Source #

Instances

Instances details

ArrowDynamicQuery Query Source #
Instance details Defined in Aztecs.ECS.Query Methods setDyn :: Component a => ComponentID -> Query a a Source #
ArrowDynamicQuery DynamicQuery Source #
Instance details Defined in Aztecs.ECS.Query.Dynamic Methods setDyn :: Component a => ComponentID -> DynamicQuery a a Source #

Running

all :: i -> Query i a -> Entities -> ([a], Entities) Source #

Match all entities.

map :: i -> Query i a -> Entities -> ([a], Entities) Source #

Map all matched entities.

Conversion

fromReader :: QueryReader i o -> Query i o Source #

toReader :: Query i o -> QueryReader i o Source #

Filters

newtype QueryFilter Source #

Filter for a Query.

Constructors

QueryFilter
Fields runQueryFilter :: Components -> (DynamicQueryFilter, Components)

Instances

Instances details

Monoid QueryFilter Source #
Instance details Defined in Aztecs.ECS.Query.Reader Methods mempty :: QueryFilter # mappend :: QueryFilter -> QueryFilter -> QueryFilter # mconcat :: [QueryFilter] -> QueryFilter #
Semigroup QueryFilter Source #
Instance details Defined in Aztecs.ECS.Query.Reader Methods (<>) :: QueryFilter -> QueryFilter -> QueryFilter # sconcat :: NonEmpty QueryFilter -> QueryFilter # stimes :: Integral b => b -> QueryFilter -> QueryFilter #

with :: forall a. Component a => QueryFilter Source #

Filter for entities containing this component.

without :: forall a. Component a => QueryFilter Source #

Filter out entities containing this component.

Reads and writes

data ReadsWrites Source #

Reads and writes of a Query.

Constructors

ReadsWrites
Fields reads :: !(Set ComponentID) writes :: !(Set ComponentID)

Instances

Instances details

Monoid ReadsWrites Source #
Instance details Defined in Aztecs.ECS.Query Methods mempty :: ReadsWrites # mappend :: ReadsWrites -> ReadsWrites -> ReadsWrites # mconcat :: [ReadsWrites] -> ReadsWrites #
Semigroup ReadsWrites Source #
Instance details Defined in Aztecs.ECS.Query Methods (<>) :: ReadsWrites -> ReadsWrites -> ReadsWrites # sconcat :: NonEmpty ReadsWrites -> ReadsWrites # stimes :: Integral b => b -> ReadsWrites -> ReadsWrites #
Show ReadsWrites Source #
Instance details Defined in Aztecs.ECS.Query Methods showsPrec :: Int -> ReadsWrites -> ShowS # show :: ReadsWrites -> String # showList :: [ReadsWrites] -> ShowS #

disjoint :: ReadsWrites -> ReadsWrites -> Bool Source #

True if the reads and writes of two Querys overlap.