mischief-ecs

Safe Haskell	None
Language	GHC2024

Mischief.ECS.Components.Spawn

Synopsis

getOrAddPairId :: Pair -> System ComponentId
getOrAddComponentId :: ComponentType -> System ComponentId
meta :: Component c => System Entity
tryMeta :: forall c m w. (Component c, MonadSystem w m) => m (Maybe Entity)
registerHooks :: Component c => Entity -> System ()
getHook :: forall {k} (c :: k). Hook c -> HookContext -> System ()
getHookRel :: forall {k} (c :: k). HookRel c -> HookContextRel -> System ()
newtype ComponentAddHooks = ComponentAddHooks [HookContext -> System ()]
newtype ComponentSetHooks = ComponentSetHooks [HookContext -> System ()]
newtype ComponentRemoveHooks = ComponentRemoveHooks [HookContext -> System ()]
newtype ComponentAddHooksRel = ComponentAddHooksRel [HookContextRel -> System ()]
newtype ComponentSetHooksRel = ComponentSetHooksRel [HookContextRel -> System ()]
newtype ComponentRemoveHooksRel = ComponentRemoveHooksRel [HookContextRel -> System ()]

Documentation

getOrAddPairId :: Pair -> System ComponentId Source #

Get the id of a component - entity pair. In case the component isn't registered, it will give it a new id.

getOrAddComponentId :: ComponentType -> System ComponentId Source #

Get the id of a component. In case the component isn't registered, it will give it a new id.

meta :: Component c => System Entity Source #

tryMeta :: forall c m w. (Component c, MonadSystem w m) => m (Maybe Entity) Source #

registerHooks :: Component c => Entity -> System () Source #

getHook :: forall {k} (c :: k). Hook c -> HookContext -> System () Source #

getHookRel :: forall {k} (c :: k). HookRel c -> HookContextRel -> System () Source #

newtype ComponentAddHooks Source #

Constructors

ComponentAddHooks [HookContext -> System ()]

Instances

Instances details

Component ComponentAddHooks Source #

Instance details

Defined in Mischief.ECS.Components.Spawn

Associated Types

type IsExclusiveRel ComponentAddHooks
Instance details Defined in Mischief.ECS.Components.Spawn type IsExclusiveRel ComponentAddHooks = 'False

Methods

required :: Set DefaultComponentType Source #

onAdd :: [Hook ComponentAddHooks] Source #

onSet :: [Hook ComponentAddHooks] Source #

onRemove :: [Hook ComponentAddHooks] Source #

onAddRel :: [HookRel ComponentAddHooks] Source #

onSetRel :: [HookRel ComponentAddHooks] Source #

onRemoveRel :: [HookRel ComponentAddHooks] Source #

type IsExclusiveRel ComponentAddHooks Source #

Instance details

Defined in Mischief.ECS.Components.Spawn

type IsExclusiveRel ComponentAddHooks = 'False

newtype ComponentSetHooks Source #

Constructors

ComponentSetHooks [HookContext -> System ()]

Instances

Instances details

Component ComponentSetHooks Source #

Instance details

Defined in Mischief.ECS.Components.Spawn

Associated Types

type IsExclusiveRel ComponentSetHooks
Instance details Defined in Mischief.ECS.Components.Spawn type IsExclusiveRel ComponentSetHooks = 'False

Methods

required :: Set DefaultComponentType Source #

onAdd :: [Hook ComponentSetHooks] Source #

onSet :: [Hook ComponentSetHooks] Source #

onRemove :: [Hook ComponentSetHooks] Source #

onAddRel :: [HookRel ComponentSetHooks] Source #

onSetRel :: [HookRel ComponentSetHooks] Source #

onRemoveRel :: [HookRel ComponentSetHooks] Source #

type IsExclusiveRel ComponentSetHooks Source #

Instance details

Defined in Mischief.ECS.Components.Spawn

type IsExclusiveRel ComponentSetHooks = 'False

newtype ComponentRemoveHooks Source #

Constructors

ComponentRemoveHooks [HookContext -> System ()]

Instances

Instances details

Component ComponentRemoveHooks Source #

Instance details

Defined in Mischief.ECS.Components.Spawn

Associated Types

