Documentation

List of components required by this one. All required components must be Default

Example

data A = A
instance Component A where
  required = require @(B, C)

data B = B Int deriving (Component, Generic, Default)

data C = C String deriving (Component)
instance Default C where
  def = C "Default String"

onAdd :: [Hook c] Source #

onSet :: [Hook c] Source #

onRemove :: [Hook c] Source #

onAddRel :: [HookRel c] Source #

onSetRel :: [HookRel c] Source #

onRemoveRel :: [HookRel c] Source #

Instances

Instances details

Component ScheduleLabel Source #

Instance details

Associated Types

type IsExclusiveRel ScheduleLabel
Instance details Defined in Mischief.ECS.App.Schedules type IsExclusiveRel ScheduleLabel = 'False

Methods

onAdd :: [Hook ScheduleLabel] Source #

onSet :: [Hook ScheduleLabel] Source #

onRemove :: [Hook ScheduleLabel] Source #

onAddRel :: [HookRel ScheduleLabel] Source #

onSetRel :: [HookRel ScheduleLabel] Source #

onRemoveRel :: [HookRel ScheduleLabel] Source #

Component Schedules Source #

Instance details

Associated Types

type IsExclusiveRel Schedules
Instance details Defined in Mischief.ECS.App.Schedules type IsExclusiveRel Schedules = 'False

Methods

onAdd :: [Hook Schedules] Source #

onSet :: [Hook Schedules] Source #

onRemove :: [Hook Schedules] Source #

onAddRel :: [HookRel Schedules] Source #

onSetRel :: [HookRel Schedules] Source #

onRemoveRel :: [HookRel Schedules] Source #

Component StartupSchedule Source #

Instance details

Associated Types

type IsExclusiveRel StartupSchedule
Instance details Defined in Mischief.ECS.App.Schedules type IsExclusiveRel StartupSchedule = 'False

Methods

onAdd :: [Hook StartupSchedule] Source #

onSet :: [Hook StartupSchedule] Source #

onRemove :: [Hook StartupSchedule] Source #

onAddRel :: [HookRel StartupSchedule] Source #

onSetRel :: [HookRel StartupSchedule] Source #

onRemoveRel :: [HookRel StartupSchedule] Source #

Component UpdateSchedule Source #

Instance details

Associated Types

type IsExclusiveRel UpdateSchedule
Instance details Defined in Mischief.ECS.App.Schedules type IsExclusiveRel UpdateSchedule = 'False

Methods

onAdd :: [Hook UpdateSchedule] Source #

onSet :: [Hook UpdateSchedule] Source #

onRemove :: [Hook UpdateSchedule] Source #

onAddRel :: [HookRel UpdateSchedule] Source #

onSetRel :: [HookRel UpdateSchedule] Source #

onRemoveRel :: [HookRel UpdateSchedule] Source #

Component LastSystemTick Source #

Instance details

Defined in Mischief.ECS.App.SystemDef

Associated Types

type IsExclusiveRel LastSystemTick
Instance details Defined in Mischief.ECS.App.SystemDef type IsExclusiveRel LastSystemTick = 'False

Methods

onAdd :: [Hook LastSystemTick] Source #

onSet :: [Hook LastSystemTick] Source #

onRemove :: [Hook LastSystemTick] Source #

onAddRel :: [HookRel LastSystemTick] Source #

onSetRel :: [HookRel LastSystemTick] Source #

onRemoveRel :: [HookRel LastSystemTick] Source #

Component SystemTick Source #

Instance details

Defined in Mischief.ECS.App.SystemDef

Associated Types

type IsExclusiveRel SystemTick
Instance details Defined in Mischief.ECS.App.SystemDef type IsExclusiveRel SystemTick = 'False

Methods

onAdd :: [Hook SystemTick] Source #

onSet :: [Hook SystemTick] Source #

onRemove :: [Hook SystemTick] Source #

onAddRel :: [HookRel SystemTick] Source #

onSetRel :: [HookRel SystemTick] Source #

onRemoveRel :: [HookRel SystemTick] Source #

Component ScheduledIn Source #

Instance details

Defined in Mischief.ECS.App.Systems

Associated Types

type IsExclusiveRel ScheduledIn
Instance details Defined in Mischief.ECS.App.Systems type IsExclusiveRel ScheduledIn = 'False

Methods

onAdd :: [Hook ScheduledIn] Source #

onSet :: [Hook ScheduledIn] Source #

onRemove :: [Hook ScheduledIn] Source #

onAddRel :: [HookRel ScheduledIn] Source #

onSetRel :: [HookRel ScheduledIn] Source #

onRemoveRel :: [HookRel ScheduledIn] Source #

Component SystemFunction Source #

Instance details

Defined in Mischief.ECS.App.Systems

Associated Types

type IsExclusiveRel SystemFunction
Instance details Defined in Mischief.ECS.App.Systems type IsExclusiveRel SystemFunction = 'False

Methods

onAdd :: [Hook SystemFunction] Source #

onSet :: [Hook SystemFunction] Source #

onRemove :: [Hook SystemFunction] Source #

onAddRel :: [HookRel SystemFunction] Source #

onSetRel :: [HookRel SystemFunction] Source #

onRemoveRel :: [HookRel SystemFunction] Source #

Component Systems Source #

Instance details

Defined in Mischief.ECS.App.Systems

Associated Types

type IsExclusiveRel Systems
Instance details Defined in Mischief.ECS.App.Systems type IsExclusiveRel Systems = 'False

Methods

onAdd :: [Hook Systems] Source #

onSet :: [Hook Systems] Source #

onRemove :: [Hook Systems] Source #

onAddRel :: [HookRel Systems] Source #

onSetRel :: [HookRel Systems] Source #

onRemoveRel :: [HookRel Systems] Source #

Component ComponentArchetypes Source #

Instance details

Defined in Mischief.ECS.Components

Associated Types

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

Methods

onAdd :: [Hook ComponentArchetypes] Source #

onSet :: [Hook ComponentArchetypes] Source #

onRemove :: [Hook ComponentArchetypes] Source #

onAddRel :: [HookRel ComponentArchetypes] Source #

onSetRel :: [HookRel ComponentArchetypes] Source #

onRemoveRel :: [HookRel ComponentArchetypes] Source #

Component ComponentPairs Source #

Instance details

Defined in Mischief.ECS.Components

Associated Types

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

Methods

onAdd :: [Hook ComponentPairs] Source #

onSet :: [Hook ComponentPairs] Source #

onRemove :: [Hook ComponentPairs] Source #

onAddRel :: [HookRel ComponentPairs] Source #

onSetRel :: [HookRel ComponentPairs] Source #

onRemoveRel :: [HookRel ComponentPairs] Source #

Component ComponentType Source #

Instance details

Defined in Mischief.ECS.Components

Associated Types

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

Methods

onAdd :: [Hook ComponentType] Source #

onSet :: [Hook ComponentType] Source #

onRemove :: [Hook ComponentType] Source #

onAddRel :: [HookRel ComponentType] Source #

onSetRel :: [HookRel ComponentType] Source #

onRemoveRel :: [HookRel ComponentType] Source #

Component DefaultValue Source #

Instance details

Defined in Mischief.ECS.Components

Associated Types

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

Methods

Component IsExclusiveRelationship Source #

onAdd :: [Hook DefaultValue] Source #

onSet :: [Hook DefaultValue] Source #

onRemove :: [Hook DefaultValue] Source #

onAddRel :: [HookRel DefaultValue] Source #

onSetRel :: [HookRel DefaultValue] Source #

onRemoveRel :: [HookRel DefaultValue] Source #

Instance details

Defined in Mischief.ECS.Components

Associated Types

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

Methods

onAdd :: [Hook IsExclusiveRelationship] Source #

onSet :: [Hook IsExclusiveRelationship] Source #

onRemove :: [Hook IsExclusiveRelationship] Source #

onAddRel :: [HookRel IsExclusiveRelationship] Source #

onSetRel :: [HookRel IsExclusiveRelationship] Source #

onRemoveRel :: [HookRel IsExclusiveRelationship] Source #

Component RequiredBy Source #

Instance details

Defined in Mischief.ECS.Components

Associated Types

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

Methods

onAdd :: [Hook RequiredBy] Source #

