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

Description

Synopsis

data World (m :: Type -> Type) = World {
- entities :: !(Entities m)
- nextEntityId :: !EntityID
- observers :: !(Observers (StateT (World m) m))
}
empty :: forall (m :: Type -> Type). World m
spawn :: forall (m :: Type -> Type). Monad m => BundleT m -> World m -> (EntityID, World m, Access m ())
spawnEmpty :: forall (m :: Type -> Type). World m -> (EntityID, World m)
insert :: forall (m :: Type -> Type). Monad m => EntityID -> BundleT m -> World m -> (World m, Access m ())
insertUntracked :: forall (m :: Type -> Type). Monad m => EntityID -> BundleT m -> World m -> World m
lookup :: forall (m :: Type -> Type) a. Component m a => EntityID -> World m -> Maybe a
remove :: forall (m :: Type -> Type) a. Component m a => EntityID -> World m -> (Maybe a, World m, Access m ())
removeWithId :: forall (m :: Type -> Type) a. Component m a => EntityID -> ComponentID -> World m -> (Maybe a, World m, Access m ())
despawn :: forall (m :: Type -> Type). EntityID -> World m -> (IntMap Dynamic, World m)

Documentation

World of entities and their components.

Constructors

World
Fields entities :: !(Entities m) Entities and their components. nextEntityId :: !EntityID Next unique entity identifier. observers :: !(Observers (StateT (World m) m)) Observers for events.

empty :: forall (m :: Type -> Type). World m Source #

Empty World.

spawn :: forall (m :: Type -> Type). Monad m => BundleT m -> World m -> (EntityID, World m, Access m ()) Source #

Spawn a Bundle into the World. Returns the entity ID, updated world, and onInsert hook.

Spawn an empty entity.

insert :: forall (m :: Type -> Type). Monad m => EntityID -> BundleT m -> World m -> (World m, Access m ()) Source #

Insert a Bundle into an entity. Returns updated world and onInsert hook.

Insert a Bundle into an entity without running lifecycle hooks.

Lookup a component in an entity.

remove :: forall (m :: Type -> Type) a. Component m a => EntityID -> World m -> (Maybe a, World m, Access m ()) Source #

Remove a component from an entity. Returns the component (if found), updated world, and onRemove hook.

Remove a component from an entity with its ComponentID. Returns the component (if found), updated world, and onRemove hook.

Despawn an entity, returning its components.