Aztecs.ECS.Query.Reader

Queries

newtype QueryReader a

Query to read from entities.

Since: 0.10

Constructors

QueryReader

Fields

• runQueryReader :: Components -> (Set ComponentID, Components, DynamicQueryReader a)

  Run a query reader.

  Since: 0.10

Instances

DynamicQueryReaderF QueryReader

Since: 0.10

Defined in Aztecs.ECS.Query.Reader

Methods

entity :: QueryReader EntityID

fetchDyn :: Component a => ComponentID -> QueryReader a

fetchMaybeDyn :: Component a => ComponentID -> QueryReader (Maybe a)

QueryReaderF QueryReader

Since: 0.10

Defined in Aztecs.ECS.Query.Reader

Methods

fetch :: Component a => QueryReader a

fetchMaybe :: Component a => QueryReader (Maybe a)

Applicative QueryReader

Since: 0.10

Defined in Aztecs.ECS.Query.Reader

Methods

pure :: a -> QueryReader a

(<*>) :: QueryReader (a -> b) -> QueryReader a -> QueryReader b

liftA2 :: (a -> b -> c) -> QueryReader a -> QueryReader b -> QueryReader c

(*>) :: QueryReader a -> QueryReader b -> QueryReader b

(<*) :: QueryReader a -> QueryReader b -> QueryReader a

Functor QueryReader

Defined in Aztecs.ECS.Query.Reader

Methods

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

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

MonadReaderSystem QueryReader System

Since: 0.9

Defined in Aztecs.ECS.System

Methods

all :: QueryReader a -> System [a]

single :: HasCallStack => QueryReader a -> System a

singleMaybe :: QueryReader a -> System (Maybe a)

filter :: QueryReader a -> QueryFilter -> System [a]

Monad m => MonadReaderSystem QueryReader (AccessT m)

Since: 0.9

Defined in Aztecs.ECS.Access

Methods

all :: QueryReader a -> AccessT m [a]

single :: HasCallStack => QueryReader a -> AccessT m a

singleMaybe :: QueryReader a -> AccessT m (Maybe a)

filter :: QueryReader a -> QueryFilter -> AccessT m [a]

class Functor f => QueryReaderF f where

Query reader functor.

Since: 0.10

Minimal complete definition

fetch

Methods

fetch :: Component a => f a

Fetch a Component by its type.

Since: 0.10

fetchMaybe :: Component a => f (Maybe a)

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

Since: 0.10

Instances

QueryReaderF QueryReader

Since: 0.10

Defined in Aztecs.ECS.Query.Reader

Methods

fetch :: Component a => QueryReader a

fetchMaybe :: Component a => QueryReader (Maybe a)

Applicative f => QueryReaderF (QueryT f)

Since: 0.10

Defined in Aztecs.ECS.Query

Methods

fetch :: Component a => QueryT f a

fetchMaybe :: Component a => QueryT f (Maybe a)

class Functor f => DynamicQueryReaderF f where

Dynamic query reader functor.

Since: 0.10

Minimal complete definition

entity, fetchDyn

Methods

entity :: f EntityID

Fetch the currently matched EntityID.

Since: 0.10

fetchDyn :: Component a => ComponentID -> f a

Fetch a Component by its ComponentID.

Since: 0.10

fetchMaybeDyn :: Component a => ComponentID -> f (Maybe a)

Try to fetch a Component by its ComponentID.

Since: 0.10

Instances

DynamicQueryReaderF DynamicQuery

Since: 0.10

Defined in Aztecs.ECS.Query.Dynamic

Methods

entity :: DynamicQuery EntityID

fetchDyn :: Component a => ComponentID -> DynamicQuery a

fetchMaybeDyn :: Component a => ComponentID -> DynamicQuery (Maybe a)

DynamicQueryReaderF DynamicQueryReader

Since: 0.10

Defined in Aztecs.ECS.Query.Dynamic.Reader

Methods

entity :: DynamicQueryReader EntityID

fetchDyn :: Component a => ComponentID -> DynamicQueryReader a

fetchMaybeDyn :: Component a => ComponentID -> DynamicQueryReader (Maybe a)

DynamicQueryReaderF QueryReader

Since: 0.10

Defined in Aztecs.ECS.Query.Reader

Methods

entity :: QueryReader EntityID

fetchDyn :: Component a => ComponentID -> QueryReader a

fetchMaybeDyn :: Component a => ComponentID -> QueryReader (Maybe a)

Applicative f => DynamicQueryReaderF (QueryT f)

Since: 0.10

Defined in Aztecs.ECS.Query

Methods

entity :: QueryT f EntityID

fetchDyn :: Component a => ComponentID -> QueryT f a

fetchMaybeDyn :: Component a => ComponentID -> QueryT f (Maybe a)

Running

all :: QueryReader a -> Entities -> ([a], Entities)

Match all entities.

Since: 0.10

all' :: QueryReader a -> Entities -> ([a], Components)

Match all entities.

Since: 0.10

single :: HasCallStack => QueryReader a -> Entities -> (a, Entities)

Match a single entity.

Since: 0.10

single' :: HasCallStack => QueryReader a -> Entities -> (a, Components)

Match a single entity.

Since: 0.10

singleMaybe :: QueryReader a -> Entities -> (Maybe a, Entities)

Match a single entity.

Since: 0.10

singleMaybe' :: QueryReader a -> Entities -> (Maybe a, Components)

Match a single entity.

Since: 0.10

Filters

newtype QueryFilter

Filter for a Query.

Since: 0.9

Constructors

QueryFilter

Fields

• runQueryFilter :: Components -> (DynamicQueryFilter, Components)

  Run a query filter.

Instances

Monoid QueryFilter

Since: 0.9

Defined in Aztecs.ECS.Query.Reader

Methods

mempty :: QueryFilter

mappend :: QueryFilter -> QueryFilter -> QueryFilter

mconcat :: [QueryFilter] -> QueryFilter

Semigroup QueryFilter

Since: 0.9

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

Filter for entities containing this component.

Since: 0.9

without :: forall a. Component a => QueryFilter

Filter out entities containing this component.

Since: 0.9

data DynamicQueryFilter

Dynamic query for components by ID.

Dynamic query filter.

Since: 0.9

Constructors

DynamicQueryFilter

Fields

• filterWith :: !(Set ComponentID)

  ComponentIDs to include.

  Since: 0.9

• filterWithout :: !(Set ComponentID)

  ComponentIDs to exclude.

  Since: 0.9

Instances

Monoid DynamicQueryFilter

Since: 0.9

Defined in Aztecs.ECS.Query.Dynamic.Reader

Methods

mempty :: DynamicQueryFilter

mappend :: DynamicQueryFilter -> DynamicQueryFilter -> DynamicQueryFilter

mconcat :: [DynamicQueryFilter] -> DynamicQueryFilter

Semigroup DynamicQueryFilter

Since: 0.9

Defined in Aztecs.ECS.Query.Dynamic.Reader

Methods

(<>) :: DynamicQueryFilter -> DynamicQueryFilter -> DynamicQueryFilter

sconcat :: NonEmpty DynamicQueryFilter -> DynamicQueryFilter

stimes :: Integral b => b -> DynamicQueryFilter -> DynamicQueryFilter