Apecs.Util

Utility

runGC :: System w ()

Explicitly invoke the garbage collector

global :: Entity

Convenience entity, for use in places where the entity value does not matter, i.e. a global store.

EntityCounter

newtype EntityCounter

Component used by newEntity to track the number of issued entities. Automatically added to any world created with makeWorld

Constructors

EntityCounter

Fields

• getCounter :: Sum Int

Instances

Eq EntityCounter

Defined in Apecs.Util

Methods

(==) :: EntityCounter -> EntityCounter -> Bool

(/=) :: EntityCounter -> EntityCounter -> Bool

Show EntityCounter

Defined in Apecs.Util

Methods

showsPrec :: Int -> EntityCounter -> ShowS

show :: EntityCounter -> String

showList :: [EntityCounter] -> ShowS

Semigroup EntityCounter

Defined in Apecs.Util

Methods

(<>) :: EntityCounter -> EntityCounter -> EntityCounter

sconcat :: NonEmpty EntityCounter -> EntityCounter

stimes :: Integral b => b -> EntityCounter -> EntityCounter

Monoid EntityCounter

Defined in Apecs.Util

Methods

mempty :: EntityCounter

mappend :: EntityCounter -> EntityCounter -> EntityCounter

mconcat :: [EntityCounter] -> EntityCounter

Component EntityCounter

Defined in Apecs.Util

Associated Types

type Storage EntityCounter

type Storage EntityCounter

Defined in Apecs.Util

type Storage EntityCounter = ReadOnly (Global EntityCounter)

nextEntity :: (MonadIO m, Get w m EntityCounter) => SystemT w m Entity

Bumps the EntityCounter and yields its value

newEntity :: (MonadIO m, Set w m c, Get w m EntityCounter) => c -> SystemT w m Entity

Writes the given components to a new entity, and yields that entity. The return value is often ignored.

newEntity_ :: (MonadIO m, Set world m component, Get world m EntityCounter) => component -> SystemT world m ()

Writes the given components to a new entity without yelding the result. Used mostly for convenience.