Games.ECS.Component

Components are what hold data in an ECS system.

Documentation

class PseudoComponent (c :: k)

class (AsEmpty (Storage c c), KnownSymbol (CanonicalName c), At (Storage c c), Index (Storage c c) ~ Entity, HasEntitySet (Storage c c)) => Component c where

A component represented in the entity component system.

Minimal complete definition

Nothing

Associated Types

type CanonicalName c :: Symbol

What to name accessors if the type name isn't ergonomic.

type IsFlag c :: Bool

Is the type a flag component?

type IsFlag c = 'False

type Storage c :: Type -> Type

What datatype to store all instances of a component in. Allows for a generalisation of "Structure-of-Arrays". Defaults to HashMap.

type Storage c = ComponentStore

type Prop c :: Props

Arity of the component. Defaults to Normal.

type Prop c = 'Normal

Methods

_ComponentFromXML :: String -> Prism' Element c

A prism for serialising and deserialising the component as XML.

default _ComponentFromXML :: XMLSerialise c => String -> Prism' Element c

entityKeys :: Fold (Storage c c) EntitySet

The collection of entities held in storage.

emptyStorage :: Storage c c

Construct new storage.

entityHasComponent :: Entity -> IndexedTraversal' Entity (Storage c c) c

An AffineTraversal lookup of a given Entity's component. This probably should be in hs.

default entityHasComponent :: IxValue (Storage c c) ~ c => Entity -> IndexedTraversal' Entity (Storage c c) c

defaultValue :: c

When the component is required, provide a default value.

Instances

Component IsPrototype

Defined in Games.ECS.Prototype

Associated Types

type CanonicalName IsPrototype

Defined in Games.ECS.Prototype

type CanonicalName IsPrototype = "isPrototype"

type IsFlag IsPrototype

Defined in Games.ECS.Prototype

type IsFlag IsPrototype = 'False

type Storage IsPrototype

Defined in Games.ECS.Prototype

type Storage IsPrototype = ComponentStore

type Prop IsPrototype

Defined in Games.ECS.Prototype

type Prop IsPrototype = 'Normal

Methods

_ComponentFromXML :: String -> Prism' Element IsPrototype

entityKeys :: Fold (Storage IsPrototype IsPrototype) EntitySet

emptyStorage :: Storage IsPrototype IsPrototype

entityHasComponent :: Entity -> IndexedTraversal' Entity (Storage IsPrototype IsPrototype) IsPrototype

defaultValue :: IsPrototype

Component SpawnedFromPrototype

Defined in Games.ECS.Prototype.SpawnedFromPrototype

Associated Types

type CanonicalName SpawnedFromPrototype

Defined in Games.ECS.Prototype.SpawnedFromPrototype

type CanonicalName SpawnedFromPrototype = "spawnedFromPrototype"

type IsFlag SpawnedFromPrototype

Defined in Games.ECS.Prototype.SpawnedFromPrototype

type IsFlag SpawnedFromPrototype = 'False

type Storage SpawnedFromPrototype

Defined in Games.ECS.Prototype.SpawnedFromPrototype

type Storage SpawnedFromPrototype = ComponentStore

type Prop SpawnedFromPrototype

Defined in Games.ECS.Prototype.SpawnedFromPrototype

type Prop SpawnedFromPrototype = 'Normal

Methods

_ComponentFromXML :: String -> Prism' Element SpawnedFromPrototype

entityKeys :: Fold (Storage SpawnedFromPrototype SpawnedFromPrototype) EntitySet

emptyStorage :: Storage SpawnedFromPrototype SpawnedFromPrototype

entityHasComponent :: Entity -> IndexedTraversal' Entity (Storage SpawnedFromPrototype SpawnedFromPrototype) SpawnedFromPrototype

defaultValue :: SpawnedFromPrototype

type ComponentReference (name :: Symbol) c = Component c => TaggedComponent name Entity

class Component c => CompositeComponent c where

A component comprised of multiple other components.

Minimal complete definition

subComponentReferences

Associated Types

type SubComponentIndex c

Methods

subComponentReferences :: IndexedFold (SubComponentIndex c) c Entity

Look up the entity references of the subcomponents.

components

Arguments