onSet :: [Hook RequiredBy] Source #

onRemove :: [Hook RequiredBy] Source #

onAddRel :: [HookRel RequiredBy] Source #

onSetRel :: [HookRel RequiredBy] Source #

onRemoveRel :: [HookRel RequiredBy] Source #

Component Requires Source #

Instance details

Defined in Mischief.ECS.Components

Associated Types

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

Methods

onAdd :: [Hook Requires] Source #

onSet :: [Hook Requires] Source #

onRemove :: [Hook Requires] Source #

onAddRel :: [HookRel Requires] Source #

onSetRel :: [HookRel Requires] Source #

onRemoveRel :: [HookRel Requires] Source #

Component Name Source #

Instance details

Defined in Mischief.ECS.Components.Common

Associated Types

type IsExclusiveRel Name
Instance details Defined in Mischief.ECS.Components.Common type IsExclusiveRel Name = 'False

Methods

onAdd :: [Hook Name] Source #

onSet :: [Hook Name] Source #

onRemove :: [Hook Name] Source #

onAddRel :: [HookRel Name] Source #

onSetRel :: [HookRel Name] Source #

onRemoveRel :: [HookRel Name] Source #

Component ComponentAddHooks Source #

Instance details

Associated Types

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

Methods

Component ComponentAddHooksRel 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 #

Instance details

Associated Types

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

Methods

Component ComponentRemoveHooks 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 #

Instance details

Associated Types

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

Methods

Component ComponentRemoveHooksRel 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 #

Instance details

Associated Types

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

Methods

onAdd :: [Hook ComponentRemoveHooksRel] Source #

onSet :: [Hook ComponentRemoveHooksRel] Source #

onRemove :: [Hook ComponentRemoveHooksRel] Source #

onAddRel :: [HookRel ComponentRemoveHooksRel] Source #

onSetRel :: [HookRel ComponentRemoveHooksRel] Source #

onRemoveRel :: [HookRel ComponentRemoveHooksRel] Source #

Component ComponentSetHooks Source #

Instance details

Associated Types

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

Methods

Component ComponentSetHooksRel 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 #

Instance details

Associated Types

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

Methods

onAdd :: [Hook ComponentSetHooksRel] Source #

onSet :: [Hook ComponentSetHooksRel] Source #

onRemove :: [Hook ComponentSetHooksRel] Source #

onAddRel :: [HookRel ComponentSetHooksRel] Source #

onSetRel :: [HookRel ComponentSetHooksRel] Source #

onRemoveRel :: [HookRel ComponentSetHooksRel] Source #

Component ObserverOrder Source #

Instance details

Defined in Mischief.ECS.Observer

Associated Types

type IsExclusiveRel ObserverOrder
Instance details Defined in Mischief.ECS.Observer type IsExclusiveRel ObserverOrder = 'False

Methods

onAdd :: [Hook ObserverOrder] Source #

onSet :: [Hook ObserverOrder] Source #

onRemove :: [Hook ObserverOrder] Source #

onAddRel :: [HookRel ObserverOrder] Source #

onSetRel :: [HookRel ObserverOrder] Source #

onRemoveRel :: [HookRel ObserverOrder] Source #

Component ChildOf Source #

Instance details

Defined in Mischief.ECS.Relationships.ChildOf

Associated Types

type IsExclusiveRel ChildOf
Instance details Defined in Mischief.ECS.Relationships.ChildOf type IsExclusiveRel ChildOf = 'True

Methods

onAdd :: [Hook ChildOf] Source #

onSet :: [Hook ChildOf] Source #

onRemove :: [Hook ChildOf] Source #

onAddRel :: [HookRel ChildOf] Source #

onSetRel :: [HookRel ChildOf] Source #

onRemoveRel :: [HookRel ChildOf] Source #

Component Before Source #

Instance details

Defined in Mischief.ECS.Relationships.Order

Associated Types

type IsExclusiveRel Before
Instance details Defined in Mischief.ECS.Relationships.Order type IsExclusiveRel Before = 'False

Methods

onAdd :: [Hook Before] Source #

onSet :: [Hook Before] Source #

onRemove :: [Hook Before] Source #

onAddRel :: [HookRel Before] Source #

onSetRel :: [HookRel Before] Source #

onRemoveRel :: [HookRel Before] Source #

Component Visited Source #

Instance details

Defined in Mischief.ECS.Relationships.Order

Associated Types

type IsExclusiveRel Visited
Instance details Defined in Mischief.ECS.Relationships.Order type IsExclusiveRel Visited = 'False

Methods

onAdd :: [Hook Visited] Source #

onSet :: [Hook Visited] Source #

onRemove :: [Hook Visited] Source #

onAddRel :: [HookRel Visited] Source #

onSetRel :: [HookRel Visited] Source #

onRemoveRel :: [HookRel Visited] Source #

Component VirtualTime Source #

Instance details

Defined in Mischief.ECS.Time

Associated Types

type IsExclusiveRel VirtualTime
Instance details Defined in Mischief.ECS.Time type IsExclusiveRel VirtualTime = 'False

Methods

onAdd :: [Hook VirtualTime] Source #

onSet :: [Hook VirtualTime] Source #

onRemove :: [Hook VirtualTime] Source #

onAddRel :: [HookRel VirtualTime] Source #

onSetRel :: [HookRel VirtualTime] Source #

onRemoveRel :: [HookRel VirtualTime] Source #

Typeable e => Component (Observer e) Source #

Instance details

Defined in Mischief.ECS.Observer

Associated Types

type IsExclusiveRel (Observer e)
Instance details Defined in Mischief.ECS.Observer type IsExclusiveRel (Observer e) = 'False

Methods

onAdd :: [Hook (Observer e)] Source #

onSet :: [Hook (Observer e)] Source #

onRemove :: [Hook (Observer e)] Source #

onAddRel :: [HookRel (Observer e)] Source #

onSetRel :: [HookRel (Observer e)] Source #

onRemoveRel :: [HookRel (Observer e)] Source #

(Typeable e, Typeable k) => Component (EventProxy e) Source #

Instance details

Defined in Mischief.ECS.Observer

Associated Types

type IsExclusiveRel (EventProxy e)
Instance details Defined in Mischief.ECS.Observer type IsExclusiveRel (EventProxy e) = 'False

Methods

onAdd :: [Hook (EventProxy e)] Source #

onSet :: [Hook (EventProxy e)] Source #

onRemove :: [Hook (EventProxy e)] Source #

onAddRel :: [HookRel (EventProxy e)] Source #

onSetRel :: [HookRel (EventProxy e)] Source #

onRemoveRel :: [HookRel (EventProxy e)] Source #

(Typeable a, Typeable b, Typeable k1, Typeable k2) => Component (TestG a b) Source #

Instance details

Defined in Mischief.ECS.World.Query.TH.QD

Associated Types

type IsExclusiveRel (TestG a b)
Instance details Defined in Mischief.ECS.World.Query.TH.QD type IsExclusiveRel (TestG a b) = 'False

Methods

onAdd :: [Hook (TestG a b)] Source #

onSet :: [Hook (TestG a b)] Source #

onRemove :: [Hook (TestG a b)] Source #

onAddRel :: [HookRel (TestG a b)] Source #

onSetRel :: [HookRel (TestG a b)] Source #

onRemoveRel :: [HookRel (TestG a b)] Source #

data From c Source #

Constructors

From
Fields entity :: Entity comp :: c

Instances

Instances details

