Games.ECS.Prototype.SpawnedFromPrototype

A component to mark an entity as being spawned from a prototype.

Documentation

data SpawnedFromPrototype

Marks an entity as being spawned from a prototype.

Constructors

SpawnedFromPrototype

Fields

• _prototypeEntity :: !Entity

  The raw `Entity ` which it is spawned from.

• _spawnedFromPrototypeID :: Maybe PrototypeID

  The PrototypeID it is spawned from.

Instances

Generic SpawnedFromPrototype

Defined in Games.ECS.Prototype.SpawnedFromPrototype

Associated Types

type Rep SpawnedFromPrototype

Defined in Games.ECS.Prototype.SpawnedFromPrototype

type Rep SpawnedFromPrototype = D1 ('MetaData "SpawnedFromPrototype" "Games.ECS.Prototype.SpawnedFromPrototype" "ohhecs-0.0.2-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

Defined in Games.ECS.Prototype.SpawnedFromPrototype

Methods

showsPrec :: Int -> SpawnedFromPrototype -> ShowS

show :: SpawnedFromPrototype -> String

showList :: [SpawnedFromPrototype] -> ShowS

Eq SpawnedFromPrototype

Defined in Games.ECS.Prototype.SpawnedFromPrototype

Methods

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

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

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

XMLPickler [Node] SpawnedFromPrototype

Defined in Games.ECS.Prototype.SpawnedFromPrototype

Methods

xpickle :: PU [Node] SpawnedFromPrototype

type Rep SpawnedFromPrototype

Defined in Games.ECS.Prototype.SpawnedFromPrototype

type Rep SpawnedFromPrototype = D1 ('MetaData "SpawnedFromPrototype" "Games.ECS.Prototype.SpawnedFromPrototype" "ohhecs-0.0.2-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

Defined in Games.ECS.Prototype.SpawnedFromPrototype

type CanonicalName SpawnedFromPrototype = "spawnedFromPrototype"

type IsFlag SpawnedFromPrototype

Defined in Games.ECS.Prototype.SpawnedFromPrototype

type IsFlag SpawnedFromPrototype = 'False

type Prop SpawnedFromPrototype

Defined in Games.ECS.Prototype.SpawnedFromPrototype

type Prop SpawnedFromPrototype = 'Normal

type Storage SpawnedFromPrototype

Defined in Games.ECS.Prototype.SpawnedFromPrototype

type Storage SpawnedFromPrototype = ComponentStore

prototypeEntity :: Lens' SpawnedFromPrototype Entity

spawnedFromPrototypeID :: Lens' SpawnedFromPrototype (Maybe PrototypeID)

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)

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

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

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

removeSpawnedFromPrototype :: worldType 'Individual -> worldType 'Individual

withSpawnedFromPrototype :: Fold (worldType 'Storing) IntersectionOfEntities

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

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

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

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)

All the prototypical individuals in a world.