Games.ECS.Entity

In an ECS, an entity is understood in two senses:

1. An identifying token, used to specify an individual, and
2. The individual it refers to, that is, the set of components it has.

Here, we implement entities in the first sense.

Documentation

newtype Entity

A reference to an entity in the ECS.

Constructors

EntRef

Fields

• unEntRef :: Int

Instances

Bounded Entity

Defined in Games.ECS.Entity

Methods

minBound :: Entity

maxBound :: Entity

Enum Entity

Defined in Games.ECS.Entity

Methods

succ :: Entity -> Entity

pred :: Entity -> Entity

toEnum :: Int -> Entity

fromEnum :: Entity -> Int

enumFrom :: Entity -> [Entity]

enumFromThen :: Entity -> Entity -> [Entity]

enumFromTo :: Entity -> Entity -> [Entity]

enumFromThenTo :: Entity -> Entity -> Entity -> [Entity]

Generic Entity

Defined in Games.ECS.Entity

Associated Types

type Rep Entity

Defined in Games.ECS.Entity

type Rep Entity = D1 ('MetaData "Entity" "Games.ECS.Entity" "ohhecs-0.0.2-inplace" 'True) (C1 ('MetaCons "EntRef" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEntRef") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

Methods

from :: Entity -> Rep Entity x

to :: Rep Entity x -> Entity

Ix Entity

Defined in Games.ECS.Entity

Methods

range :: (Entity, Entity) -> [Entity]

index :: (Entity, Entity) -> Entity -> Int

unsafeIndex :: (Entity, Entity) -> Entity -> Int

inRange :: (Entity, Entity) -> Entity -> Bool

rangeSize :: (Entity, Entity) -> Int

unsafeRangeSize :: (Entity, Entity) -> Int

Show Entity

Defined in Games.ECS.Entity

Methods

showsPrec :: Int -> Entity -> ShowS

show :: Entity -> String

showList :: [Entity] -> ShowS

Eq Entity

Defined in Games.ECS.Entity

Methods

(==) :: Entity -> Entity -> Bool

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

Ord Entity

Defined in Games.ECS.Entity

Methods

compare :: Entity -> Entity -> Ordering

(<) :: Entity -> Entity -> Bool

(<=) :: Entity -> Entity -> Bool

(>) :: Entity -> Entity -> Bool

(>=) :: Entity -> Entity -> Bool

max :: Entity -> Entity -> Entity

min :: Entity -> Entity -> Entity

Hashable Entity

We reverse the byte order, just so there is a bit more variance between hashes.

Defined in Games.ECS.Entity

Methods

hashWithSalt :: Int -> Entity -> Int

hash :: Entity -> Int

HasEntityReferences Entity

Defined in Games.ECS.Entity

Methods

getEntityReferences :: Fold Entity Entity

XMLPickleAsAttribute Entity

Defined in Games.ECS.Entity

Methods

pickleAsAttribute :: Name -> PU [Attribute] Entity

Unbox Entity

Defined in Games.ECS.Entity

FoldableWithIndex Entity ComponentStore

Defined in Games.ECS.Component.Store

Methods

ifoldMap :: Monoid m => (Entity -> a -> m) -> ComponentStore a -> m

ifoldMap' :: Monoid m => (Entity -> a -> m) -> ComponentStore a -> m

ifoldr :: (Entity -> a -> b -> b) -> b -> ComponentStore a -> b

ifoldl :: (Entity -> b -> a -> b) -> b -> ComponentStore a -> b

ifoldr' :: (Entity -> a -> b -> b) -> b -> ComponentStore a -> b

ifoldl' :: (Entity -> b -> a -> b) -> b -> ComponentStore a -> b

FunctorWithIndex Entity ComponentStore

Defined in Games.ECS.Component.Store

Methods

imap :: (Entity -> a -> b) -> ComponentStore a -> ComponentStore b

TraversableWithIndex Entity ComponentStore

Defined in Games.ECS.Component.Store

Methods

itraverse :: Applicative f => (Entity -> a -> f b) -> ComponentStore a -> f (ComponentStore b)

Vector Vector Entity

Defined in Games.ECS.Entity

Methods

basicUnsafeFreeze :: Mutable Vector s Entity -> ST s (Vector Entity)

basicUnsafeThaw :: Vector Entity -> ST s (Mutable Vector s Entity)

basicLength :: Vector Entity -> Int

basicUnsafeSlice :: Int -> Int -> Vector Entity -> Vector Entity

basicUnsafeIndexM :: Vector Entity -> Int -> Box Entity

basicUnsafeCopy :: Mutable Vector s Entity -> Vector Entity -> ST s ()

elemseq :: Vector Entity -> Entity -> b -> b

MVector MVector Entity

Defined in Games.ECS.Entity

Methods

basicLength :: MVector s Entity -> Int

basicUnsafeSlice :: Int -> Int -> MVector s Entity -> MVector s Entity

basicOverlaps :: MVector s Entity -> MVector s Entity -> Bool

basicUnsafeNew :: Int -> ST s (MVector s Entity)

basicInitialize :: MVector s Entity -> ST s ()

basicUnsafeReplicate :: Int -> Entity -> ST s (MVector s Entity)

basicUnsafeRead :: MVector s Entity -> Int -> ST s Entity

basicUnsafeWrite :: MVector s Entity -> Int -> Entity -> ST s ()

basicClear :: MVector s Entity -> ST s ()

basicSet :: MVector s Entity -> Entity -> ST s ()

basicUnsafeCopy :: MVector s Entity -> MVector s Entity -> ST s ()

basicUnsafeMove :: MVector s Entity -> MVector s Entity -> ST s ()

basicUnsafeGrow :: MVector s Entity -> Int -> ST s (MVector s Entity)

IsEntityStore (HashSet Entity)

Defined in Games.ECS.Entity

Methods

knownEntities :: Fold (HashSet Entity) Entity

blankEntityStorage :: HashSet Entity

XMLPickler [Node] Entity

Defined in Games.ECS.Entity

Methods

xpickle :: PU [Node] Entity

XMLPickler [Node] v => XMLPickler [Node] (HashMap Entity v)

Defined in Games.ECS.Entity

Methods

xpickle :: PU [Node] (HashMap Entity v)

(Constructor c'', ty ~ M1 C c'' (M1 S c (K1 i Entity :: k -> Type))) => GXmlPickler [Node] (M1 C c'' (M1 S c (K1 i Entity :: Type -> Type)))

An instance for constructors which only contain an entity reference; we put that as an attribute.

Defined in Games.ECS.Entity

Methods

gxpicklef :: PU [Node] a -> PU [Node] (M1 C c'' (M1 S c (K1 i Entity :: Type -> Type)) a)

gxpickleContentsf :: PU [Node] a -> PU [Node] (M1 C c'' (M1 S c (K1 i Entity :: Type -> Type)) a)

type Rep Entity

Defined in Games.ECS.Entity

type Rep Entity = D1 ('MetaData "Entity" "Games.ECS.Entity" "ohhecs-0.0.2-inplace" 'True) (C1 ('MetaCons "EntRef" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEntRef") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

newtype Vector Entity

Defined in Games.ECS.Entity

newtype Vector Entity = V_Entity (Vector Int)

newtype MVector s Entity

Defined in Games.ECS.Entity

newtype MVector s Entity = MV_Entity (MVector s Int)

class HasEntityReferences c where

A helper class for finding embedded entity references in components.

Methods

getEntityReferences :: Fold c Entity

Instances

HasEntityReferences Entity

Defined in Games.ECS.Entity

Methods

getEntityReferences :: Fold Entity Entity

HasEntityReferences EntitySet

Defined in Games.ECS.Entity

Methods

getEntityReferences :: Fold EntitySet Entity

newtype EntitySet

An efficient storage for a collection of entities.

Constructors

EntitySet IntSet

Instances

Monoid EntitySet

Defined in Games.ECS.Entity

Methods

mempty :: EntitySet

mappend :: EntitySet -> EntitySet -> EntitySet

mconcat :: [EntitySet] -> EntitySet

Semigroup EntitySet

Defined in Games.ECS.Entity

Methods

(<>) :: EntitySet -> EntitySet -> EntitySet

sconcat :: NonEmpty EntitySet -> EntitySet

stimes :: Integral b => b -> EntitySet -> EntitySet

Show EntitySet

Defined in Games.ECS.Entity

Methods

showsPrec :: Int -> EntitySet -> ShowS

show :: EntitySet -> String

showList :: [EntitySet] -> ShowS

Eq EntitySet

Defined in Games.ECS.Entity

Methods

(==) :: EntitySet -> EntitySet -> Bool

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

HasEntityReferences EntitySet

Defined in Games.ECS.Entity

Methods

getEntityReferences :: Fold EntitySet Entity

HasEntitySet EntitySet

Defined in Games.ECS.Entity

Methods

entitySet :: Fold EntitySet EntitySet

IsEntityStore EntitySet

Defined in Games.ECS.Entity

Methods

knownEntities :: Fold EntitySet Entity

blankEntityStorage :: EntitySet

theEntitySet :: Iso' EntitySet IntSet

Access the underlying IntSet.

singletonEntitySet :: Entity -> EntitySet

Construct a new EntitySet with a given Entity.

asIntersection :: Iso' IntersectionOfEntities EntitySet

Helper Iso' for selecting entities which satisfy predicates.

newtype IntersectionOfEntities

A helper Monoid for selecting entities which satisfy multiple predicates.

Constructors

Intersect IntSet

Instances

Monoid IntersectionOfEntities

Defined in Games.ECS.Entity

Methods

mempty :: IntersectionOfEntities

mappend :: IntersectionOfEntities -> IntersectionOfEntities -> IntersectionOfEntities

mconcat :: [IntersectionOfEntities] -> IntersectionOfEntities

Semigroup IntersectionOfEntities

Defined in Games.ECS.Entity

Methods

(<>) :: IntersectionOfEntities -> IntersectionOfEntities -> IntersectionOfEntities

sconcat :: NonEmpty IntersectionOfEntities -> IntersectionOfEntities

stimes :: Integral b => b -> IntersectionOfEntities -> IntersectionOfEntities

Show IntersectionOfEntities

Defined in Games.ECS.Entity

Methods

showsPrec :: Int -> IntersectionOfEntities -> ShowS

show :: IntersectionOfEntities -> String

showList :: [IntersectionOfEntities] -> ShowS

Eq IntersectionOfEntities

Defined in Games.ECS.Entity

Methods

(==) :: IntersectionOfEntities -> IntersectionOfEntities -> Bool

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

HasEntitySet IntersectionOfEntities

Defined in Games.ECS.Entity

Methods

entitySet :: Fold IntersectionOfEntities EntitySet

IsEntityStore IntersectionOfEntities

Defined in Games.ECS.Entity

Methods

knownEntities :: Fold IntersectionOfEntities Entity

blankEntityStorage :: IntersectionOfEntities

class IsEntityStore a where

Generalisation of an EntitySet.

Methods

knownEntities :: Fold a Entity

Fold over each Entity it holds.

blankEntityStorage :: a

Empty storage.

Instances

IsEntityStore IntSet

Defined in Games.ECS.Entity

Methods

knownEntities :: Fold IntSet Entity

blankEntityStorage :: IntSet

IsEntityStore EntitySet

Defined in Games.ECS.Entity

Methods

knownEntities :: Fold EntitySet Entity

blankEntityStorage :: EntitySet

IsEntityStore IntersectionOfEntities

Defined in Games.ECS.Entity

Methods

knownEntities :: Fold IntersectionOfEntities Entity

blankEntityStorage :: IntersectionOfEntities

IsEntityStore (HashSet Entity)

Defined in Games.ECS.Entity

Methods

knownEntities :: Fold (HashSet Entity) Entity

blankEntityStorage :: HashSet Entity

class HasEntitySet a where

For types which may have one or more EntitySet.

Methods

entitySet :: Fold a EntitySet

Instances

HasEntitySet EntitySet

Defined in Games.ECS.Entity

Methods

entitySet :: Fold EntitySet EntitySet

HasEntitySet IntersectionOfEntities

Defined in Games.ECS.Entity

Methods

entitySet :: Fold IntersectionOfEntities EntitySet

HasEntitySet (UniqueStore a)

Defined in Games.ECS.Component

Methods

entitySet :: Fold (UniqueStore a) EntitySet

HasEntitySet (ComponentStore c)

Defined in Games.ECS.Component.Store

Methods

entitySet :: Fold (ComponentStore c) EntitySet

HasEntitySet (InternedComponentStore c)

Defined in Games.ECS.Component.Store

Methods

entitySet :: Fold (InternedComponentStore c) EntitySet