Functor From Source #
Instance details Defined in Mischief.ECS.Components Methods fmap :: (a -> b) -> From a -> From b # (<$) :: a -> From b -> From a #
(Component c, Queryable q out) => RelQuery 'False (MR c (Q q)) (Maybe [From out]) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c (Q q) -> World -> Entity -> IO (Maybe (Maybe [From out])) Source # relRunQueryInternal :: MR c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe [From out])] Source # relQueryTypes :: MR c (Q q) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'False (MR c (Q' q (QueryFilter 'ArchetypeFilter))) (Maybe [From out]) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe (Maybe [From out])) Source # relRunQueryInternal :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe [From out])] Source # relQueryTypes :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'False (R c (Q q)) [From out] Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c (Q q) -> World -> Entity -> IO (Maybe [From out]) Source # relRunQueryInternal :: R c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, [From out])] Source # relQueryTypes :: R c (Q q) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'False (R c (Q' q (QueryFilter 'ArchetypeFilter))) [From out] Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe [From out]) Source # relRunQueryInternal :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, [From out])] Source # relQueryTypes :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'True (MR c (Q q)) (Maybe (From out)) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c (Q q) -> World -> Entity -> IO (Maybe (Maybe (From out))) Source # relRunQueryInternal :: MR c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe (From out))] Source # relQueryTypes :: MR c (Q q) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'True (MR c (Q' q (QueryFilter 'ArchetypeFilter))) (Maybe (From out)) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe (Maybe (From out))) Source # relRunQueryInternal :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe (From out))] Source # relQueryTypes :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'True (R c (Q q)) (From out) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c (Q q) -> World -> Entity -> IO (Maybe (From out)) Source # relRunQueryInternal :: R c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, From out)] Source # relQueryTypes :: R c (Q q) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'True (R c (Q' q (QueryFilter 'ArchetypeFilter))) (From out) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe (From out)) Source # relRunQueryInternal :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, From out)] Source # relQueryTypes :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
Show c => Show (From c) Source #
Instance details Defined in Mischief.ECS.Components Methods showsPrec :: Int -> From c -> ShowS # show :: From c -> String # showList :: [From c] -> ShowS #
Eq c => Eq (From c) Source #
Instance details Defined in Mischief.ECS.Components Methods (==) :: From c -> From c -> Bool # (/=) :: From c -> From c -> Bool #
Collectable c (BundleData ErasedComponent) => EraseIntoStorage (From c) (BundleData ErasedComponent) Source #
Instance details Defined in Mischief.ECS.Components Methods erase :: From c -> BundleData ErasedComponent Source #
Collectable c (BundleData ErasedComponentEq) => EraseIntoStorage (From c) (BundleData ErasedComponentEq) Source #
Instance details Defined in Mischief.ECS.Components Methods erase :: From c -> BundleData ErasedComponentEq Source #

type family IsExclusiveRel c :: Bool Source #

Instances

Instances details

type IsExclusiveRel ScheduleLabel Source #
Instance details Defined in Mischief.ECS.App.Schedules type IsExclusiveRel ScheduleLabel = 'False
type IsExclusiveRel Schedules Source #
Instance details Defined in Mischief.ECS.App.Schedules type IsExclusiveRel Schedules = 'False
type IsExclusiveRel StartupSchedule Source #
Instance details Defined in Mischief.ECS.App.Schedules type IsExclusiveRel StartupSchedule = 'False
type IsExclusiveRel UpdateSchedule Source #
Instance details Defined in Mischief.ECS.App.Schedules type IsExclusiveRel UpdateSchedule = 'False
type IsExclusiveRel LastSystemTick Source #
Instance details Defined in Mischief.ECS.App.SystemDef type IsExclusiveRel LastSystemTick = 'False
type IsExclusiveRel SystemTick Source #
Instance details Defined in Mischief.ECS.App.SystemDef type IsExclusiveRel SystemTick = 'False
type IsExclusiveRel ScheduledIn Source #
Instance details Defined in Mischief.ECS.App.Systems type IsExclusiveRel ScheduledIn = 'False
type IsExclusiveRel SystemFunction Source #
Instance details Defined in Mischief.ECS.App.Systems type IsExclusiveRel SystemFunction = 'False
type IsExclusiveRel Systems Source #
Instance details Defined in Mischief.ECS.App.Systems type IsExclusiveRel Systems = 'False
type IsExclusiveRel ComponentArchetypes Source #
Instance details Defined in Mischief.ECS.Components type IsExclusiveRel ComponentArchetypes = 'False
type IsExclusiveRel ComponentPairs Source #
Instance details Defined in Mischief.ECS.Components type IsExclusiveRel ComponentPairs = 'False
type IsExclusiveRel ComponentType Source #
Instance details Defined in Mischief.ECS.Components type IsExclusiveRel ComponentType = 'False
type IsExclusiveRel DefaultValue Source #
Instance details Defined in Mischief.ECS.Components type IsExclusiveRel DefaultValue = 'False
type IsExclusiveRel IsExclusiveRelationship Source #
Instance details Defined in Mischief.ECS.Components type IsExclusiveRel IsExclusiveRelationship = 'False
type IsExclusiveRel RequiredBy Source #
Instance details Defined in Mischief.ECS.Components type IsExclusiveRel RequiredBy = 'False
type IsExclusiveRel Requires Source #
Instance details Defined in Mischief.ECS.Components type IsExclusiveRel Requires = 'False
type IsExclusiveRel Name Source #
Instance details Defined in Mischief.ECS.Components.Common type IsExclusiveRel Name = 'False
type IsExclusiveRel ComponentAddHooks Source #
Instance details Defined in Mischief.ECS.Components.Spawn type IsExclusiveRel ComponentAddHooks = 'False
type IsExclusiveRel ComponentAddHooksRel Source #
Instance details Defined in Mischief.ECS.Components.Spawn type IsExclusiveRel ComponentAddHooksRel = 'False
type IsExclusiveRel ComponentRemoveHooks Source #
Instance details Defined in Mischief.ECS.Components.Spawn type IsExclusiveRel ComponentRemoveHooks = 'False
type IsExclusiveRel ComponentRemoveHooksRel Source #
Instance details Defined in Mischief.ECS.Components.Spawn type IsExclusiveRel ComponentRemoveHooksRel = 'False
type IsExclusiveRel ComponentSetHooks Source #
Instance details Defined in Mischief.ECS.Components.Spawn type IsExclusiveRel ComponentSetHooks = 'False
type IsExclusiveRel ComponentSetHooksRel Source #
Instance details Defined in Mischief.ECS.Components.Spawn type IsExclusiveRel ComponentSetHooksRel = 'False
type IsExclusiveRel ObserverOrder Source #
Instance details Defined in Mischief.ECS.Observer type IsExclusiveRel ObserverOrder = 'False
type IsExclusiveRel ChildOf Source #
Instance details Defined in Mischief.ECS.Relationships.ChildOf type IsExclusiveRel ChildOf = 'True
type IsExclusiveRel Before Source #
Instance details Defined in Mischief.ECS.Relationships.Order type IsExclusiveRel Before = 'False
type IsExclusiveRel Visited Source #
Instance details Defined in Mischief.ECS.Relationships.Order type IsExclusiveRel Visited = 'False
type IsExclusiveRel VirtualTime Source #
Instance details Defined in Mischief.ECS.Time type IsExclusiveRel VirtualTime = 'False
type IsExclusiveRel (Observer e) Source #
Instance details Defined in Mischief.ECS.Observer type IsExclusiveRel (Observer e) = 'False
type IsExclusiveRel (EventProxy e) Source #
Instance details Defined in Mischief.ECS.Observer type IsExclusiveRel (EventProxy e) = 'False
type IsExclusiveRel (TestG a b) Source #
Instance details Defined in Mischief.ECS.World.Query.TH.QD type IsExclusiveRel (TestG a b) = 'False

data Rel c Source #

Type used for querying and inserting relationships.

Constructors

Rel
Fields comp :: c target :: Entity

Instances

Instances details