:: forall p f worldType. (World worldType, Indexable (SubComponentIndex c) p, Applicative f)

=> c

The composite component

-> p (worldType 'Individual) (f (worldType 'Individual))

-> worldType 'Storing

-> f (worldType 'Storing)

An IndexedTraversal' of the subcomponents of a composite component.

class Component c => SensoryComponent c

Indicates a component behaves like a sensor.

class Component c => EffectorComponent c

Indicates that a component can perform actions in the world.

class Component c => AttributeComponent c

class Component c => FlagComponent c

Indicates whether a component is a simple Boolean flag.

class Component c => IntentComponent c

A component representing an intent to do something.

class Component c => ReferenceComponent c

class (IntentComponent (Intent c), Component c) => CapabilityComponent c

A component which indicates an ability to emit intents.

Associated Types

type Intent c

newtype UniqueStore a

Storage for Unique components. As a Unique component will have, at most, a single instance in the world, we only need to store the component and its Entity naively.

Constructors

UniqueStore (Maybe (Entity, a))

Instances

Generic (UniqueStore a)

Defined in Games.ECS.Component

Associated Types

type Rep (UniqueStore a)

Defined in Games.ECS.Component

type Rep (UniqueStore a) = D1 ('MetaData "UniqueStore" "Games.ECS.Component" "ohhecs-0.0.2-inplace" 'True) (C1 ('MetaCons "UniqueStore" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Entity, a)))))

Methods

from :: UniqueStore a -> Rep (UniqueStore a) x

to :: Rep (UniqueStore a) x -> UniqueStore a

Show a => Show (UniqueStore a)

Defined in Games.ECS.Component

Methods

showsPrec :: Int -> UniqueStore a -> ShowS

show :: UniqueStore a -> String

showList :: [UniqueStore a] -> ShowS

Eq a => Eq (UniqueStore a)

Defined in Games.ECS.Component

Methods

(==) :: UniqueStore a -> UniqueStore a -> Bool

(/=) :: UniqueStore a -> UniqueStore a -> Bool

(Index (UniqueStore a) ~ Entity, IxValue (UniqueStore a) ~ a) => At (UniqueStore a)

Defined in Games.ECS.Component

Methods

at :: Index (UniqueStore a) -> Lens' (UniqueStore a) (Maybe (IxValue (UniqueStore a)))

Ixed (UniqueStore a)

Defined in Games.ECS.Component

Methods

ix :: Index (UniqueStore a) -> Traversal' (UniqueStore a) (IxValue (UniqueStore a))

AsEmpty (UniqueStore a)

Defined in Games.ECS.Component

Methods

_Empty :: Prism' (UniqueStore a) ()

HasEntitySet (UniqueStore a)

Defined in Games.ECS.Component

Methods

entitySet :: Fold (UniqueStore a) EntitySet

type Rep (UniqueStore a)

Defined in Games.ECS.Component

type Rep (UniqueStore a) = D1 ('MetaData "UniqueStore" "Games.ECS.Component" "ohhecs-0.0.2-inplace" 'True) (C1 ('MetaCons "UniqueStore" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Entity, a)))))

type Index (UniqueStore a)

Defined in Games.ECS.Component

type Index (UniqueStore a) = Entity

type IxValue (UniqueStore a)

Defined in Games.ECS.Component

type IxValue (UniqueStore a) = a

data Has (entity :: k) (component :: k1)

This is an unlawful instance due to entityHasComponent allowing write-back. FIXME: Write a valid definition of entityHasComponent, or make it only a psuedocomponent. instance Component Entity where type Prop Entity = Required

Constructors

Has

type HasA (component :: k) (entity :: k1) = Has entity component

data Hasn't (entity :: k) (component :: k1)

Constructors

Hasn't

type AComponent (name :: Symbol) (s :: Access) a = Field name s (Prop a) a

Simplified type signature to use in world definitions.

newtype TaggedComponent (name :: k) a

A component with an arbitrary name tag.

Constructors

Tagged

Fields

• unTagged :: a

Instances

(Eq a, KnownSymbol name, KnownSymbol (AppendSymbol name "TaggedComponent wrapper"), XMLPickler [Node] a) => XMLPickler [Node] (TaggedComponent name (Maybe a))

Defined in Games.ECS.Component

Methods

xpickle :: PU [Node] (TaggedComponent name (Maybe a))

(KnownSymbol name, KnownSymbol (AppendSymbol name "TaggedComponent wrapper"), XMLPickler [Node] a) => XMLPickler [Node] (TaggedComponent name a)

Defined in Games.ECS.Component

Methods

xpickle :: PU [Node] (TaggedComponent name a)

(KnownSymbol name, XMLPickler [Node] a, Datatype d, ty ~ M1 D d (M1 C c'' (M1 S c (K1 i a :: k -> Type)))) => GXmlPickler [Node] (M1 D d (M1 C c'' (M1 S c (K1 i (TaggedComponent name (Maybe a)) :: Type -> Type))))

An instance for wrapper components. Don't bother with the wrapper constructor or fieldname; just the wrapped data.

Defined in Games.ECS.Component

Methods

gxpicklef :: PU [Node] a0 -> PU [Node] (M1 D d (M1 C c'' (M1 S c (K1 i (TaggedComponent name (Maybe a)) :: Type -> Type))) a0)

gxpickleContentsf :: PU [Node] a0 -> PU [Node] (M1 D d (M1 C c'' (M1 S c (K1 i (TaggedComponent name (Maybe a)) :: Type -> Type))) a0)

Generic a => Generic (TaggedComponent name a)

Defined in Games.ECS.Component

Associated Types

type Rep (TaggedComponent name a)

Defined in Games.ECS.Component

type Rep (TaggedComponent name a) = Rep a

Methods

from :: TaggedComponent name a -> Rep (TaggedComponent name a) x

to :: Rep (TaggedComponent name a) x -> TaggedComponent name a

Show a => Show (TaggedComponent name (Maybe a))

Defined in Games.ECS.Component

Methods

showsPrec :: Int -> TaggedComponent name (Maybe a) -> ShowS

show :: TaggedComponent name (Maybe a) -> String

showList :: [TaggedComponent name (Maybe a)] -> ShowS

Show a => Show (TaggedComponent name a)

Defined in Games.ECS.Component

Methods

showsPrec :: Int -> TaggedComponent name a -> ShowS

show :: TaggedComponent name a -> String

showList :: [TaggedComponent name a] -> ShowS

Eq a => Eq (TaggedComponent name a)

Defined in Games.ECS.Component

Methods

(==) :: TaggedComponent name a -> TaggedComponent name a -> Bool

(/=) :: TaggedComponent name a -> TaggedComponent name a -> Bool

Ord a => Ord (TaggedComponent name a)

Defined in Games.ECS.Component

Methods

compare :: TaggedComponent name a -> TaggedComponent name a -> Ordering

(<) :: TaggedComponent name a -> TaggedComponent name a -> Bool

(<=) :: TaggedComponent name a -> TaggedComponent name a -> Bool

(>) :: TaggedComponent name a -> TaggedComponent name a -> Bool

(>=) :: TaggedComponent name a -> TaggedComponent name a -> Bool

max :: TaggedComponent name a -> TaggedComponent name a -> TaggedComponent name a

min :: TaggedComponent name a -> TaggedComponent name a -> TaggedComponent name a

type Rep (TaggedComponent name a)

Defined in Games.ECS.Component

type Rep (TaggedComponent name a) = Rep a

untag :: forall {k} (name :: k) a. TaggedComponent name a -> a

Get the raw component.

type family Field (name :: Symbol) (acc :: Access) (p :: Props) a where ...

The core mechanics of the higher-kinded representation for the ECS system.

Equations

Field name 'Individual 'Required a = TaggedComponent name a

Field name 'Individual 'Normal a = TaggedComponent name (Maybe a)

Field name 'Individual 'Unique a = TaggedComponent name (Maybe a)

Field name 'Storing 'Unique a = TaggedComponent name (UniqueStore a)

Field name 'Storing 'Required a = TaggedComponent name (Storage a a)

Field name 'Storing 'Normal a = TaggedComponent name (Storage a a)

class EntityProperty (name :: Symbol) (hkd :: Access -> Type) (acc :: Access) (p :: Props) a where

Plumbing class for a higher-kinded data representation of a game world. | Generalisation of "Array of Structures" vs "Structure of Arrays".

Minimal complete definition

accessor, injectToField, maybeGet, defaultField, defaultStorage, storage

Methods

accessor :: OpticsFor name hkd acc p a

injectToField :: a -> Field name 'Individual p a

maybeGet :: Field name 'Individual p a -> Maybe a

injectMaybe :: Maybe a -> Field name 'Individual p a

defaultField :: Field name 'Individual p a

defaultStorage :: Field name 'Storing p a

storage :: Lens' (hkd acc) (Storage a a)

Instances

(HasType (Field name 'Individual 'Normal a) (hkd 'Individual), World hkd, Component a) => EntityProperty name hkd 'Individual 'Normal a

Defined in Games.ECS.Component

Methods

accessor :: OpticsFor name hkd 'Individual 'Normal a

injectToField :: a -> Field name 'Individual 'Normal a

maybeGet :: Field name 'Individual 'Normal a -> Maybe a

injectMaybe :: Maybe a -> Field name 'Individual 'Normal a

defaultField :: Field name 'Individual 'Normal a

defaultStorage :: Field name 'Storing 'Normal a

storage :: Lens' (hkd 'Individual) (Storage a a)

(HasType (Field name 'Individual 'Required a) (hkd 'Individual), World hkd, Component a, Prop a ~ 'Required) => EntityProperty name hkd 'Individual 'Required a

Defined in Games.ECS.Component

Methods

accessor :: OpticsFor name hkd 'Individual 'Required a

injectToField :: a -> Field name 'Individual 'Required a

maybeGet :: Field name 'Individual 'Required a -> Maybe a

injectMaybe :: Maybe a -> Field name 'Individual 'Required a

defaultField :: Field name 'Individual 'Required a

defaultStorage :: Field name 'Storing 'Required a

storage :: Lens' (hkd 'Individual) (Storage a a)

(HasType (Field name 'Individual 'Unique a) (hkd 'Individual), World hkd, Component a) => EntityProperty name hkd 'Individual 'Unique a

Defined in Games.ECS.Component

Methods

accessor :: OpticsFor name hkd 'Individual 'Unique a

injectToField :: a -> Field name 'Individual 'Unique a

maybeGet :: Field name 'Individual 'Unique a -> Maybe a

injectMaybe :: Maybe a -> Field name 'Individual 'Unique a

defaultField :: Field name 'Individual 'Unique a

defaultStorage :: Field name 'Storing 'Unique a

storage :: Lens' (hkd 'Individual) (Storage a a)

(Storage a a ~ UniqueStore a, HasType (Field name 'Storing 'Unique a) (hkd 'Storing), World hkd, Component a) => EntityProperty name hkd 'Storing 'Unique a

Defined in Games.ECS.Component

Methods

accessor :: OpticsFor name hkd 'Storing 'Unique a

injectToField :: a -> Field name 'Individual 'Unique a

maybeGet :: Field name 'Individual 'Unique a -> Maybe a

injectMaybe :: Maybe a -> Field name 'Individual 'Unique a

defaultField :: Field name 'Individual 'Unique a

defaultStorage :: Field name 'Storing 'Unique a

storage :: Lens' (hkd 'Storing) (Storage a a)

(OpticsFor name hkd 'Storing prop a ~ ReifiedIndexedTraversal' Entity (hkd 'Storing) a, HasType (Field name 'Storing prop a) (hkd 'Storing), EntityIndexedTraversable (Storage a) a, World hkd, Component a, Coercible (Field name 'Storing prop a) (Storage a a), Field name 'Storing prop a ~ TaggedComponent name (Storage a a)) => EntityProperty name hkd 'Storing prop a

Defined in Games.ECS.Component

Methods

accessor :: OpticsFor name hkd 'Storing prop a

injectToField :: a -> Field name 'Individual prop a

maybeGet :: Field name 'Individual prop a -> Maybe a

injectMaybe :: Maybe a -> Field name 'Individual prop a

defaultField :: Field name 'Individual prop a

defaultStorage :: Field name 'Storing prop a

storage :: Lens' (hkd 'Storing) (Storage a a)

Orphan instances

(EntityProperty name hkd acc p a, accessorType ~ OpticsFor name hkd acc p a) => IsLabel name accessorType

Methods

fromLabel :: accessorType