Clecs 2.0.1-SNAPSHOT API documentation

Primitives for query criteria.

query method of clecs.world.queryable/IQueryableWorld is used to find entities based on their components.

Examples:

;; Return a seq containing entity id's that
;; has FooComponent:
(query queryable-world (all FooComponent))

;; Same as the previous one:
(query queryable-world (any FooComponent))

;; Entities with both FooComponent and BarComponent
(query queryable-world
       (all FooComponent BarComponent))

;; Entities with either FooComponent or BarComponent
(query queryable-world
       (any FooComponent BarComponent))

;; Entities with FooComponent and either
;; BazComponent or BatComponent
(query queryable-world
       (all FooComponent (any BazComponent
                              BatComponent)))

;; Entities with either FooComponent and
;; BarComponent or BazComponent and BatComponent
(query queryable-world
       (any (all FooComponent BarComponent)
            (all BazComponent BatComponent)))

You can nest primitive calls infinitely. However it is considered bad design to query too many components at once.

See also clecs.world.queryable/IQueryableWorld.