Functor Rel Source #
Instance details Defined in Mischief.ECS.Components Methods fmap :: (a -> b) -> Rel a -> Rel b # (<$) :: a -> Rel b -> Rel a #
Component c => RelQuery 'False (MR c Any) (Maybe [Rel c]) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c Any -> World -> Entity -> IO (Maybe (Maybe [Rel c])) Source # relRunQueryInternal :: MR c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe [Rel c])] Source # relQueryTypes :: MR c Any -> Set (TypeRep, TypeQuery) Source #
Component c => RelQuery 'False (R c Any) [Rel c] Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c Any -> World -> Entity -> IO (Maybe [Rel c]) Source # relRunQueryInternal :: R c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, [Rel c])] Source # relQueryTypes :: R c Any -> Set (TypeRep, TypeQuery) Source #
Component c => RelQuery 'True (MR c Any) (Maybe (Rel c)) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c Any -> World -> Entity -> IO (Maybe (Maybe (Rel c))) Source # relRunQueryInternal :: MR c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe (Rel c))] Source # relQueryTypes :: MR c Any -> Set (TypeRep, TypeQuery) Source #
Component c => RelQuery 'True (R c Any) (Rel c) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c Any -> World -> Entity -> IO (Maybe (Rel c)) Source # relRunQueryInternal :: R c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, Rel c)] Source # relQueryTypes :: R c Any -> Set (TypeRep, TypeQuery) Source #
Show c => Show (Rel c) Source #
Instance details Defined in Mischief.ECS.Components Methods showsPrec :: Int -> Rel c -> ShowS # show :: Rel c -> String # showList :: [Rel c] -> ShowS #
Eq c => Eq (Rel c) Source #
Instance details Defined in Mischief.ECS.Components Methods (==) :: Rel c -> Rel c -> Bool # (/=) :: Rel c -> Rel c -> Bool #
Component c => EraseIntoStorage (Rel c) (BundleData ErasedComponent) Source #
Instance details Defined in Mischief.ECS.Components Methods erase :: Rel c -> BundleData ErasedComponent Source #
(Component c, Eq c) => EraseIntoStorage (Rel c) (BundleData ErasedComponentEq) Source #
Instance details Defined in Mischief.ECS.Components Methods erase :: Rel c -> BundleData ErasedComponentEq Source #
Component c => Queryable (MR c Entity) (Maybe (Rel c)) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: MR c Entity -> World -> Entity -> IO (Maybe (Maybe (Rel c))) Source # runQueryInternal :: MR c Entity -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe (Rel c))] Source # queryTypes :: MR c Entity -> Set (TypeRep, TypeQuery) Source #
Component c => Queryable (R c Entity) (Rel c) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: R c Entity -> World -> Entity -> IO (Maybe (Rel c)) Source # runQueryInternal :: R c Entity -> [ArchetypeId] -> World -> IO [(Entity, Bool, Rel c)] Source # queryTypes :: R c Entity -> Set (TypeRep, TypeQuery) Source #

newtype Res c Source #

Constructors

Res
Fields comp :: c

Instances

Instances details

Functor Res Source #
Instance details Defined in Mischief.ECS.Components Methods fmap :: (a -> b) -> Res a -> Res b # (<$) :: a -> Res b -> Res a #
Show c => Show (Res c) Source #
Instance details Defined in Mischief.ECS.Components Methods showsPrec :: Int -> Res c -> ShowS # show :: Res c -> String # showList :: [Res c] -> ShowS #
Eq c => Eq (Res c) Source #
Instance details Defined in Mischief.ECS.Components Methods (==) :: Res c -> Res c -> Bool # (/=) :: Res c -> Res c -> Bool #
Component c => EraseIntoStorage (Res c) (BundleData ErasedComponent) Source #
Instance details Defined in Mischief.ECS.Components Methods erase :: Res c -> BundleData ErasedComponent Source #
(Component c, Eq c) => EraseIntoStorage (Res c) (BundleData ErasedComponentEq) Source #
Instance details Defined in Mischief.ECS.Components Methods erase :: Res c -> BundleData ErasedComponentEq Source #
Component c => Queryable (MRes c) (Maybe (Res c)) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: MRes c -> World -> Entity -> IO (Maybe (Maybe (Res c))) Source # runQueryInternal :: MRes c -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe (Res c))] Source # queryTypes :: MRes c -> Set (TypeRep, TypeQuery) Source #
Component c => Queryable (c -> Res c) (Res c) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: (c -> Res c) -> World -> Entity -> IO (Maybe (Res c)) Source # runQueryInternal :: (c -> Res c) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Res c)] Source # queryTypes :: (c -> Res c) -> Set (TypeRep, TypeQuery) Source #

require :: forall {k} (b :: k). RequiredBundle b => Set DefaultComponentType Source #

module Mischief.ECS.Components.Common

data Entity Source #

UNLIFTED

Points to an unique entity. The first Word# is an id, the second is a generation.

It is guaranteed that there can't be two alive entities with the same id.

Instances

Instances details

Show Entity Source #
Instance details Defined in Mischief.ECS.EntityDef Methods showsPrec :: Int -> Entity -> ShowS # show :: Entity -> String # showList :: [Entity] -> ShowS #
Eq Entity Source #
Instance details Defined in Mischief.ECS.EntityDef Methods (==) :: Entity -> Entity -> Bool # (/=) :: Entity -> Entity -> Bool #
Ord Entity Source #
Instance details Defined in Mischief.ECS.EntityDef 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 #
Queryable E Entity Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: E -> World -> Entity -> IO (Maybe Entity) Source # runQueryInternal :: E -> [ArchetypeId] -> World -> IO [(Entity, Bool, Entity)] Source # queryTypes :: E -> Set (TypeRep, TypeQuery) Source #
ListToOutgoing (Maybe Entity) Source #
Instance details Defined in Mischief.ECS.Relationships.Graph Methods listToOutgoing :: [Entity] -> Maybe Entity Source #
ListToOutgoing [Entity] Source #
Instance details Defined in Mischief.ECS.Relationships.Graph Methods listToOutgoing :: [Entity] -> [Entity] Source #
Component c => ToFilterComponent (R c Entity) Source #
Instance details Defined in Mischief.ECS.World.Query.QueryFilter Methods toFilterComponent :: R c Entity -> FilterComponent Source #
Component c => Queryable (HasR c Entity) Bool Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: HasR c Entity -> World -> Entity -> IO (Maybe Bool) Source # runQueryInternal :: HasR c Entity -> [ArchetypeId] -> World -> IO [(Entity, Bool, Bool)] Source # queryTypes :: HasR c Entity -> Set (TypeRep, TypeQuery) Source #
Component c => Queryable (MR c Entity) (Maybe (Rel c)) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: MR c Entity -> World -> Entity -> IO (Maybe (Maybe (Rel c))) Source # runQueryInternal :: MR c Entity -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe (Rel c))] Source # queryTypes :: MR c Entity -> Set (TypeRep, TypeQuery) Source #
Component c => Queryable (R c Entity) (Rel c) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: R c Entity -> World -> Entity -> IO (Maybe (Rel c)) Source # runQueryInternal :: R c Entity -> [ArchetypeId] -> World -> IO [(Entity, Bool, Rel c)] Source # queryTypes :: R c Entity -> Set (TypeRep, TypeQuery) Source #

mkGet :: forall qd out (m :: Type -> Type). Queryable qd out => Entity -> qd -> Query m out Source #

mkGet' :: forall qd out (m :: Type -> Type). Queryable qd out => Entity -> qd -> QueryFilter 'ArchetypeFilter -> Query m out Source #

mkQuery :: forall qd out (m :: Type -> Type). Queryable qd out => qd -> Query m out Source #

mkQuery' :: forall qd out (m :: Type -> Type). Queryable qd out => qd -> QueryFilter 'ArchetypeFilter -> Query m out Source #

query :: MonadSystem w m => Query m out -> m [out] Source #

query_ :: MonadSystem w m => Query m out -> m () Source #

single :: MonadSystem w m => Query m out -> m (Maybe out) Source #

data Query (m :: Type -> Type) a Source #

Instances

Instances details

MonadSystem w m => Applicative (Query m) Source #
Instance details Defined in Mischief.ECS.World.Query Methods pure :: a -> Query m a # (<>) :: Query m (a -> b) -> Query m a -> Query m b # liftA2 :: (a -> b -> c) -> Query m a -> Query m b -> Query m c # (>) :: Query m a -> Query m b -> Query m b # (<*) :: Query m a -> Query m b -> Query m a #
MonadSystem w m => Functor (Query m) Source #
Instance details Defined in Mischief.ECS.World.Query Methods fmap :: (a -> b) -> Query m a -> Query m b # (<$) :: a -> Query m b -> Query m a #
MonadSystem w m => Monad (Query m) Source #
Instance details Defined in Mischief.ECS.World.Query Methods (>>=) :: Query m a -> (a -> Query m b) -> Query m b # (>>) :: Query m a -> Query m b -> Query m b # return :: a -> Query m a #

data QueryFilter (f :: FilterType) where Source #

Constructors

