Safe Haskell	None
Language	GHC2024

Mischief.ECS.Prelude

Synopsis

data Entity
class (Typeable c, IsExclusive (RelExclusivity c)) => Component c
required :: Component c => Set DefaultComponentType
query :: forall qd output m w. (Queryable qd output, MonadSystem w m) => qd -> m [output]
remove :: Collectable c ToRemove => c -> Entity -> System ()

Documentation

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 #
Component c => IntoQueryFilter (CheckR Entity c) Source #
Instance details Defined in Mischief.ECS.World.Query.QueryFilter Methods intoQueryFilter :: CheckR Entity c -> QueryFilter Source #
Component c => EraseIntoStorage (R c Entity, c -> Bool) CheckFilterType Source #
Instance details Defined in Mischief.ECS.World.Query.QueryFilter Methods erase :: (R c Entity, c -> Bool) -> CheckFilterType Source #
Component c => EraseIntoStorage (R c Entity) FilterType Source #
Instance details Defined in Mischief.ECS.World.Query.QueryFilter Methods erase :: R c Entity -> FilterType 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 (Result (Rel c))) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: MR c Entity -> World -> Entity -> IO (Maybe (Maybe (Result (Rel c)))) Source # runQueryInternal :: MR c Entity -> [ArchetypeId] -> World -> IO [(Entity, Bool, Maybe (Result (Rel c)))] Source # queryTypes :: MR c Entity -> Set (TypeRep, TypeQuery) Source #
Component c => Queryable (R c Entity) (Result (Rel c)) Source #
Instance details Defined in Mischief.ECS.World.Query.Queryable Methods runQueryEntity :: R c Entity -> World -> Entity -> IO (Maybe (Result (Rel c))) Source # runQueryInternal :: R c Entity -> [ArchetypeId] -> World -> IO [(Entity, Bool, Result (Rel c))] Source # queryTypes :: R c Entity -> Set (TypeRep, TypeQuery) Source #

class (Typeable c, IsExclusive (RelExclusivity c)) => Component c Source #

The Component typeclass.

Instances

Instances details

Component ScheduleLabel Source #

Instance details

Defined in Mischief.ECS.App.Schedules

Associated Types

type RelExclusivity ScheduleLabel
Instance details Defined in Mischief.ECS.App.Schedules type RelExclusivity ScheduleLabel = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks ScheduleLabel Source #

Component Schedules Source #

Instance details

Defined in Mischief.ECS.App.Schedules

Associated Types

type RelExclusivity Schedules
Instance details Defined in Mischief.ECS.App.Schedules type RelExclusivity Schedules = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks Schedules Source #

Component StartupSchedule Source #

Instance details

Defined in Mischief.ECS.App.Schedules

Associated Types

type RelExclusivity StartupSchedule
Instance details Defined in Mischief.ECS.App.Schedules type RelExclusivity StartupSchedule = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks StartupSchedule Source #

Component UpdateSchedule Source #

Instance details

Defined in Mischief.ECS.App.Schedules

Associated Types

type RelExclusivity UpdateSchedule
Instance details Defined in Mischief.ECS.App.Schedules type RelExclusivity UpdateSchedule = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks UpdateSchedule Source #

Component LastSystemTick Source #

Instance details

Defined in Mischief.ECS.App.SystemDef

Associated Types

type RelExclusivity LastSystemTick
Instance details Defined in Mischief.ECS.App.SystemDef type RelExclusivity LastSystemTick = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks LastSystemTick Source #

Component SystemTick Source #

Instance details

Defined in Mischief.ECS.App.SystemDef

Associated Types

type RelExclusivity SystemTick
Instance details Defined in Mischief.ECS.App.SystemDef type RelExclusivity SystemTick = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks SystemTick Source #

Component ScheduledIn Source #

Instance details

Defined in Mischief.ECS.App.Systems

Associated Types

type RelExclusivity ScheduledIn
Instance details Defined in Mischief.ECS.App.Systems type RelExclusivity ScheduledIn = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks ScheduledIn Source #

Component SystemFunction Source #

Instance details

Defined in Mischief.ECS.App.Systems

Associated Types

type RelExclusivity SystemFunction
Instance details Defined in Mischief.ECS.App.Systems type RelExclusivity SystemFunction = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks SystemFunction Source #

Component Systems Source #

Instance details

Defined in Mischief.ECS.App.Systems

Associated Types

