flecs/timer_8h_source.html

#ifdef FLECS_TIMER


#ifndef FLECS_MODULE

#define FLECS_MODULE

#endif


#ifndef FLECS_PIPELINE

#define FLECS_PIPELINE

#endif


#ifndef FLECS_TIMER_H

#define FLECS_TIMER_H


#ifdef __cplusplus

extern "C" {

#endif


typedef struct EcsTimer {

    ecs_ftime_t timeout;

    ecs_ftime_t time;

    ecs_ftime_t overshoot;

    int32_t fired_count;

    bool active;

    bool single_shot;

} EcsTimer;


typedef struct EcsRateFilter {

    ecs_entity_t src;

    int32_t rate;

    int32_t tick_count;

    ecs_ftime_t time_elapsed;

} EcsRateFilter;


FLECS_API

ecs_entity_t ecs_set_timeout(

    ecs_world_t *world,

    ecs_entity_t tick_source,

    ecs_ftime_t timeout);


FLECS_API

ecs_ftime_t ecs_get_timeout(

    const ecs_world_t *world,

    ecs_entity_t tick_source);


FLECS_API

ecs_entity_t ecs_set_interval(

    ecs_world_t *world,

    ecs_entity_t tick_source,

    ecs_ftime_t interval);


FLECS_API

ecs_ftime_t ecs_get_interval(

    const ecs_world_t *world,

    ecs_entity_t tick_source);


FLECS_API

void ecs_start_timer(

    ecs_world_t *world,

    ecs_entity_t tick_source);


FLECS_API

void ecs_stop_timer(

    ecs_world_t *world,

    ecs_entity_t tick_source);


FLECS_API

void ecs_reset_timer(

    ecs_world_t *world,

    ecs_entity_t tick_source);


FLECS_API

void ecs_randomize_timers(

    ecs_world_t *world);


FLECS_API

ecs_entity_t ecs_set_rate(

    ecs_world_t *world,

    ecs_entity_t tick_source,

    int32_t rate,

    ecs_entity_t source);


FLECS_API

void ecs_set_tick_source(

    ecs_world_t *world,

    ecs_entity_t system,

    ecs_entity_t tick_source);


FLECS_API

void FlecsTimerImport(

    ecs_world_t *world);


#ifdef __cplusplus

}

#endif


#endif


#endif

ecs_get_timeout
FLECS_API ecs_ftime_t ecs_get_timeout(const ecs_world_t *world, ecs_entity_t tick_source)
Get current timeout value for the specified timer.

ecs_reset_timer
FLECS_API void ecs_reset_timer(ecs_world_t *world, ecs_entity_t tick_source)
Reset time value of timer to 0.

ecs_set_interval
FLECS_API ecs_entity_t ecs_set_interval(ecs_world_t *world, ecs_entity_t tick_source, ecs_ftime_t interval)
Set timer interval.

ecs_get_interval
FLECS_API ecs_ftime_t ecs_get_interval(const ecs_world_t *world, ecs_entity_t tick_source)
Get current interval value for the specified timer.

ecs_set_tick_source
FLECS_API void ecs_set_tick_source(ecs_world_t *world, ecs_entity_t system, ecs_entity_t tick_source)
Assign tick source to system.

ecs_set_rate
FLECS_API ecs_entity_t ecs_set_rate(ecs_world_t *world, ecs_entity_t tick_source, int32_t rate, ecs_entity_t source)
Set rate filter.

FlecsTimerImport
FLECS_API void FlecsTimerImport(ecs_world_t *world)
Timer module import function.

EcsTimer
struct EcsTimer EcsTimer
Component used for one shot/interval timer functionality.

ecs_start_timer
FLECS_API void ecs_start_timer(ecs_world_t *world, ecs_entity_t tick_source)
Start timer.

ecs_randomize_timers
FLECS_API void ecs_randomize_timers(ecs_world_t *world)
Enable randomizing initial time value of timers.

ecs_set_timeout
FLECS_API ecs_entity_t ecs_set_timeout(ecs_world_t *world, ecs_entity_t tick_source, ecs_ftime_t timeout)
Set timer timeout.

ecs_stop_timer
FLECS_API void ecs_stop_timer(ecs_world_t *world, ecs_entity_t tick_source)
Stop timer This operation stops a timer from triggering.

EcsRateFilter
struct EcsRateFilter EcsRateFilter
Apply a rate filter to a tick source.

ecs_entity_t
ecs_id_t ecs_entity_t
An entity identifier.
Definition flecs.h:346

ecs_world_t
struct ecs_world_t ecs_world_t
A world is the container for all ECS data and supporting features.
Definition flecs.h:390

ecs_ftime_t
#define ecs_ftime_t
Customizable precision for scalar time values.
Definition flecs.h:59

EcsRateFilter
Apply a rate filter to a tick source.
Definition timer.h:45

EcsRateFilter::rate
int32_t rate
Rate of the rate filter.
Definition timer.h:47

EcsRateFilter::tick_count
int32_t tick_count
Number of times the rate filter ticked.
Definition timer.h:48

EcsRateFilter::time_elapsed
ecs_ftime_t time_elapsed
Time elapsed since last tick.
Definition timer.h:49

EcsRateFilter::src
ecs_entity_t src
Source of the rate filter.
Definition timer.h:46

EcsTimer
Component used for one shot/interval timer functionality.
Definition timer.h:35

EcsTimer::time
ecs_ftime_t time
Incrementing time value.
Definition timer.h:37

EcsTimer::active
bool active
Is the timer active or not.
Definition timer.h:40

EcsTimer::single_shot
bool single_shot
Is this a single shot timer.
Definition timer.h:41

EcsTimer::overshoot
ecs_ftime_t overshoot
Used to correct returned interval time.
Definition timer.h:38

EcsTimer::fired_count
int32_t fired_count
Number of times ticked.
Definition timer.h:39

EcsTimer::timeout
ecs_ftime_t timeout
Timer timeout period.
Definition timer.h:36