NoFilter :: forall (f :: FilterType). QueryFilter f
With :: forall a (f :: FilterType). ToFilterComponent a => a -> QueryFilter f
Without :: forall a (f :: FilterType). ToFilterComponent a => a -> QueryFilter f
Changed :: forall a. ToFilterComponent a => a -> QueryFilter 'EntityFilter
Added :: forall a. ToFilterComponent a => a -> QueryFilter 'EntityFilter
Not :: forall (f :: FilterType). QueryFilter f -> QueryFilter f
And :: forall (f :: FilterType). QueryFilter f -> QueryFilter f -> QueryFilter f
Or :: forall (f :: FilterType). QueryFilter f -> QueryFilter f -> QueryFilter f

Instances

Instances details

(Component c, Queryable q out) => RelQuery 'False (MR c (Q' q (QueryFilter 'ArchetypeFilter))) (Maybe [From out]) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe (Maybe [From out])) Source # relRunQueryInternal :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe [From out])] Source # relQueryTypes :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'False (R c (Q' q (QueryFilter 'ArchetypeFilter))) [From out] Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe [From out]) Source # relRunQueryInternal :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, [From out])] Source # relQueryTypes :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'True (MR c (Q' q (QueryFilter 'ArchetypeFilter))) (Maybe (From out)) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe (Maybe (From out))) Source # relRunQueryInternal :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe (From out))] Source # relQueryTypes :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'True (R c (Q' q (QueryFilter 'ArchetypeFilter))) (From out) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe (From out)) Source # relRunQueryInternal :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, From out)] Source # relQueryTypes :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
Semigroup (QueryFilter f) Source #
Instance details Defined in Mischief.ECS.World.Query.QueryFilter Methods (<>) :: QueryFilter f -> QueryFilter f -> QueryFilter f # sconcat :: NonEmpty (QueryFilter f) -> QueryFilter f # stimes :: Integral b => b -> QueryFilter f -> QueryFilter f #
(Component c, Queryable q out) => Queryable (HasR c (Q' q (QueryFilter 'ArchetypeFilter))) Bool Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: HasR c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe Bool) Source # runQueryInternal :: HasR c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Bool)] Source # queryTypes :: HasR c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #

data Any Source #

Wildcard used when querying for relationships to indicate that you're querying for relationships with any target.

In the case of exclusive relationships, Any returns a single relationship rather than a list of relationships.

Constructors

Any

Instances

Instances details

Component c => RelQuery 'False (MR c Any) (Maybe [Rel c]) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c Any -> World -> Entity -> IO (Maybe (Maybe [Rel c])) Source # relRunQueryInternal :: MR c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe [Rel c])] Source # relQueryTypes :: MR c Any -> Set (TypeRep, TypeQuery) Source #
Component c => RelQuery 'False (R c Any) [Rel c] Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c Any -> World -> Entity -> IO (Maybe [Rel c]) Source # relRunQueryInternal :: R c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, [Rel c])] Source # relQueryTypes :: R c Any -> Set (TypeRep, TypeQuery) Source #
Component c => RelQuery 'True (MR c Any) (Maybe (Rel c)) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c Any -> World -> Entity -> IO (Maybe (Maybe (Rel c))) Source # relRunQueryInternal :: MR c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe (Rel c))] Source # relQueryTypes :: MR c Any -> Set (TypeRep, TypeQuery) Source #
Component c => RelQuery 'True (R c Any) (Rel c) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c Any -> World -> Entity -> IO (Maybe (Rel c)) Source # relRunQueryInternal :: R c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, Rel c)] Source # relQueryTypes :: R c Any -> Set (TypeRep, TypeQuery) Source #
Component c => ToFilterComponent (R c Any) Source #
Instance details Defined in Mischief.ECS.World.Query.QueryFilter Methods toFilterComponent :: R c Any -> FilterComponent Source #
Component c => Queryable (HasR c Any) Bool Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: HasR c Any -> World -> Entity -> IO (Maybe Bool) Source # runQueryInternal :: HasR c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, Bool)] Source # queryTypes :: HasR c Any -> Set (TypeRep, TypeQuery) Source #
RelQuery (IsExclusiveRel c) (MR c Any) out => Queryable (MR c Any) out Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: MR c Any -> World -> Entity -> IO (Maybe out) Source # runQueryInternal :: MR c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, out)] Source # queryTypes :: MR c Any -> Set (TypeRep, TypeQuery) Source #
RelQuery (IsExclusiveRel c) (R c Any) out => Queryable (R c Any) out Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: R c Any -> World -> Entity -> IO (Maybe out) Source # runQueryInternal :: R c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, out)] Source # queryTypes :: R c Any -> Set (TypeRep, TypeQuery) Source #

data C (a :: k) Source #

Used to query for a component or to remove a component. Forces queries to only include entities which have the component.

Example

Querying:

x <- query (C @Name)

Removing:

remove (C @Name)

Quasi Notation

None, you just write the component name directly. For instance:

x <- [q|Name|]

Constructors

C

Instances

Instances details

Component c => ToFilterComponent (C c) Source #
Instance details Defined in Mischief.ECS.World.Query.QueryFilter Methods toFilterComponent :: C c -> FilterComponent Source #
Component c => Queryable (C c) c Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: C c -> World -> Entity -> IO (Maybe c) Source # runQueryInternal :: C c -> [ArchetypeId] -> World -> IO [(Entity, Bool, c)] Source # queryTypes :: C c -> Set (TypeRep, TypeQuery) Source #

data E Source #

Used to query for the Entity.

Example

x <- query E

Quasi Notation

```
Entity
```
```
entity
```
```
E
```
```
e
```

For instance:

x <- [q|Entity|]

Constructors

E

Instances

Instances details

Queryable E Entity Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: E -> World -> Entity -> IO (Maybe Entity) Source # runQueryInternal :: E -> [ArchetypeId] -> World -> IO [(Entity, Bool, Entity)] Source # queryTypes :: E -> Set (TypeRep, TypeQuery) Source #

data Has (a :: k) Source #

Used in queries to return a Bool which indicates whether a component exists on the entity or not.

Example

x <- query (Has @Name)

Quasi Notation

```
Has
```
```
has
```
```
H
```
```
h
```

For instance:

x <- [q|Has Name|]

Constructors

Has

Instances

Instances details

Component c => Queryable (Has c) Bool Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: Has c -> World -> Entity -> IO (Maybe Bool) Source # runQueryInternal :: Has c -> [ArchetypeId] -> World -> IO [(Entity, Bool, Bool)] Source # queryTypes :: Has c -> Set (TypeRep, TypeQuery) Source #

newtype HasR (a :: k) b Source #

Exactly like R, except that it returns a Bool depending on whether the entity has such a relationship or not.

Example

x <- query (HasR @Likes Any)

Quasi Notation

```
Has
```
```
has
```
```
H
```
```
h
```

For instance:

x <- [q|Has Likes -> *|]

Constructors

HasR b

Instances

Instances details

Component c => Queryable (HasR c Entity) Bool Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: HasR c Entity -> World -> Entity -> IO (Maybe Bool) Source # runQueryInternal :: HasR c Entity -> [ArchetypeId] -> World -> IO [(Entity, Bool, Bool)] Source # queryTypes :: HasR c Entity -> Set (TypeRep, TypeQuery) Source #
Component c => Queryable (HasR c Any) Bool Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: HasR c Any -> World -> Entity -> IO (Maybe Bool) Source # runQueryInternal :: HasR c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, Bool)] Source # queryTypes :: HasR c Any -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => Queryable (HasR c (Q q)) Bool Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: HasR c (Q q) -> World -> Entity -> IO (Maybe Bool) Source # runQueryInternal :: HasR c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Bool)] Source # queryTypes :: HasR c (Q q) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => Queryable (HasR c (Q' q (QueryFilter 'ArchetypeFilter))) Bool Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: HasR c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe Bool) Source # runQueryInternal :: HasR c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Bool)] Source # queryTypes :: HasR c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #

data M (a :: k) Source #

Used to query for a component that an entity may or may not have.

Example

x <- query (M @Name)

Quasi Notation

```
Maybe
```
```
maybe
```
```
M
```
```
m
```

For instance:

x <- [q|Maybe Name|]

Constructors

M

Instances

Instances details

Component c => Queryable (M c) (Maybe c) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: M c -> World -> Entity -> IO (Maybe (Maybe c)) Source # runQueryInternal :: M c -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe c)] Source # queryTypes :: M c -> Set (TypeRep, TypeQuery) Source #

newtype MR (a :: k) b Source #

Exactly like R, except that it wraps the result in a Maybe, also including entities that don't have such a relationship.

Example

x <- query (MR @Likes Any)

Quasi Notation

```
Maybe
```
```
maybe
```
```
M
```
```
m
```

For instance:

x <- [q|Maybe Likes -> *|]

Constructors

MR b

Instances

Instances details

Component c => RelQuery 'False (MR c Any) (Maybe [Rel c]) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c Any -> World -> Entity -> IO (Maybe (Maybe [Rel c])) Source # relRunQueryInternal :: MR c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe [Rel c])] Source # relQueryTypes :: MR c Any -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'False (MR c (Q q)) (Maybe [From out]) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c (Q q) -> World -> Entity -> IO (Maybe (Maybe [From out])) Source # relRunQueryInternal :: MR c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe [From out])] Source # relQueryTypes :: MR c (Q q) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'False (MR c (Q' q (QueryFilter 'ArchetypeFilter))) (Maybe [From out]) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe (Maybe [From out])) Source # relRunQueryInternal :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe [From out])] Source # relQueryTypes :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
Component c => RelQuery 'True (MR c Any) (Maybe (Rel c)) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c Any -> World -> Entity -> IO (Maybe (Maybe (Rel c))) Source # relRunQueryInternal :: MR c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe (Rel c))] Source # relQueryTypes :: MR c Any -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'True (MR c (Q q)) (Maybe (From out)) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c (Q q) -> World -> Entity -> IO (Maybe (Maybe (From out))) Source # relRunQueryInternal :: MR c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe (From out))] Source # relQueryTypes :: MR c (Q q) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'True (MR c (Q' q (QueryFilter 'ArchetypeFilter))) (Maybe (From out)) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe (Maybe (From out))) Source # relRunQueryInternal :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe (From out))] Source # relQueryTypes :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
RelQuery (IsExclusiveRel c) (MR c Any) out => Queryable (MR c Any) out Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: MR c Any -> World -> Entity -> IO (Maybe out) Source # runQueryInternal :: MR c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, out)] Source # queryTypes :: MR c Any -> Set (TypeRep, TypeQuery) Source #
RelQuery (IsExclusiveRel c) (MR c (Q q)) out => Queryable (MR c (Q q)) out Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: MR c (Q q) -> World -> Entity -> IO (Maybe out) Source # runQueryInternal :: MR c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, out)] Source # queryTypes :: MR c (Q q) -> Set (TypeRep, TypeQuery) Source #
RelQuery (IsExclusiveRel c) (MR c (Q' q f)) out => Queryable (MR c (Q' q f)) out Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: MR c (Q' q f) -> World -> Entity -> IO (Maybe out) Source # runQueryInternal :: MR c (Q' q f) -> [ArchetypeId] -> World -> IO [(Entity, Bool, out)] Source # queryTypes :: MR c (Q' q f) -> Set (TypeRep, TypeQuery) Source #
Component c => Queryable (MR c Entity) (Maybe (Rel c)) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: MR c Entity -> World -> Entity -> IO (Maybe (Maybe (Rel c))) Source # runQueryInternal :: MR c Entity -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe (Rel c))] Source # queryTypes :: MR c Entity -> Set (TypeRep, TypeQuery) Source #

newtype Q a Source #

Used when writing transitive queries. See R.

Constructors

Q a

Instances

Instances details

(Component c, Queryable q out) => RelQuery 'False (MR c (Q q)) (Maybe [From out]) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c (Q q) -> World -> Entity -> IO (Maybe (Maybe [From out])) Source # relRunQueryInternal :: MR c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe [From out])] Source # relQueryTypes :: MR c (Q q) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'False (R c (Q q)) [From out] Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c (Q q) -> World -> Entity -> IO (Maybe [From out]) Source # relRunQueryInternal :: R c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, [From out])] Source # relQueryTypes :: R c (Q q) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'True (MR c (Q q)) (Maybe (From out)) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c (Q q) -> World -> Entity -> IO (Maybe (Maybe (From out))) Source # relRunQueryInternal :: MR c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe (From out))] Source # relQueryTypes :: MR c (Q q) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'True (R c (Q q)) (From out) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c (Q q) -> World -> Entity -> IO (Maybe (From out)) Source # relRunQueryInternal :: R c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, From out)] Source # relQueryTypes :: R c (Q q) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => Queryable (HasR c (Q q)) Bool Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: HasR c (Q q) -> World -> Entity -> IO (Maybe Bool) Source # runQueryInternal :: HasR c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Bool)] Source # queryTypes :: HasR c (Q q) -> Set (TypeRep, TypeQuery) Source #
RelQuery (IsExclusiveRel c) (MR c (Q q)) out => Queryable (MR c (Q q)) out Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: MR c (Q q) -> World -> Entity -> IO (Maybe out) Source # runQueryInternal :: MR c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, out)] Source # queryTypes :: MR c (Q q) -> Set (TypeRep, TypeQuery) Source #
RelQuery (IsExclusiveRel c) (R c (Q q)) out => Queryable (R c (Q q)) out Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: R c (Q q) -> World -> Entity -> IO (Maybe out) Source # runQueryInternal :: R c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, out)] Source # queryTypes :: R c (Q q) -> Set (TypeRep, TypeQuery) Source #

data Q' a b Source #

Used when writing transitive queries with filters. See R.

Constructors

Q' a b

Instances

Instances details

(Component c, Queryable q out) => RelQuery 'False (MR c (Q' q (QueryFilter 'ArchetypeFilter))) (Maybe [From out]) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe (Maybe [From out])) Source # relRunQueryInternal :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe [From out])] Source # relQueryTypes :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'False (R c (Q' q (QueryFilter 'ArchetypeFilter))) [From out] Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe [From out]) Source # relRunQueryInternal :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, [From out])] Source # relQueryTypes :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'True (MR c (Q' q (QueryFilter 'ArchetypeFilter))) (Maybe (From out)) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe (Maybe (From out))) Source # relRunQueryInternal :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe (From out))] Source # relQueryTypes :: MR c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'True (R c (Q' q (QueryFilter 'ArchetypeFilter))) (From out) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe (From out)) Source # relRunQueryInternal :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, From out)] Source # relQueryTypes :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => Queryable (HasR c (Q' q (QueryFilter 'ArchetypeFilter))) Bool Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: HasR c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe Bool) Source # runQueryInternal :: HasR c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, Bool)] Source # queryTypes :: HasR c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
RelQuery (IsExclusiveRel c) (MR c (Q' q f)) out => Queryable (MR c (Q' q f)) out Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: MR c (Q' q f) -> World -> Entity -> IO (Maybe out) Source # runQueryInternal :: MR c (Q' q f) -> [ArchetypeId] -> World -> IO [(Entity, Bool, out)] Source # queryTypes :: MR c (Q' q f) -> Set (TypeRep, TypeQuery) Source #
RelQuery (IsExclusiveRel c) (R c (Q' q f)) out => Queryable (R c (Q' q f)) out Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: R c (Q' q f) -> World -> Entity -> IO (Maybe out) Source # runQueryInternal :: R c (Q' q f) -> [ArchetypeId] -> World -> IO [(Entity, Bool, out)] Source # queryTypes :: R c (Q' q f) -> Set (TypeRep, TypeQuery) Source #

newtype R (a :: k) b Source #

Used to query for a relationships. Can be used in three different ways:

1. R c e

Queries for a relationship with a specific target. Forces queries to only include entities which have such a relationship.

Example

x <- query (R @Likes alice)

x :: [Result (Rel Likes)]

Quasi Notation

It is written with an arrow like so:

x <- [q|Likes -> alice|]

2. R c Any

Queries for all relationships with any target. Forces queries to only include entities which have at least one such relationship.

Example

x <- query (R @Likes Any)

x :: [[Result (Rel Likes)]]

Quasi Notation

x <- [q|Likes -> *|]

3. R c q

Runs a transitive query on the targets of all such relationships. q can either be Q d or Q' d f, depending if you want to also run a filter or not.

Similar to the previous case, it will limit the query to only entities which have such a relationship with at least one entity which matches the transitive query.

Example

