Run systems at a time interval. More...

Collaboration diagram for Timer:

Classes
struct	flecs::timer
	Timer class. More...

Typedefs
using	flecs::Timer = EcsTimer
	Timer component.
using	flecs::RateFilter = EcsRateFilter
	Rate filter component.

Functions
template<typename T>
flecs::timer	flecs::world::timer () const
	Find or register a singleton timer.
void	flecs::system::interval (ecs_ftime_t interval)
	Set interval.
ecs_ftime_t	interval ()
	Get interval.
void	timeout (ecs_ftime_t timeout)
	Set timeout.
ecs_ftime_t	timeout ()
	Get timeout.
void	rate (int32_t rate)
	Set system rate (system is its own tick source).
void	start ()
	Start timer.
void	stop ()
	Stop timer.
template<typename T>
void	set_tick_source ()
	Set external tick source.
void	set_tick_source (flecs::entity e)
	Set external tick source.

Detailed Description

Run systems at a time interval.

Typedef Documentation

◆ RateFilter

using flecs::RateFilter = EcsRateFilter

Rate filter component.

Definition at line 21 of file decl.hpp.

◆ Timer

using flecs::Timer = EcsTimer

Timer component.

Definition at line 19 of file decl.hpp.

Function Documentation

◆ interval() [1/2]

ecs_ftime_t flecs::system::interval ( )

Get interval.

Get the interval for a system.

See also: ecs_get_interval()

Definition at line 77 of file impl.hpp.

◆ interval() [2/2]

void flecs::system::interval ( ecs_ftime_t interval )

inline

Set interval.

Set the interval for a system.

See also: ecs_set_interval()

Definition at line 72 of file impl.hpp.

◆ rate()

void flecs::system::rate ( int32_t rate )

Set system rate (system is its own tick source).

Set the rate for a system.

See also: ecs_set_rate()

Definition at line 92 of file impl.hpp.

◆ set_tick_source() [1/2]

template<typename T>

void flecs::system::set_tick_source ( )

Set external tick source.

Set the tick source for a system by type.

See also: ecs_set_tick_source()

Definition at line 108 of file impl.hpp.

◆ set_tick_source() [2/2]

void flecs::system::set_tick_source ( flecs::entity e )

Set external tick source.

Set the tick source for a system by entity.

See also: ecs_set_tick_source()

Definition at line 113 of file impl.hpp.

◆ start()

void flecs::system::start ( )

Start timer.

Start the system timer.

See also: ecs_start_timer()

Definition at line 97 of file impl.hpp.

◆ stop()

void flecs::system::stop ( )

Stop timer.

Stop the system timer.

See also: ecs_stop_timer()

Definition at line 102 of file impl.hpp.

◆ timeout() [1/2]

ecs_ftime_t flecs::system::timeout ( )

Get timeout.

Get the timeout for a system.

See also: ecs_get_timeout()

Definition at line 87 of file impl.hpp.

◆ timeout() [2/2]

void flecs::system::timeout ( ecs_ftime_t timeout )

Set timeout.

Set the timeout for a system.

See also: ecs_set_timeout()

Definition at line 82 of file impl.hpp.

◆ timer()