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	None
Language	Haskell2010

Aztecs.ECS.Access

Description

Synopsis

newtype Access (m :: Type -> Type) a = Access {
- unAccess :: StateT (World m) m a
}
runAccess :: Functor m => Access m a -> World m -> m (a, World m)
runAccess_ :: Monad m => Access m a -> m a
spawn :: forall (m :: Type -> Type). Monad m => BundleT m -> Access m EntityID
spawn_ :: forall (m :: Type -> Type). Monad m => BundleT m -> Access m ()
insert :: forall (m :: Type -> Type). Monad m => EntityID -> BundleT m -> Access m ()
insertUntracked :: forall (m :: Type -> Type). Monad m => EntityID -> BundleT m -> Access m ()
lookup :: forall (m :: Type -> Type) a. (Monad m, Component m a) => EntityID -> Access m (Maybe a)
remove :: forall (m :: Type -> Type) a. (Monad m, Component m a) => EntityID -> Access m (Maybe a)
despawn :: forall (m :: Type -> Type). Monad m => EntityID -> Access m ()
system :: forall (m :: Type -> Type) a. Monad m => System m a -> Access m a
triggerEvent :: forall (m :: Type -> Type) e. (Monad m, Event e) => e -> Access m ()
triggerEntityEvent :: forall (m :: Type -> Type) e. (Monad m, Event e) => EntityID -> e -> Access m ()

Documentation

newtype Access (m :: Type -> Type) a Source #

Access into a World.

Constructors

Access
Fields unAccess :: StateT (World m) m a

Instances details

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

Run an Access on a World, returning the output and updated World.

Run an Access on an empty World.

spawn_ :: forall (m :: Type -> Type). Monad m => BundleT m -> Access m () Source #

Insert a component into an entity without running lifecycle hooks.

system :: forall (m :: Type -> Type) a. Monad m => System m a -> Access m a Source #

Run a System on the World.

triggerEvent :: forall (m :: Type -> Type) e. (Monad m, Event e) => e -> Access m () Source #

Trigger an event.

Trigger an event for a specific entity.