Flecs v3.1
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
flecs::rule< Components > Struct Template Reference
Inheritance diagram for flecs::rule< Components >:
flecs::rule_base flecs::iterable< Components... >

Public Member Functions

int32_t find_var (const char *name)
 
 rule_base ()
 
 rule_base (world_t *world, rule_t *rule=nullptr)
 
 rule_base (world_t *world, ecs_filter_desc_t *desc)
 
- Public Member Functions inherited from flecs::rule_base
 rule_base (world_t *world, rule_t *rule=nullptr)
 
 rule_base (world_t *world, ecs_filter_desc_t *desc)
 
 operator rule_t * () const
 
flecs::entity entity ()
 
void destruct ()
 Free the rule. More...
 
flecs::string str ()
 
 operator rule () const
 
- Public Member Functions inherited from flecs::iterable< Components... >
void each (Func &&func) const
 Each iterator. More...
 
void each (flecs::world_t *world, Func &&func) const
 
void each (flecs::iter &it, Func &&func) const
 
void each (flecs::entity e, Func &&func) const
 
void iter (Func &&func) const
 Iter iterator. More...
 
void iter (flecs::world_t *world, Func &&func) const
 
void iter (flecs::iter &it, Func &&func) const
 
void iter (flecs::entity e, Func &&func) const
 
iter_iterable< Components... > iter (flecs::world_t *world=nullptr) const
 Create iterator. More...
 
page_iterable< Components... > page (int32_t offset, int32_t limit)
 Page iterator. More...
 
worker_iterable< Components... > worker (int32_t index, int32_t count)
 Worker iterator. More...
 
int32_t count () const
 Return number of entities matched by iterable. More...
 
bool is_true () const
 Return whether iterable has any matches. More...
 
flecs::entity first () const
 Return first entity matched by iterable. More...
 

Additional Inherited Members

- Protected Member Functions inherited from flecs::iterable< Components... >
virtual ecs_iter_t get_iter (flecs::world_t *stage) const=0
 
virtual ecs_iter_next_action_t next_action () const=0
 
virtual ecs_iter_next_action_t next_each_action () const=0
 
void iterate (flecs::world_t *stage, Func &&func, NextFunc next, Args &&... args) const
 
- Protected Attributes inherited from flecs::rule_base
world_t * m_world
 
rule_t * m_rule
 
- Protected Attributes inherited from flecs::iterable< Components... >
friend iter_iterable< Components... >
 
friend page_iterable< Components... >
 
friend worker_iterable< Components... >
 

Detailed Description

template<typename ... Components>
struct flecs::rule< Components >

Definition at line 69 of file impl.hpp.

Member Function Documentation

◆ find_var()

template<typename ... Components>
int32_t flecs::rule< Components >::find_var ( const char *  name)
inline

Definition at line 91 of file impl.hpp.

◆ rule_base() [1/3]

template<typename ... Components>
flecs::rule_base::rule_base ( )
inline

Definition at line 17 of file impl.hpp.

◆ rule_base() [2/3]

template<typename ... Components>
flecs::rule_base::rule_base ( world_t *  world,
ecs_filter_desc_t desc 
)
inline

Definition at line 25 of file impl.hpp.

◆ rule_base() [3/3]

template<typename ... Components>
flecs::rule_base::rule_base ( world_t *  world,
rule_t *  rule = nullptr 
)
inline

Definition at line 21 of file impl.hpp.


The documentation for this struct was generated from the following files: