Flecs v4.0
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
flecs::system_builder_i< Base, Components > Struct Template Referenceabstract

System builder interface. More...

#include <builder_i.hpp>

Inheritance diagram for flecs::system_builder_i< Base, Components >:
[legend]

Public Member Functions

 system_builder_i (ecs_system_desc_t *desc)
Base & kind (entity_t phase)
 Specify in which phase the system should run.
template<typename E, if_t< is_enum< E >::value > = 0>
Base & kind (E phase)
template<typename Phase>
Base & kind ()
 Specify in which phase the system should run.
Base & multi_threaded (bool value=true)
 Specify whether system can run on multiple threads.
Base & immediate (bool value=true)
 Specify whether system should be ran in staged context.
Base & interval (ecs_ftime_t interval)
 Set system interval.
Base & rate (const entity_t tick_source, int32_t rate)
 Set system rate.
Base & rate (int32_t rate)
 Set system rate.
template<typename T>
Base & tick_source ()
 Set tick source.
Base & tick_source (flecs::entity_t tick_source)
 Set tick source.
Base & ctx (void *ptr)
 Set system context.
Base & run (ecs_iter_action_t action)
 Set system run callback.
Public Member Functions inherited from flecs::query_builder_i< Base, Components ... >
 query_builder_i (ecs_query_desc_t *desc, int32_t term_index=0)
Base & query_flags (ecs_flags32_t flags)
Base & cache_kind (query_cache_kind_t kind)
Base & cached ()
Base & detect_changes ()
Base & expr (const char *expr)
Base & with ()
Base & with (id_t component_id)
Base & with (const char *component_name)
Base & with (const char *first, const char *second)
Base & with (entity_t first, entity_t second)
Base & with (entity_t first, const char *second)
Base & with (const char *first, entity_t second)
Base & with (entity_t second)
Base & with (const char *second)
Base & with ()
Base & with (E value)
Base & with (flecs::term &term)
Base & with (flecs::term &&term)
Base & without (Args &&... args)
Base & without (Args &&... args)
Base & without ()
Base & write ()
Base & write (Args &&... args)
Base & write (Args &&... args)
Base & write ()
Base & read ()
Base & read (Args &&... args)
Base & read (Args &&... args)
Base & read ()
Base & scope_open ()
Base & scope_close ()
Base & term ()
 Sets the current term to next one in term list.
Base & term_at ()
 Sets the current term to the one with the provided type.
Base & term_at (int32_t term_index)
 Sets the current term to the one at the provided index.
Base & term_at (int32_t term_index)
 Sets the current term to the one at the provided index and asserts that the type matches.
Base & order_by (int(*compare)(flecs::entity_t, const T *, flecs::entity_t, const T *))
 Sort the output of a query.
Base & order_by (flecs::entity_t component, int(*compare)(flecs::entity_t, const void *, flecs::entity_t, const void *))
 Sort the output of a query.
Base & group_by (uint64_t(*group_by_action)(flecs::world_t *, flecs::table_t *table, flecs::id_t id, void *ctx))
 Group and sort matched tables.
Base & group_by (flecs::entity_t component, uint64_t(*group_by_action)(flecs::world_t *, flecs::table_t *table, flecs::id_t id, void *ctx))
 Group and sort matched tables.
Base & group_by ()
 Group and sort matched tables.
Base & group_by (flecs::entity_t component)
 Group and sort matched tables.
Base & group_by_ctx (void *ctx, ecs_ctx_free_t ctx_free=nullptr)
 Specify context to be passed to group_by function.
Base & on_group_create (ecs_group_create_action_t action)
 Specify on_group_create action.
Base & on_group_delete (ecs_group_delete_action_t action)
 Specify on_group_delete action.
Public Member Functions inherited from flecs::term_builder_i< Base >
 term_builder_i (ecs_term_t *term_ptr)
Base & term (id_t id)
Base & src ()
Base & first ()
Base & second ()
Base & src (flecs::entity_t id)
template<typename T>
Base & src ()
Base & src (const char *name)
Base & first (flecs::entity_t id)
template<typename T>
Base & first ()
Base & first (const char *name)
Base & second (flecs::entity_t id)
template<typename T>
Base & second ()
Base & second (const char *name)
Base & up (flecs::entity_t trav=0)
template<typename Trav>
Base & up ()
Base & cascade (flecs::entity_t trav=0)
template<typename Trav>
Base & cascade ()
Base & desc ()
Base & parent ()
Base & trav (flecs::entity_t trav, flecs::flags32_t flags=0)
Base & id_flags (id_t flags)
 Set id flags for term.
Base & inout (flecs::inout_kind_t inout)
 Set read/write access of term.
Base & inout_stage (flecs::inout_kind_t inout)
 Set read/write access for stage.
Base & write ()
 Short for inout_stage(flecs::Out).
Base & read ()
 Short for inout_stage(flecs::In).
Base & read_write ()
 Short for inout_stage(flecs::InOut).
Base & in ()
 Short for inout(flecs::In)
Base & out ()
 Short for inout(flecs::Out)
Base & inout ()
 Short for inout(flecs::InOut)
Base & inout_none ()
 Short for inout(flecs::In)
Base & oper (flecs::oper_kind_t oper)
 Set operator of term.
Base & and_ ()
Base & or_ ()
Base & not_ ()
Base & optional ()
Base & and_from ()
Base & or_from ()
Base & not_from ()
Base & singleton ()
 Match singleton.
