flecs::rule< Components > Struct Template Reference

Inheritance diagram for flecs::rule< 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)
bool	is_valid () const
	operator rule_t * () const
flecs::entity	entity ()
void	destruct ()
	Free the rule.
template<typename Func >
void	each_term (const Func &func) const
void	move (flecs::rule_base &&obj)
	Move the rule.
flecs::filter_base	filter () const
flecs::string	str () const
	Converts this rule to a string expression.
flecs::string	rule_str () const
	Converts this rule to a string that can be used to aid debugging the behavior of the rule.
	operator rule<> () const
Public Member Functions inherited from flecs::iterable< Components... >
void	each (Func &&func) const
	Each iterator.
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
flecs::entity	find (Func &&func) const
void	iter (Func &&func) const
	Iter iterator.
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.
page_iterable< Components... >	page (int32_t offset, int32_t limit)
	Page iterator.
worker_iterable< Components... >	worker (int32_t index, int32_t count)
	Worker iterator.
int32_t	count () const
	Return number of entities matched by iterable.
bool	is_true () const
	Return whether iterable has any matches.
flecs::entity	first () const
	Return first entity matched by iterable.

Additional Inherited Members
Protected Member Functions inherited from flecs::iterable< Components... >
void	iterate (flecs::world_t *stage, Func &&func, NextFunc next, Args &&... args) const
flecs::entity	iterate_find (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 100 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 122 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:

• include/flecs/addons/cpp/mixins/rule/decl.hpp
• include/flecs/addons/cpp/mixins/rule/impl.hpp