type RelExclusivity Systems
Instance details Defined in Mischief.ECS.App.Systems type RelExclusivity Systems = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks Systems Source #

Component ComponentArchetypes Source #

Instance details

Defined in Mischief.ECS.Components

Associated Types

type RelExclusivity ComponentArchetypes
Instance details Defined in Mischief.ECS.Components type RelExclusivity ComponentArchetypes = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks ComponentArchetypes Source #

Component ComponentPairs Source #

Instance details

Defined in Mischief.ECS.Components

Associated Types

type RelExclusivity ComponentPairs
Instance details Defined in Mischief.ECS.Components type RelExclusivity ComponentPairs = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks ComponentPairs Source #

Component ComponentType Source #

Instance details

Defined in Mischief.ECS.Components

Associated Types

type RelExclusivity ComponentType
Instance details Defined in Mischief.ECS.Components type RelExclusivity ComponentType = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks ComponentType Source #

Component DefaultValue Source #

Instance details

Defined in Mischief.ECS.Components

Associated Types

type RelExclusivity DefaultValue
Instance details Defined in Mischief.ECS.Components type RelExclusivity DefaultValue = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks DefaultValue Source #

Component RequiredBy Source #

Instance details

Defined in Mischief.ECS.Components

Associated Types

type RelExclusivity RequiredBy
Instance details Defined in Mischief.ECS.Components type RelExclusivity RequiredBy = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks RequiredBy Source #

Component Requires Source #

Instance details

Defined in Mischief.ECS.Components

Associated Types

type RelExclusivity Requires
Instance details Defined in Mischief.ECS.Components type RelExclusivity Requires = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks Requires Source #

Component Name Source #

Instance details

Defined in Mischief.ECS.Components.Common

Associated Types

type RelExclusivity Name
Instance details Defined in Mischief.ECS.Components.Common type RelExclusivity Name = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks Name Source #

Component ObserverOrder Source #

Instance details

Defined in Mischief.ECS.Observer

Associated Types

type RelExclusivity ObserverOrder
Instance details Defined in Mischief.ECS.Observer type RelExclusivity ObserverOrder = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks ObserverOrder Source #

Component IsExclusiveRelationship Source #

Instance details

Defined in Mischief.ECS.Relationships

Associated Types

type RelExclusivity IsExclusiveRelationship
Instance details Defined in Mischief.ECS.Relationships type RelExclusivity IsExclusiveRelationship = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks IsExclusiveRelationship Source #

Component ChildOf Source #

Instance details

Defined in Mischief.ECS.Relationships.ChildOf

Associated Types

type RelExclusivity ChildOf
Instance details Defined in Mischief.ECS.Relationships.ChildOf type RelExclusivity ChildOf = 'Exclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks ChildOf Source #

Component Before Source #

Instance details

Defined in Mischief.ECS.Relationships.Order

Associated Types

type RelExclusivity Before
Instance details Defined in Mischief.ECS.Relationships.Order type RelExclusivity Before = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks Before Source #

Component Visited Source #

Instance details

Defined in Mischief.ECS.Relationships.Order

Associated Types

type RelExclusivity Visited
Instance details Defined in Mischief.ECS.Relationships.Order type RelExclusivity Visited = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks Visited Source #

Component Time Source #

Instance details

Defined in Mischief.ECS.Time

Associated Types

type RelExclusivity Time
Instance details Defined in Mischief.ECS.Time type RelExclusivity Time = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks Time Source #

Typeable e => Component (Observer e) Source #

Instance details

Defined in Mischief.ECS.Observer

Associated Types

type RelExclusivity (Observer e)
Instance details Defined in Mischief.ECS.Observer type RelExclusivity (Observer e) = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks (Observer e) Source #

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

Instance details

Defined in Mischief.ECS.Observer

Associated Types

type RelExclusivity (EventProxy e)
Instance details Defined in Mischief.ECS.Observer type RelExclusivity (EventProxy e) = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks (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 RelExclusivity (TestG a b)
Instance details Defined in Mischief.ECS.World.Query.TH.QD type RelExclusivity (TestG a b) = 'Inclusive

Methods

required :: Set DefaultComponentType Source #

hooks :: Hooks (TestG a b) Source #

required :: Component c => Set DefaultComponentType Source #

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"

query :: forall qd output m w. (Queryable qd output, MonadSystem w m) => qd -> m [output] Source #

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