ohhecs-0.0.1: An Entity-Component-Systems engine core.
Copyright(C) 2020 Sophie Taylor
LicenseAGPL-3.0-or-later
MaintainerSophie Taylor <sophie@spacekitteh.moe>
Stabilityexperimental
PortabilityGHC
Safe HaskellTrustworthy
LanguageGHC2021

Games.ECS.Prototype

Description

Prototypes are exemplar individuals which form a template.

Synopsis

Documentation

newtype PrototypeID Source #

A prototype's ID is distinct from its entity reference in that it is stable, and in a unique namespace.

Constructors

PrototypeID 

Fields

Instances

Instances details
Bounded PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

minBound :: PrototypeID #

maxBound :: PrototypeID #

Enum PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

succ :: PrototypeID -> PrototypeID #

pred :: PrototypeID -> PrototypeID #

toEnum :: Int -> PrototypeID #

fromEnum :: PrototypeID -> Int #

enumFrom :: PrototypeID -> [PrototypeID] #

enumFromThen :: PrototypeID -> PrototypeID -> [PrototypeID] #

enumFromTo :: PrototypeID -> PrototypeID -> [PrototypeID] #

enumFromThenTo :: PrototypeID -> PrototypeID -> PrototypeID -> [PrototypeID] #

Generic PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

Associated Types

type Rep PrototypeID 
Instance details

Defined in Games.ECS.Prototype

