Apecs.System

Documentation

runSystem :: System w a -> w -> IO a

Run a system with a game world

runWith :: w -> System w a -> IO a

Run a system with a game world

owners :: forall w c. (Has w c, HasMembers (Storage c)) => System w (Slice c)

A slice containing all entities with component c

exists :: forall w c. (Has w c, HasMembers (Storage c)) => Entity c -> System w Bool

Returns whether the given entity has component c For composite components, this indicates whether the component has all its constituents

destroy :: forall w c. (Has w c, HasMembers (Storage c)) => Entity c -> System w ()

Destroys the component c for the given entity

resetStore :: forall w c p. (Has w c, HasMembers (Storage c)) => p c -> System w ()

Removes all components. Equivalent to manually iterating and deleting, but usually optimized.

get :: forall w c. (Store (Storage c), Has w c) => Entity c -> System w (Safe c)

Gets the component for a given entity. This is a safe access, because the entity might not have the requested components.

set :: forall w c e. (IsRuntime c, Has w c) => Entity e -> c -> System w ()

Writes a component to a given entity. Will overwrite existing components.

set' :: forall w c. (IsRuntime c, Has w c) => Entity c -> Safe c -> System w ()

Same as set, but uses Safe to possibly delete a component

modify :: forall w c. (IsRuntime c, Has w c) => Entity c -> (c -> c) -> System w ()

Applies a function if possible. Equivalent to reading, mapping, and writing, but stores can provide optimized implementations.

imapM_ :: forall w c. (Has w c, HasMembers (Storage c)) => (Entity c -> System w ()) -> System w ()

Monadically iterate a system over all entities that have that component. Note that writing to the store while iterating over it is undefined behaviour.

imapM :: forall w c a. (Has w c, HasMembers (Storage c)) => (Entity c -> System w a) -> System w [a]

Monadically iterate a system over all entities that have that component. Note that writing to the store while iterating over it is undefined behaviour.

cmap :: forall world c. (IsRuntime c, Has world c) => (c -> c) -> System world ()

Maps a pure function over all components

cmapM_ :: forall w c. (Has w c, IsRuntime c) => (c -> System w ()) -> System w ()

mapM_ version of cmap

cimapM_ :: forall w c. (Has w c, IsRuntime c) => ((Entity c, c) -> System w ()) -> System w ()

indexed cmapM_, also gives the current entity.

cmapM :: forall w c a. (Has w c, IsRuntime c) => (c -> System w a) -> System w [a]

mapM version of cmap. Can be used to get a list of entities

cimapM :: forall w c a. (Has w c, IsRuntime c) => ((Entity c, c) -> System w a) -> System w [a]

indexed cmapM, also gives the current entity.

cmap' :: forall world c. (Has world c, IsRuntime c) => (c -> Safe c) -> System world ()

Maps a function that might delete its components

rmap :: forall world r w. (Has world w, Has world r, IsRuntime w, IsRuntime r) => (r -> w) -> System world ()

Maps a function over all entities with a r, and writes their w

rmap' :: forall world r w. (Has world w, Has world r, Store (Storage w), IsRuntime r) => (r -> Safe w) -> System world ()

Maps a function over all entities with a r, and writes or deletes their w

wmap :: forall world r w. (Has world w, Has world r, IsRuntime w, IsRuntime r) => (Safe r -> w) -> System world ()

For all entities with a w, this map reads their r and writes their w

wmap' :: forall world r w. (Has world w, Has world r, Store (Storage w), IsRuntime r) => (Safe r -> Safe w) -> System world ()

For all entities with a w, this map reads their r and writes or deletes their w

readGlobal :: forall w c. (Has w c, GlobalRW (Storage c) c) => System w c

Reads a global value

writeGlobal :: forall w c. (Has w c, GlobalRW (Storage c) c) => c -> System w ()

Writes a global value

modifyGlobal :: forall w c. (Has w c, GlobalRW (Storage c) c) => (c -> c) -> System w ()

Modifies a global value