Apecs.Experimental.Reactive

This module is experimental, and its API might change between point releases. Use at your own risk.

Adds the Reactive r s store, which when wrapped around store s, will call the react on its r.

Show c => Reactive (Printer c) (Map c) will print a message every time a c value is set.

Enum c => Reactive (EnumMap c) (Map c) allows you to look up entities by component value. Use e.g. withReactive $ enumLookup True to retrieve a list of entities that have a True component.

Reactive (ComponentCounter c) (Map c) tracks the current and max counts of entities with a particular component. Among other things, the max count can be useful in deciding on Cache sizing and the current count can be useful for debugging entity lifecycles. To retrieve the counts, use withReactive readComponentCount.

Documentation

class Monad m => Reacts m r where

Class required by Reactive. Given some r and update information about some component, will run a side-effect in monad m. Note that there are also instances for (,).

Methods

rempty :: m r

react :: Entity -> Maybe (Elem r) -> Maybe (Elem r) -> r -> m ()

Instances

MonadIO m => Reacts m (ComponentCounter c)

Defined in Apecs.Experimental.Reactive

Methods

rempty :: m (ComponentCounter c)

react :: Entity -> Maybe (Elem (ComponentCounter c)) -> Maybe (Elem (ComponentCounter c)) -> ComponentCounter c -> m ()

(MonadIO m, Enum c) => Reacts m (EnumMap c)

Defined in Apecs.Experimental.Reactive

Methods

rempty :: m (EnumMap c)

react :: Entity -> Maybe (Elem (EnumMap c)) -> Maybe (Elem (EnumMap c)) -> EnumMap c -> m ()

(MonadIO m, Ix c, Bounded c) => Reacts m (IxMap c)

Defined in Apecs.Experimental.Reactive

Methods

rempty :: m (IxMap c)

react :: Entity -> Maybe (Elem (IxMap c)) -> Maybe (Elem (IxMap c)) -> IxMap c -> m ()

(MonadIO m, Ord c) => Reacts m (OrdMap c)

Defined in Apecs.Experimental.Reactive

Methods

rempty :: m (OrdMap c)

react :: Entity -> Maybe (Elem (OrdMap c)) -> Maybe (Elem (OrdMap c)) -> OrdMap c -> m ()

(MonadIO m, Show c) => Reacts m (Printer c)

Defined in Apecs.Experimental.Reactive

Methods

rempty :: m (Printer c)

react :: Entity -> Maybe (Elem (Printer c)) -> Maybe (Elem (Printer c)) -> Printer c -> m ()

data Reactive r s

Wrapper for reactivity around some store s.

Instances

(Reacts m r, ExplDestroy m s, ExplGet m s, Elem s ~ Elem r) => ExplDestroy m (Reactive r s)

Defined in Apecs.Experimental.Reactive

Methods

explDestroy :: Reactive r s -> Int -> m ()

ExplGet m s => ExplGet m (Reactive r s)

Defined in Apecs.Experimental.Reactive

Methods

explGet :: Reactive r s -> Int -> m (Elem (Reactive r s))

explExists :: Reactive r s -> Int -> m Bool

(Reacts m r, ExplInit m s) => ExplInit m (Reactive r s)

Defined in Apecs.Experimental.Reactive

Methods

explInit :: m (Reactive r s)

ExplMembers m s => ExplMembers m (Reactive r s)

Defined in Apecs.Experimental.Reactive

Methods

explMembers :: Reactive r s -> m (Vector Int)

(Reacts m r, ExplSet m s, ExplGet m s, Elem s ~ Elem r) => ExplSet m (Reactive r s)

Defined in Apecs.Experimental.Reactive

Methods

explSet :: Reactive r s -> Int -> Elem (Reactive r s) -> m ()

type Elem (Reactive r s)

Defined in Apecs.Experimental.Reactive

type Elem (Reactive r s) = Elem s

withReactive :: forall w m r s a. (Component (Elem r), Has w m (Elem r), Storage (Elem r) ~ Reactive r s) => (r -> m a) -> SystemT w m a