type Rep PrototypeID = D1 ('MetaData "PrototypeID" "Games.ECS.Prototype" "ohhecs-0.0.1-inplace" 'True) (C1 ('MetaCons "PrototypeID" 'PrefixI 'True) (S1 ('MetaSel ('Just "_unPrototypeID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

Methods

from :: PrototypeID -> Rep PrototypeID x #

to :: Rep PrototypeID x -> PrototypeID #

Ix PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

range :: (PrototypeID, PrototypeID) -> [PrototypeID] #

index :: (PrototypeID, PrototypeID) -> PrototypeID -> Int #

unsafeIndex :: (PrototypeID, PrototypeID) -> PrototypeID -> Int #

inRange :: (PrototypeID, PrototypeID) -> PrototypeID -> Bool #

rangeSize :: (PrototypeID, PrototypeID) -> Int #

unsafeRangeSize :: (PrototypeID, PrototypeID) -> Int #

Show PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

showsPrec :: Int -> PrototypeID -> ShowS #

show :: PrototypeID -> String #

showList :: [PrototypeID] -> ShowS #

Eq PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

(==) :: PrototypeID -> PrototypeID -> Bool #

(/=) :: PrototypeID -> PrototypeID -> Bool #

Ord PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

compare :: PrototypeID -> PrototypeID -> Ordering #

(<) :: PrototypeID -> PrototypeID -> Bool #

(<=) :: PrototypeID -> PrototypeID -> Bool #

(>) :: PrototypeID -> PrototypeID -> Bool #

(>=) :: PrototypeID -> PrototypeID -> Bool #

max :: PrototypeID -> PrototypeID -> PrototypeID #

min :: PrototypeID -> PrototypeID -> PrototypeID #

Hashable PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

hashWithSalt :: Int -> PrototypeID -> Int #

hash :: PrototypeID -> Int #

HasPrototypeID PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

prototypeID :: Lens' PrototypeID PrototypeID Source #

unPrototypeID :: Lens' PrototypeID Int Source #

XMLPickleAsAttribute PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

pickleAsAttribute :: Name -> PU [Attribute] PrototypeID Source #

Unbox PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

Vector Vector PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

basicUnsafeFreeze :: Mutable Vector s PrototypeID -> ST s (Vector PrototypeID) #

basicUnsafeThaw :: Vector PrototypeID -> ST s (Mutable Vector s PrototypeID) #

basicLength :: Vector PrototypeID -> Int #

basicUnsafeSlice :: Int -> Int -> Vector PrototypeID -> Vector PrototypeID #

basicUnsafeIndexM :: Vector PrototypeID -> Int -> Box PrototypeID #

basicUnsafeCopy :: Mutable Vector s PrototypeID -> Vector PrototypeID -> ST s () #

elemseq :: Vector PrototypeID -> PrototypeID -> b -> b #

MVector MVector PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

basicLength :: MVector s PrototypeID -> Int #

basicUnsafeSlice :: Int -> Int -> MVector s PrototypeID -> MVector s PrototypeID #

basicOverlaps :: MVector s PrototypeID -> MVector s PrototypeID -> Bool #

basicUnsafeNew :: Int -> ST s (MVector s PrototypeID) #

basicInitialize :: MVector s PrototypeID -> ST s () #

basicUnsafeReplicate :: Int -> PrototypeID -> ST s (MVector s PrototypeID) #

basicUnsafeRead :: MVector s PrototypeID -> Int -> ST s PrototypeID #

basicUnsafeWrite :: MVector s PrototypeID -> Int -> PrototypeID -> ST s () #

basicClear :: MVector s PrototypeID -> ST s () #

basicSet :: MVector s PrototypeID -> PrototypeID -> ST s () #

basicUnsafeCopy :: MVector s PrototypeID -> MVector s PrototypeID -> ST s () #

basicUnsafeMove :: MVector s PrototypeID -> MVector s PrototypeID -> ST s () #

basicUnsafeGrow :: MVector s PrototypeID -> Int -> ST s (MVector s PrototypeID) #

type Rep PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

type Rep PrototypeID = D1 ('MetaData "PrototypeID" "Games.ECS.Prototype" "ohhecs-0.0.1-inplace" 'True) (C1 ('MetaCons "PrototypeID" 'PrefixI 'True) (S1 ('MetaSel ('Just "_unPrototypeID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))
newtype Vector PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

newtype Vector PrototypeID = V_PrototypeID (Vector Int)
newtype MVector s PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

newtype MVector s PrototypeID = MV_PrototypeID (MVector s Int)

class HasPrototypeID c where Source #

Minimal complete definition

prototypeID

Methods

prototypeID :: Lens' c PrototypeID Source #

unPrototypeID :: Lens' c Int Source #

Instances

Instances details
HasPrototypeID IsPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

prototypeID :: Lens' IsPrototype PrototypeID Source #

unPrototypeID :: Lens' IsPrototype Int Source #

HasPrototypeID PrototypeID Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

prototypeID :: Lens' PrototypeID PrototypeID Source #

unPrototypeID :: Lens' PrototypeID Int Source #

data IsPrototype Source #

A component for denoting that an individual is a prototype, to be instantiated later.

Constructors

IsPrototype 

Fields

Instances

Instances details
Generic IsPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

Associated Types

type Rep IsPrototype 
Instance details

Defined in Games.ECS.Prototype

type Rep IsPrototype = D1 ('MetaData "IsPrototype" "Games.ECS.Prototype" "ohhecs-0.0.1-inplace" 'False) (C1 ('MetaCons "IsPrototype" 'PrefixI 'True) (S1 ('MetaSel ('Just "_rawIsPrototypeID") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PrototypeID) :*: S1 ('MetaSel ('Just "_extendsPrototype") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PrototypeID))))

Methods

from :: IsPrototype -> Rep IsPrototype x #

to :: Rep IsPrototype x -> IsPrototype #

Show IsPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

showsPrec :: Int -> IsPrototype -> ShowS #

show :: IsPrototype -> String #

showList :: [IsPrototype] -> ShowS #

Eq IsPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

(==) :: IsPrototype -> IsPrototype -> Bool #

(/=) :: IsPrototype -> IsPrototype -> Bool #

Component IsPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

Associated Types

type CanonicalName IsPrototype 
Instance details

Defined in Games.ECS.Prototype

type CanonicalName IsPrototype = "isPrototype"
type IsFlag IsPrototype 
Instance details

Defined in Games.ECS.Prototype

type IsFlag IsPrototype = 'False
type Storage IsPrototype 
Instance details

Defined in Games.ECS.Prototype

type Storage IsPrototype = ComponentStore
type Prop IsPrototype 
Instance details

Defined in Games.ECS.Prototype

type Prop IsPrototype = 'Normal

Methods

_ComponentFromXML :: String -> Prism' Element IsPrototype Source #

entityKeys :: Fold (Storage IsPrototype IsPrototype) EntitySet Source #

emptyStorage :: Storage IsPrototype IsPrototype Source #

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

defaultValue :: IsPrototype Source #

HasPrototypeID IsPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

prototypeID :: Lens' IsPrototype PrototypeID Source #

unPrototypeID :: Lens' IsPrototype Int Source #

XMLPickler [Node] IsPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

xpickle :: PU [Node] IsPrototype Source #

type Rep IsPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

type Rep IsPrototype = D1 ('MetaData "IsPrototype" "Games.ECS.Prototype" "ohhecs-0.0.1-inplace" 'False) (C1 ('MetaCons "IsPrototype" 'PrefixI 'True) (S1 ('MetaSel ('Just "_rawIsPrototypeID") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PrototypeID) :*: S1 ('MetaSel ('Just "_extendsPrototype") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PrototypeID))))
type CanonicalName IsPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

type CanonicalName IsPrototype = "isPrototype"
type IsFlag IsPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

type IsFlag IsPrototype = 'False
type Prop IsPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

type Prop IsPrototype = 'Normal
type Storage IsPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

type Storage IsPrototype = ComponentStore

extendsPrototype :: Lens' IsPrototype (Maybe PrototypeID) Source #

rawIsPrototypeID :: Lens' IsPrototype PrototypeID Source #

data SpawnedFromPrototype Source #

Marks an entity as being spawned from a prototype.

Constructors

SpawnedFromPrototype 

Fields

Instances

Instances details
Generic SpawnedFromPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

Associated Types

type Rep SpawnedFromPrototype 
Instance details

Defined in Games.ECS.Prototype

type Rep SpawnedFromPrototype = D1 ('MetaData "SpawnedFromPrototype" "Games.ECS.Prototype" "ohhecs-0.0.1-inplace" 'False) (C1 ('MetaCons "SpawnedFromPrototype" 'PrefixI 'True) (S1 ('MetaSel ('Just "_prototypeEntity") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Entity) :*: S1 ('MetaSel ('Just "_spawnedFromPrototypeID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PrototypeID))))

Methods

from :: SpawnedFromPrototype -> Rep SpawnedFromPrototype x #

to :: Rep SpawnedFromPrototype x -> SpawnedFromPrototype #

Show SpawnedFromPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

showsPrec :: Int -> SpawnedFromPrototype -> ShowS #

show :: SpawnedFromPrototype -> String #

showList :: [SpawnedFromPrototype] -> ShowS #

Eq SpawnedFromPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

(==) :: SpawnedFromPrototype -> SpawnedFromPrototype -> Bool #

(/=) :: SpawnedFromPrototype -> SpawnedFromPrototype -> Bool #

Component SpawnedFromPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

Associated Types

type CanonicalName SpawnedFromPrototype 
Instance details

Defined in Games.ECS.Prototype

type CanonicalName SpawnedFromPrototype = "spawnedFromPrototype"
type IsFlag SpawnedFromPrototype 
Instance details

Defined in Games.ECS.Prototype

type IsFlag SpawnedFromPrototype = 'False
type Storage SpawnedFromPrototype 
Instance details

Defined in Games.ECS.Prototype

type Storage SpawnedFromPrototype = ComponentStore
type Prop SpawnedFromPrototype 
Instance details

Defined in Games.ECS.Prototype

type Prop SpawnedFromPrototype = 'Normal

Methods

_ComponentFromXML :: String -> Prism' Element SpawnedFromPrototype Source #

entityKeys :: Fold (Storage SpawnedFromPrototype SpawnedFromPrototype) EntitySet Source #

emptyStorage :: Storage SpawnedFromPrototype SpawnedFromPrototype Source #

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

defaultValue :: SpawnedFromPrototype Source #

XMLPickler [Node] SpawnedFromPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

Methods

xpickle :: PU [Node] SpawnedFromPrototype Source #

type Rep SpawnedFromPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

type Rep SpawnedFromPrototype = D1 ('MetaData "SpawnedFromPrototype" "Games.ECS.Prototype" "ohhecs-0.0.1-inplace" 'False) (C1 ('MetaCons "SpawnedFromPrototype" 'PrefixI 'True) (S1 ('MetaSel ('Just "_prototypeEntity") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Entity) :*: S1 ('MetaSel ('Just "_spawnedFromPrototypeID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PrototypeID))))
type CanonicalName SpawnedFromPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

type CanonicalName SpawnedFromPrototype = "spawnedFromPrototype"
type IsFlag SpawnedFromPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

type IsFlag SpawnedFromPrototype = 'False
type Prop SpawnedFromPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

type Prop SpawnedFromPrototype = 'Normal
type Storage SpawnedFromPrototype Source # 
Instance details

Defined in Games.ECS.Prototype

type Storage SpawnedFromPrototype = ComponentStore

prototypeEntity :: Lens' SpawnedFromPrototype Entity Source #

spawnedFromPrototypeID :: Lens' SpawnedFromPrototype (Maybe PrototypeID) Source #

type UsingIsPrototype (worldType :: Access -> Type) (s :: Access) = (HasIsPrototype worldType, EntityProperty "isPrototype" worldType s (Prop IsPrototype) IsPrototype, OpticsFor "isPrototype" worldType s (Prop IsPrototype) IsPrototype ~ ReifiedIndexedTraversal' Entity (worldType s) IsPrototype) Source #

class (World worldType, Component IsPrototype, EntityProperty "isPrototype" worldType 'Individual (Prop IsPrototype) IsPrototype, OpticsFor "isPrototype" worldType 'Storing (Prop IsPrototype) IsPrototype ~ ReifiedIndexedTraversal' Entity (worldType 'Storing) IsPrototype) => HasIsPrototype (worldType :: Access -> Type) where Source #

Methods

isPrototype :: forall {s :: Access}. (EntityProperty "isPrototype" worldType s (Prop IsPrototype) IsPrototype, OpticsFor "isPrototype" worldType s (Prop IsPrototype) IsPrototype ~ ReifiedIndexedTraversal' Entity (worldType s) IsPrototype) => IndexedTraversal' Entity (worldType s) IsPrototype Source #

addIsPrototype :: IndexedSetter' Entity (worldType 'Individual) IsPrototype Source #

removeIsPrototype :: worldType 'Individual -> worldType 'Individual Source #

withIsPrototype :: Fold (worldType 'Storing) IntersectionOfEntities Source #

type UsingSpawnedFromPrototype (worldType :: Access -> Type) (s :: Access) = (HasSpawnedFromPrototype worldType, EntityProperty "spawnedFromPrototype" worldType s (Prop SpawnedFromPrototype) SpawnedFromPrototype, OpticsFor "spawnedFromPrototype" worldType s (Prop SpawnedFromPrototype) SpawnedFromPrototype ~ ReifiedIndexedTraversal' Entity (worldType s) SpawnedFromPrototype) Source #

class (World worldType, Component SpawnedFromPrototype, EntityProperty "spawnedFromPrototype" worldType 'Individual (Prop SpawnedFromPrototype) SpawnedFromPrototype, OpticsFor "spawnedFromPrototype" worldType 'Storing (Prop SpawnedFromPrototype) SpawnedFromPrototype ~ ReifiedIndexedTraversal' Entity (worldType 'Storing) SpawnedFromPrototype) => HasSpawnedFromPrototype (worldType :: Access -> Type) where Source #

Methods

spawnedFromPrototype :: forall {s :: Access}. (EntityProperty "spawnedFromPrototype" worldType s (Prop SpawnedFromPrototype) SpawnedFromPrototype, OpticsFor "spawnedFromPrototype" worldType s (Prop SpawnedFromPrototype) SpawnedFromPrototype ~ ReifiedIndexedTraversal' Entity (worldType s) SpawnedFromPrototype) => IndexedTraversal' Entity (worldType s) SpawnedFromPrototype Source #

addSpawnedFromPrototype :: IndexedSetter' Entity (worldType 'Individual) SpawnedFromPrototype Source #

removeSpawnedFromPrototype :: worldType 'Individual -> worldType 'Individual Source #

withSpawnedFromPrototype :: Fold (worldType 'Storing) IntersectionOfEntities Source #

spawnPrototype :: (UsingSpawnedFromPrototype w 'Individual, UsingIsPrototype w 'Individual, MonadIO m) => Entity -> w 'Storing -> m (Maybe (w 'Individual, w 'Storing)) Source #

Spawn a new individual with the given prototype Entity reference. Returns the new individual, and the new world.

type PrototypeNameMap = HashMap PrototypeID Entity Source #

A dictionary between a PrototypeID and the characterising Entity.

spawnNamedPrototype :: (UsingSpawnedFromPrototype w 'Individual, UsingIsPrototype w 'Individual, MonadIO m) => PrototypeNameMap -> PrototypeID -> w 'Storing -> m (Maybe (w 'Individual, w 'Storing)) Source #

Spawns a new individual with a given PrototypeID, which is looked up in the associated map. Returns the new individual, and the new world.

prototypes :: forall (w :: Access -> Type). HasIsPrototype w => IndexedTraversal' Entity (w 'Storing) (w 'Individual) Source #

All the prototypical individuals in a world.