Base & filter ()
Public Member Functions inherited from flecs::term_ref_builder_i< Base >
Base & self ()
Base & id (flecs::entity_t id)
Base & entity (flecs::entity_t entity)
Base & name (const char *name)
Base & var (const char *var_name)
Base & flags (flecs::flags32_t flags)

Protected Member Functions

virtual flecs::world_t * world_v () override=0
Protected Member Functions inherited from flecs::term_builder_i< Base >
void set_term (ecs_term_t *term)
Protected Member Functions inherited from flecs::term_ref_builder_i< Base >
void assert_term_ref ()

Additional Inherited Members

Public Attributes inherited from flecs::term_builder_i< Base >
ecs_term_tterm_
Public Attributes inherited from flecs::term_ref_builder_i< Base >
ecs_term_ref_tterm_ref_
Protected Attributes inherited from flecs::query_builder_i< Base, Components ... >
int32_t term_index_
int32_t expr_count_

Detailed Description

template<typename Base, typename ... Components>
struct flecs::system_builder_i< Base, Components >

System builder interface.

Definition at line 18 of file builder_i.hpp.

Constructor & Destructor Documentation

◆ system_builder_i()

template<typename Base, typename ... Components>
flecs::system_builder_i< Base, Components >::system_builder_i ( ecs_system_desc_t * desc)
inline

Definition at line 23 of file builder_i.hpp.

Member Function Documentation

◆ ctx()

template<typename Base, typename ... Components>
Base & flecs::system_builder_i< Base, Components >::ctx ( void * ptr)
inline

Set system context.

Definition at line 140 of file builder_i.hpp.

◆ immediate()

template<typename Base, typename ... Components>
Base & flecs::system_builder_i< Base, Components >::immediate ( bool value = true)
inline

Specify whether system should be ran in staged context.

Parameters
valueIf false system will always run staged.

Definition at line 75 of file builder_i.hpp.

◆ interval()

template<typename Base, typename ... Components>
Base & flecs::system_builder_i< Base, Components >::interval ( ecs_ftime_t interval)
inline

Set system interval.

This operation will cause the system to be ran at the specified interval.

The timer is synchronous, and is incremented each frame by delta_time.

Parameters
intervalThe interval value.

Definition at line 87 of file builder_i.hpp.

◆ kind() [1/3]

template<typename Base, typename ... Components>
template<typename Phase>
Base & flecs::system_builder_i< Base, Components >::kind ( )
inline

Specify in which phase the system should run.

Template Parameters
PhaseThe phase.

Definition at line 58 of file builder_i.hpp.

◆ kind() [2/3]

template<typename Base, typename ... Components>
template<typename E, if_t< is_enum< E >::value > = 0>
Base & flecs::system_builder_i< Base, Components >::kind ( E phase)
inline

Definition at line 46 of file builder_i.hpp.

◆ kind() [3/3]

template<typename Base, typename ... Components>
Base & flecs::system_builder_i< Base, Components >::kind ( entity_t phase)
inline

Specify in which phase the system should run.

Parameters
phaseThe phase.

Definition at line 31 of file builder_i.hpp.

◆ multi_threaded()

template<typename Base, typename ... Components>
Base & flecs::system_builder_i< Base, Components >::multi_threaded ( bool value = true)
inline

Specify whether system can run on multiple threads.

Parameters
valueIf false system will always run on a single thread.

Definition at line 66 of file builder_i.hpp.

◆ rate() [1/2]

template<typename Base, typename ... Components>
Base & flecs::system_builder_i< Base, Components >::rate ( const entity_t tick_source,
int32_t rate )
inline

Set system rate.

This operation will cause the system to be ran at a multiple of the provided tick source. The tick source may be any entity, including another system.

Parameters
tick_sourceThe tick source.
rateThe multiple at which to run the system.

Definition at line 100 of file builder_i.hpp.

◆ rate() [2/2]

template<typename Base, typename ... Components>
Base & flecs::system_builder_i< Base, Components >::rate ( int32_t rate)
inline

Set system rate.

This operation will cause the system to be ran at a multiple of the frame tick frequency. If a tick source was provided, this just updates the rate of the system.

Parameters
rateThe multiple at which to run the system.

Definition at line 113 of file builder_i.hpp.

◆ run()

template<typename Base, typename ... Components>
Base & flecs::system_builder_i< Base, Components >::run ( ecs_iter_action_t action)
inline

Set system run callback.

Definition at line 146 of file builder_i.hpp.

◆ tick_source() [1/2]

template<typename Base, typename ... Components>
template<typename T>
Base & flecs::system_builder_i< Base, Components >::tick_source ( )
inline

Set tick source.

This operation sets a shared tick source for the system.

Template Parameters
TThe type associated with the singleton tick source to use for the system.

Definition at line 124 of file builder_i.hpp.

◆ tick_source() [2/2]

template<typename Base, typename ... Components>
Base & flecs::system_builder_i< Base, Components >::tick_source ( flecs::entity_t tick_source)
inline

Set tick source.

This operation sets a shared tick source for the system.

Parameters
tick_sourceThe tick source to use for the system.

Definition at line 134 of file builder_i.hpp.

◆ world_v()

template<typename Base, typename ... Components>
virtual flecs::world_t * flecs::system_builder_i< Base, Components >::world_v ( )
overrideprotectedpure virtual

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