Performs an action with a reactive state token.

data Printer c

Prints a message to stdout every time a component is updated.

Instances

(MonadIO m, Show c) => Reacts m (Printer c)

Defined in Apecs.Experimental.Reactive

Methods

rempty :: m (Printer c)

react :: Entity -> Maybe (Elem (Printer c)) -> Maybe (Elem (Printer c)) -> Printer c -> m ()

type Elem (Printer c)

Defined in Apecs.Experimental.Reactive

type Elem (Printer c) = c

data EnumMap c

Allows you to look up entities by component value. Use e.g. withReactive $ enumLookup True to retrieve a list of entities that have a True component. Based on an IntMap IntSet internally.

Instances

(MonadIO m, Enum c) => Reacts m (EnumMap c)

Defined in Apecs.Experimental.Reactive

Methods

rempty :: m (EnumMap c)

react :: Entity -> Maybe (Elem (EnumMap c)) -> Maybe (Elem (EnumMap c)) -> EnumMap c -> m ()

type Elem (EnumMap c)

Defined in Apecs.Experimental.Reactive

type Elem (EnumMap c) = c

enumLookup :: (MonadIO m, Enum c) => c -> EnumMap c -> m [Entity]

data OrdMap c

Allows you to look up entities by component value. Based on a Map c IntSet internally

Instances

(MonadIO m, Ord c) => Reacts m (OrdMap c)

Defined in Apecs.Experimental.Reactive

Methods

rempty :: m (OrdMap c)

react :: Entity -> Maybe (Elem (OrdMap c)) -> Maybe (Elem (OrdMap c)) -> OrdMap c -> m ()

type Elem (OrdMap c)

Defined in Apecs.Experimental.Reactive

type Elem (OrdMap c) = c

ordLookup :: (MonadIO m, Ord c) => c -> OrdMap c -> m [Entity]

data IxMap c

Allows you to look up entities by component value. Based on an IOArray c IntSet internally

Instances

(MonadIO m, Ix c, Bounded c) => Reacts m (IxMap c)

Defined in Apecs.Experimental.Reactive

Methods

rempty :: m (IxMap c)

react :: Entity -> Maybe (Elem (IxMap c)) -> Maybe (Elem (IxMap c)) -> IxMap c -> m ()

type Elem (IxMap c)

Defined in Apecs.Experimental.Reactive

type Elem (IxMap c) = c

ixLookup :: (MonadIO m, Ix c) => c -> IxMap c -> m [Entity]

data ComponentCounter c

Tracks current and max counts of entities with a particular Component.

Note that if this is used in conjunction with a Global store, produced counts will always be 0.

Instances

MonadIO m => Reacts m (ComponentCounter c)

Defined in Apecs.Experimental.Reactive

Methods

rempty :: m (ComponentCounter c)

react :: Entity -> Maybe (Elem (ComponentCounter c)) -> Maybe (Elem (ComponentCounter c)) -> ComponentCounter c -> m ()

type Elem (ComponentCounter c)

Defined in Apecs.Experimental.Reactive

type Elem (ComponentCounter c) = c

readComponentCount :: forall c m. MonadIO m => ComponentCounter c -> m (ComponentCount c)

data ComponentCount c

A snapshot of the current and max counts of entities with a particular Component.

Produced via readComponentCount.

Constructors

ComponentCount

Fields

• componentCountCurrent :: !Int

  Represents how many entities existed with the Component assigned at the time the snapshot was produced.

• componentCountMax :: !Int

  Represents the max number of entities with the Component assigned that coexisted, as observed at any point between system initialization and the time the snapshot was produced.

Instances

Show (ComponentCount c)

Defined in Apecs.Experimental.Reactive

Methods

showsPrec :: Int -> ComponentCount c -> ShowS

show :: ComponentCount c -> String

showList :: [ComponentCount c] -> ShowS

Eq (ComponentCount c)

Defined in Apecs.Experimental.Reactive

Methods

(==) :: ComponentCount c -> ComponentCount c -> Bool

(/=) :: ComponentCount c -> ComponentCount c -> Bool