x <- query (R @Likes (Q (C @Name))

x <- query (R @Likes (Q' (C @Name) (With (C @Enemy))))

x :: [[Result Name]]

Quasi Notation

You just write the given query in the () following the arrow. / can be used to give it a filter.

For instance:

x <- [q|Likes -> (Name)|]

x <- [q|Likes -> (Name / With Enemy)|]

Constructors

R b

Instances

Instances details

Component c => RelQuery 'False (R c Any) [Rel c] Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c Any -> World -> Entity -> IO (Maybe [Rel c]) Source # relRunQueryInternal :: R c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, [Rel c])] Source # relQueryTypes :: R c Any -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'False (R c (Q q)) [From out] Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c (Q q) -> World -> Entity -> IO (Maybe [From out]) Source # relRunQueryInternal :: R c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, [From out])] Source # relQueryTypes :: R c (Q q) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'False (R c (Q' q (QueryFilter 'ArchetypeFilter))) [From out] Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe [From out]) Source # relRunQueryInternal :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, [From out])] Source # relQueryTypes :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
Component c => RelQuery 'True (R c Any) (Rel c) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c Any -> World -> Entity -> IO (Maybe (Rel c)) Source # relRunQueryInternal :: R c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, Rel c)] Source # relQueryTypes :: R c Any -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'True (R c (Q q)) (From out) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c (Q q) -> World -> Entity -> IO (Maybe (From out)) Source # relRunQueryInternal :: R c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, From out)] Source # relQueryTypes :: R c (Q q) -> Set (TypeRep, TypeQuery) Source #
(Component c, Queryable q out) => RelQuery 'True (R c (Q' q (QueryFilter 'ArchetypeFilter))) (From out) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods relRunQueryEntity :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> World -> Entity -> IO (Maybe (From out)) Source # relRunQueryInternal :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> [ArchetypeId] -> World -> IO [(Entity, Bool, From out)] Source # relQueryTypes :: R c (Q' q (QueryFilter 'ArchetypeFilter)) -> Set (TypeRep, TypeQuery) Source #
Component c => ToFilterComponent (R c Entity) Source #
Instance details Defined in Mischief.ECS.World.Query.QueryFilter Methods toFilterComponent :: R c Entity -> FilterComponent Source #
Component c => ToFilterComponent (R c Any) Source #
Instance details Defined in Mischief.ECS.World.Query.QueryFilter Methods toFilterComponent :: R c Any -> FilterComponent Source #
RelQuery (IsExclusiveRel c) (R c Any) out => Queryable (R c Any) out Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: R c Any -> World -> Entity -> IO (Maybe out) Source # runQueryInternal :: R c Any -> [ArchetypeId] -> World -> IO [(Entity, Bool, out)] Source # queryTypes :: R c Any -> Set (TypeRep, TypeQuery) Source #
RelQuery (IsExclusiveRel c) (R c (Q q)) out => Queryable (R c (Q q)) out Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: R c (Q q) -> World -> Entity -> IO (Maybe out) Source # runQueryInternal :: R c (Q q) -> [ArchetypeId] -> World -> IO [(Entity, Bool, out)] Source # queryTypes :: R c (Q q) -> Set (TypeRep, TypeQuery) Source #
RelQuery (IsExclusiveRel c) (R c (Q' q f)) out => Queryable (R c (Q' q f)) out Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: R c (Q' q f) -> World -> Entity -> IO (Maybe out) Source # runQueryInternal :: R c (Q' q f) -> [ArchetypeId] -> World -> IO [(Entity, Bool, out)] Source # queryTypes :: R c (Q' q f) -> Set (TypeRep, TypeQuery) Source #
Component c => Queryable (R c Entity) (Rel c) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: R c Entity -> World -> Entity -> IO (Maybe (Rel c)) Source # runQueryInternal :: R c Entity -> [ArchetypeId] -> World -> IO [(Entity, Bool, Rel c)] Source # queryTypes :: R c Entity -> Set (TypeRep, TypeQuery) Source #

newtype R' (a :: k) b Source #

Constructors

R' b

Instances

Instances details

RelQuery 'False (R c e) out => Queryable (R' c e) out Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: R' c e -> World -> Entity -> IO (Maybe out) Source # runQueryInternal :: R' c e -> [ArchetypeId] -> World -> IO [(Entity, Bool, out)] Source # queryTypes :: R' c e -> Set (TypeRep, TypeQuery) Source #

module Mischief.ECS.World.Query.TH

insert :: HasCallStack => forall b. Bundle b => b -> Entity -> System () Source #

Insert a bundle of components on an Entity.

If the entity already contains these components, their values will be updated in-place instead of causing an archetype change.

insertIfNeq :: BundleEq b => b -> Entity -> System () Source #

insertNew :: Bundle b => b -> Entity -> System () Source #

Insert a bundle of components on an Entity.

Only the components that the entity doesn't already have will be inserted, and the rest ignored.

remove :: Collectable c ToRemove => c -> Entity -> System () Source #

despawn :: Entity -> System () Source #

Despawn an entity. This will trigger the OnRemove events and hooks on all its components.

spawn :: (HasCallStack, Bundle b) => b -> System Entity Source #

Spawn an entity given a bundle of components.

spawnDefer :: Bundle b => b -> ParSystem Entity Source #

Spawn an entity given a bundle of components, inside a ParSystem.

This will immediately reserve and return an Entity index which can be used, while defering the actual spawn.

module Mischief.ECS.Resources

class Typeable e => Event e Source #

Event typeclass.

Instances

Instances details

(Typeable c, Typeable k) => Event (OnAdd c) Source #
Instance details Defined in Mischief.ECS.Events Methods eraseEvent :: OnAdd c -> ErasedEvent Source #
(Typeable c, Typeable k) => Event (OnAddRel c) Source #
Instance details Defined in Mischief.ECS.Events Methods eraseEvent :: OnAddRel c -> ErasedEvent Source #
(Typeable c, Typeable k) => Event (OnRemove c) Source #
Instance details Defined in Mischief.ECS.Events Methods eraseEvent :: OnRemove c -> ErasedEvent Source #
(Typeable c, Typeable k) => Event (OnRemoveRel c) Source #
Instance details Defined in Mischief.ECS.Events Methods eraseEvent :: OnRemoveRel c -> ErasedEvent Source #
(Typeable c, Typeable k) => Event (OnSet c) Source #
Instance details Defined in Mischief.ECS.Events Methods eraseEvent :: OnSet c -> ErasedEvent Source #
(Typeable c, Typeable k) => Event (OnSetRel c) Source #
Instance details Defined in Mischief.ECS.Events Methods eraseEvent :: OnSetRel c -> ErasedEvent Source #

data System a Source #

A System is a monad that mutates the World.

It can be added to a certain schedule and ordered with other systems. It also offers IO access via liftIO.

Read the tutorial on systems for more details.

Instances

Instances details

Applicative System Source #

Instance details

Defined in Mischief.ECS.World

Methods

pure :: a -> System a #

(<*>) :: System (a -> b) -> System a -> System b #

liftA2 :: (a -> b -> c) -> System a -> System b -> System c #

(*>) :: System a -> System b -> System b #

(<*) :: System a -> System b -> System a #

Functor System Source #

Instance details

Defined in Mischief.ECS.World

Methods

fmap :: (a -> b) -> System a -> System b #

(<$) :: a -> System b -> System a #

Monad System Source #

Instance details

Defined in Mischief.ECS.World

Methods

(>>=) :: System a -> (a -> System b) -> System b #

(>>) :: System a -> System b -> System b #

return :: a -> System a #

MonadFail System Source #

Instance details

Defined in Mischief.ECS.World

Methods

fail :: String -> System a #

MonadIO System Source #

Instance details

Defined in Mischief.ECS.World

Methods

liftIO :: IO a -> System a #

Defer System Source #

Instance details

Defined in Mischief.ECS.World.Defer

Methods

defer :: System a -> System () Source #

PrimMonad System Source #

Instance details

Defined in Mischief.ECS.World

Associated Types

type PrimState System
Instance details Defined in Mischief.ECS.World type PrimState System = PrimState IO

Methods

primitive :: (State# (PrimState System) -> (# State# (PrimState System), a #)) -> System a #

EraseIntoStorage (System ()) Systems Source #

Instance details

Defined in Mischief.ECS.Systems

Methods

erase :: System () -> Systems Source #

EraseIntoStorage (System ()) [System ()] Source #

Instance details

Defined in Mischief.ECS.World

Methods

erase :: System () -> [System ()] Source #

type PrimState System Source #

Instance details

Defined in Mischief.ECS.World

type PrimState System = PrimState IO

data Time Source #

data TimePlugin Source #

Instances

Instances details

Plugin TimePlugin Source #
Instance details Defined in Mischief.ECS.Time Methods deps :: [Dependency] Source # init :: System () Source #

delay :: MonadSystem w m => Int -> System () -> m () Source #

runAfter :: MonadSystem w m => IO a -> (a -> System ()) -> m () Source #

defer :: Defer m => System a -> m () Source #

addPlugin :: Plugin p => App -> IO () Source #

newApp :: IO App Source #

runApp :: App -> IO () Source #

dep :: Plugin p => Dependency Source #

data Dependency Source #

Instances

Instances details

Show Dependency Source #
Instance details Defined in Mischief.ECS.App.Plugins Methods showsPrec :: Int -> Dependency -> ShowS # show :: Dependency -> String # showList :: [Dependency] -> ShowS #
Eq Dependency Source #
Instance details Defined in Mischief.ECS.App.Plugins Methods (==) :: Dependency -> Dependency -> Bool # (/=) :: Dependency -> Dependency -> Bool #
Ord Dependency Source #
Instance details Defined in Mischief.ECS.App.Plugins Methods compare :: Dependency -> Dependency -> Ordering # (<) :: Dependency -> Dependency -> Bool # (<=) :: Dependency -> Dependency -> Bool # (>) :: Dependency -> Dependency -> Bool # (>=) :: Dependency -> Dependency -> Bool # max :: Dependency -> Dependency -> Dependency # min :: Dependency -> Dependency -> Dependency #

class Typeable p => Plugin p where Source #

Minimal complete definition

Nothing

Methods

deps :: [Dependency] Source #

init :: System () Source #

Instances

Instances details

Plugin TimePlugin Source #
Instance details Defined in Mischief.ECS.Time Methods deps :: [Dependency] Source # init :: System () Source #

data PostStartup Source #

Instances

Instances details

Schedule PostStartup Source #
Instance details Defined in Mischief.ECS.App.Schedules

data PostUpdate Source #

Instances

Instances details

Schedule PostUpdate Source #
Instance details Defined in Mischief.ECS.App.Schedules

data PreStartup Source #

Instances

Instances details

Schedule PreStartup Source #
Instance details Defined in Mischief.ECS.App.Schedules

data PreUpdate Source #

Instances

Instances details

Schedule PreUpdate Source #
Instance details Defined in Mischief.ECS.App.Schedules

data Startup Source #

Instances

Instances details

Show Startup Source #
Instance details Defined in Mischief.ECS.App.Schedules Methods showsPrec :: Int -> Startup -> ShowS # show :: Startup -> String # showList :: [Startup] -> ShowS #
Schedule Startup Source #
Instance details Defined in Mischief.ECS.App.Schedules

data Update Source #

Instances

Instances details

Show Update Source #
Instance details Defined in Mischief.ECS.App.Schedules Methods showsPrec :: Int -> Update -> ShowS # show :: Update -> String # showList :: [Update] -> ShowS #
Schedule Update Source #
Instance details Defined in Mischief.ECS.App.Schedules

after :: ToSystems a => a -> SystemConfig -> SystemConfig Source #

before :: ToSystems a => a -> SystemConfig -> SystemConfig Source #

order :: forall {k} (sc :: k) a b. (Schedule sc, ToSystems a, ToSystems b) => (a, b) -> System () Source #

schedule :: forall {k} (sc :: k). Schedule sc => SystemConfig -> System () Source #

systems :: ToSystems a => a -> SystemConfig Source #

unschedule :: forall {k} (sc :: k) a. (Schedule sc, ToSystems a) => a -> System () Source #

module Mischief.ECS.Log

expect :: HasCallStack => String -> Maybe a -> a Source #

unwrap :: HasCallStack => Maybe a -> a Source #

trigger :: Event e => e -> System () Source #

newtype OnAdd (c :: k) Source #

Constructors

OnAdd
Fields entity :: Entity

Instances

Instances details

Show (OnAdd c) Source #
Instance details Defined in Mischief.ECS.Events Methods showsPrec :: Int -> OnAdd c -> ShowS # show :: OnAdd c -> String # showList :: [OnAdd c] -> ShowS #
(Typeable c, Typeable k) => Event (OnAdd c) Source #
Instance details Defined in Mischief.ECS.Events Methods eraseEvent :: OnAdd c -> ErasedEvent Source #

data OnAddRel (c :: k) Source #

Constructors

OnAddRel
Fields entity :: Entity target :: Entity

Instances

Instances details

Show (OnAddRel c) Source #
Instance details Defined in Mischief.ECS.Events Methods showsPrec :: Int -> OnAddRel c -> ShowS # show :: OnAddRel c -> String # showList :: [OnAddRel c] -> ShowS #
(Typeable c, Typeable k) => Event (OnAddRel c) Source #
Instance details Defined in Mischief.ECS.Events Methods eraseEvent :: OnAddRel c -> ErasedEvent Source #

newtype OnRemove (c :: k) Source #

Constructors

OnRemove
Fields entity :: Entity

Instances

Instances details

Show (OnRemove c) Source #
Instance details Defined in Mischief.ECS.Events Methods showsPrec :: Int -> OnRemove c -> ShowS # show :: OnRemove c -> String # showList :: [OnRemove c] -> ShowS #
(Typeable c, Typeable k) => Event (OnRemove c) Source #
Instance details Defined in Mischief.ECS.Events Methods eraseEvent :: OnRemove c -> ErasedEvent Source #

data OnRemoveRel (c :: k) Source #

Constructors

OnRemoveRel
Fields entity :: Entity target :: Entity

Instances

Instances details

Show (OnRemoveRel c) Source #
Instance details Defined in Mischief.ECS.Events Methods showsPrec :: Int -> OnRemoveRel c -> ShowS # show :: OnRemoveRel c -> String # showList :: [OnRemoveRel c] -> ShowS #
(Typeable c, Typeable k) => Event (OnRemoveRel c) Source #
Instance details Defined in Mischief.ECS.Events Methods eraseEvent :: OnRemoveRel c -> ErasedEvent Source #

newtype OnSet (c :: k) Source #

Constructors

OnSet
Fields entity :: Entity

Instances

Instances details

Show (OnSet c) Source #
Instance details Defined in Mischief.ECS.Events Methods showsPrec :: Int -> OnSet c -> ShowS # show :: OnSet c -> String # showList :: [OnSet c] -> ShowS #
(Typeable c, Typeable k) => Event (OnSet c) Source #
Instance details Defined in Mischief.ECS.Events Methods eraseEvent :: OnSet c -> ErasedEvent Source #

data OnSetRel (c :: k) Source #

Constructors

OnSetRel
Fields entity :: Entity target :: Entity

Instances

Instances details

Show (OnSetRel c) Source #
Instance details Defined in Mischief.ECS.Events Methods showsPrec :: Int -> OnSetRel c -> ShowS # show :: OnSetRel c -> String # showList :: [OnSetRel c] -> ShowS #
(Typeable c, Typeable k) => Event (OnSetRel c) Source #
Instance details Defined in Mischief.ECS.Events Methods eraseEvent :: OnSetRel c -> ErasedEvent Source #

data Hook (a :: k) Source #

newtype HookContext Source #

Constructors

HookContext
Fields entity :: Entity

data HookContextRel Source #

Constructors

HookContextRel
Fields entity :: Entity target :: Entity

data HookRel (a :: k) Source #

module Mischief.ECS.Hooks

type Bundle b = Collectable b (BundleData ErasedComponent) Source #

type BundleEq b = Collectable b (BundleData ErasedComponentEq) Source #

data Timer Source #

module Mischief.ECS.World.Query.Pipe

newtype Observer e Source #

Constructors

Observer (e -> System ())

Instances

Instances details

Typeable e => Component (Observer e) Source #

Instance details

Defined in Mischief.ECS.Observer

Associated Types

type IsExclusiveRel (Observer e)
Instance details Defined in Mischief.ECS.Observer type IsExclusiveRel (Observer e) = 'False

Methods