aztecs-0.16.0: A modular game engine and Entity-Component-System (ECS) for Haskell.

Copyright	(c) Matt Hunzinger 2025
License	BSD-style (see the LICENSE file in the distribution)
Maintainer	matt@hunzinger.me
Stability	provisional
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Aztecs.ECS.Component

Description

Synopsis

newtype ComponentID = ComponentID {
- unComponentId :: Int
}
class (Monad m, Typeable a, Storage a (StorageT a)) => Component (m :: Type -> Type) a where
- type StorageT a
- componentOnInsert :: EntityID -> a -> Access m ()
- componentOnChange :: EntityID -> a -> Access m ()
- componentOnRemove :: EntityID -> a -> Access m ()

Documentation

newtype ComponentID Source #

Unique component identifier.

Constructors

ComponentID
Fields unComponentId :: Int Unique integer identifier.

Instances

Instances details

Generic ComponentID Source #

Instance details

Defined in Aztecs.ECS.Component.Internal

Associated Types

type Rep ComponentID
Instance details Defined in Aztecs.ECS.Component.Internal type Rep ComponentID = D1 ('MetaData "ComponentID" "Aztecs.ECS.Component.Internal" "aztecs-0.16.0-1t3LRuVnzUqKpg58E4sSVq" 'True) (C1 ('MetaCons "ComponentID" 'PrefixI 'True) (S1 ('MetaSel ('Just "unComponentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

Methods

from :: ComponentID -> Rep ComponentID x #

to :: Rep ComponentID x -> ComponentID #

Show ComponentID Source #

Instance details

Defined in Aztecs.ECS.Component.Internal

Methods

showsPrec :: Int -> ComponentID -> ShowS #

show :: ComponentID -> String #

showList :: [ComponentID] -> ShowS #

Eq ComponentID Source #

Instance details

Defined in Aztecs.ECS.Component.Internal

Methods

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

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

Ord ComponentID Source #

Instance details

Defined in Aztecs.ECS.Component.Internal

Methods

compare :: ComponentID -> ComponentID -> Ordering #

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

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

(>) :: ComponentID -> ComponentID -> Bool #

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

max :: ComponentID -> ComponentID -> ComponentID #

min :: ComponentID -> ComponentID -> ComponentID #

type Rep ComponentID Source #

Instance details

Defined in Aztecs.ECS.Component.Internal

type Rep ComponentID = D1 ('MetaData "ComponentID" "Aztecs.ECS.Component.Internal" "aztecs-0.16.0-1t3LRuVnzUqKpg58E4sSVq" 'True) (C1 ('MetaCons "ComponentID" 'PrefixI 'True) (S1 ('MetaSel ('Just "unComponentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

class (Monad m, Typeable a, Storage a (StorageT a)) => Component (m :: Type -> Type) a where Source #

Component that can be stored in the World.

Minimal complete definition

Nothing

Associated Types

type StorageT a Source #

Storage of this component.

type StorageT a = Vector a

Methods

componentOnInsert :: EntityID -> a -> Access m () Source #

Lifecycle hook called when a component is inserted.

componentOnChange :: EntityID -> a -> Access m () Source #

Lifecycle hook called when a component is changed.

componentOnRemove :: EntityID -> a -> Access m () Source #

Lifecycle hook called when a component is removed.

Instances

Instances details

Monad m => Component m ChildState Source #

Instance details

Defined in Aztecs.Hierarchy

Associated Types

type StorageT ChildState
Instance details Defined in Aztecs.Hierarchy type StorageT ChildState = Vector ChildState

Methods

componentOnInsert :: EntityID -> ChildState -> Access m () Source #

componentOnChange :: EntityID -> ChildState -> Access m () Source #

componentOnRemove :: EntityID -> ChildState -> Access m () Source #

Monad m => Component m Children Source #

Instance details

Defined in Aztecs.Hierarchy

Associated Types

type StorageT Children
Instance details Defined in Aztecs.Hierarchy type StorageT Children = Vector Children

Methods

componentOnInsert :: EntityID -> Children -> Access m () Source #

componentOnChange :: EntityID -> Children -> Access m () Source #

componentOnRemove :: EntityID -> Children -> Access m () Source #

Monad m => Component m Parent Source #

Instance details

Defined in Aztecs.Hierarchy

Associated Types

type StorageT Parent
Instance details Defined in Aztecs.Hierarchy type StorageT Parent = Vector Parent

Methods

componentOnInsert :: EntityID -> Parent -> Access m () Source #

componentOnChange :: EntityID -> Parent -> Access m () Source #

componentOnRemove :: EntityID -> Parent -> Access m () Source #

Monad m => Component m ParentState Source #

Instance details

Defined in Aztecs.Hierarchy

Associated Types

type StorageT ParentState
Instance details Defined in Aztecs.Hierarchy type StorageT ParentState = Vector ParentState

Methods

componentOnInsert :: EntityID -> ParentState -> Access m () Source #

componentOnChange :: EntityID -> ParentState -> Access m () Source #

componentOnRemove :: EntityID -> ParentState -> Access m () Source #

(Monad m, Typeable m, Event e) => Component m (Observer m e) Source #

Instance details

Defined in Aztecs.ECS.Observer

Associated Types

type StorageT (Observer m e)
Instance details Defined in Aztecs.ECS.Observer type StorageT (Observer m e) = Vector (Observer m e)

Methods

componentOnInsert :: EntityID -> Observer m e -> Access m () Source #

componentOnChange :: EntityID -> Observer m e -> Access m () Source #

componentOnRemove :: EntityID -> Observer m e -> Access m () Source #