aztecs-0.12.0: A modular game engine and Entity-Component-System (ECS) for Haskell.

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.View

Description

Synopsis

newtype View = View {
- viewArchetypes :: Map ArchetypeID Node
}
view :: QueryFilter -> Archetypes -> View
viewSingle :: QueryFilter -> Archetypes -> Maybe View
null :: View -> Bool
unview :: View -> Entities -> Entities
allDyn :: Monad m => DynamicQueryT m a -> View -> m [a]
singleDyn :: Monad m => DynamicQueryT m a -> View -> m (Maybe a)
mapDyn :: Monad m => DynamicQueryT m a -> View -> m ([a], View)
mapSingleDyn :: Monad m => DynamicQueryT m a -> View -> m (Maybe a, View)

Documentation

newtype View Source #

View into a World, containing a subset of archetypes.

Since: 0.9

Constructors

View
Fields viewArchetypes :: Map ArchetypeID Node Archetypes contained in this view. Since: 0.9

Instances

Instances details

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

view :: QueryFilter -> Archetypes -> View Source #

View into all archetypes containing the provided component IDs.

Since: 0.9

viewSingle :: QueryFilter -> Archetypes -> Maybe View Source #

View into a single archetype containing the provided component IDs.

Since: 0.9

null :: View -> Bool Source #

True if the View is empty.

Since: 0.9

unview :: View -> Entities -> Entities Source #

"Un-view" a View back into a World.

Since: 0.9

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

Query all matching entities in a View.

Since: 0.9

singleDyn :: Monad m => DynamicQueryT m a -> View -> m (Maybe a) Source #

Query all matching entities in a View.

Since: 0.9

mapDyn :: Monad m => DynamicQueryT m a -> View -> m ([a], View) Source #

Map all matching entities in a View.

Since: 0.9

mapSingleDyn :: Monad m => DynamicQueryT m a -> View -> m (Maybe a, View) Source #

Map a single matching entity in a View.

Since: 0.9