type IsExclusiveRel ComponentRemoveHooks
Instance details Defined in Mischief.ECS.Components.Spawn type IsExclusiveRel ComponentRemoveHooks = 'False

Methods

required :: Set DefaultComponentType Source #

onAdd :: [Hook ComponentRemoveHooks] Source #

onSet :: [Hook ComponentRemoveHooks] Source #

onRemove :: [Hook ComponentRemoveHooks] Source #

onAddRel :: [HookRel ComponentRemoveHooks] Source #

onSetRel :: [HookRel ComponentRemoveHooks] Source #

onRemoveRel :: [HookRel ComponentRemoveHooks] Source #

type IsExclusiveRel ComponentRemoveHooks Source #

Instance details

Defined in Mischief.ECS.Components.Spawn

type IsExclusiveRel ComponentRemoveHooks = 'False

newtype ComponentAddHooksRel Source #

Constructors

ComponentAddHooksRel [HookContextRel -> System ()]

Instances

Instances details

Component ComponentAddHooksRel Source #

Instance details

Defined in Mischief.ECS.Components.Spawn

Associated Types

type IsExclusiveRel ComponentAddHooksRel
Instance details Defined in Mischief.ECS.Components.Spawn type IsExclusiveRel ComponentAddHooksRel = 'False

Methods

required :: Set DefaultComponentType Source #

onAdd :: [Hook ComponentAddHooksRel] Source #

onSet :: [Hook ComponentAddHooksRel] Source #

onRemove :: [Hook ComponentAddHooksRel] Source #

onAddRel :: [HookRel ComponentAddHooksRel] Source #

onSetRel :: [HookRel ComponentAddHooksRel] Source #

onRemoveRel :: [HookRel ComponentAddHooksRel] Source #

type IsExclusiveRel ComponentAddHooksRel Source #

Instance details

Defined in Mischief.ECS.Components.Spawn

type IsExclusiveRel ComponentAddHooksRel = 'False

newtype ComponentSetHooksRel Source #

Constructors

ComponentSetHooksRel [HookContextRel -> System ()]

Instances

Instances details

Component ComponentSetHooksRel Source #

Instance details

Defined in Mischief.ECS.Components.Spawn

Associated Types

type IsExclusiveRel ComponentSetHooksRel
Instance details Defined in Mischief.ECS.Components.Spawn type IsExclusiveRel ComponentSetHooksRel = 'False

Methods

required :: Set DefaultComponentType Source #

onAdd :: [Hook ComponentSetHooksRel] Source #

onSet :: [Hook ComponentSetHooksRel] Source #

onRemove :: [Hook ComponentSetHooksRel] Source #

onAddRel :: [HookRel ComponentSetHooksRel] Source #

onSetRel :: [HookRel ComponentSetHooksRel] Source #

onRemoveRel :: [HookRel ComponentSetHooksRel] Source #

type IsExclusiveRel ComponentSetHooksRel Source #

Instance details

Defined in Mischief.ECS.Components.Spawn

type IsExclusiveRel ComponentSetHooksRel = 'False

newtype ComponentRemoveHooksRel Source #

Constructors

ComponentRemoveHooksRel [HookContextRel -> System ()]

Instances

Instances details

Component ComponentRemoveHooksRel Source #

Instance details

Defined in Mischief.ECS.Components.Spawn

Associated Types

type IsExclusiveRel ComponentRemoveHooksRel
Instance details Defined in Mischief.ECS.Components.Spawn type IsExclusiveRel ComponentRemoveHooksRel = 'False

Methods

required :: Set DefaultComponentType Source #

onAdd :: [Hook ComponentRemoveHooksRel] Source #

onSet :: [Hook ComponentRemoveHooksRel] Source #

onRemove :: [Hook ComponentRemoveHooksRel] Source #

onAddRel :: [HookRel ComponentRemoveHooksRel] Source #

onSetRel :: [HookRel ComponentRemoveHooksRel] Source #

onRemoveRel :: [HookRel ComponentRemoveHooksRel] Source #

type IsExclusiveRel ComponentRemoveHooksRel Source #

Instance details

Defined in Mischief.ECS.Components.Spawn

type IsExclusiveRel ComponentRemoveHooksRel = 'False