include/timers.h File Reference

#include <global.h>

Go to the source code of this file.

Data Structures
struct	_cftimer
Defines
#define	TIMER_MODE_DEAD   0
#define	TIMER_MODE_SECONDS   1
#define	TIMER_MODE_CYCLES   2
#define	MAX_TIMERS   1000
#define	TIMER_ERR_NONE   0
#define	TIMER_ERR_ID   -1
#define	TIMER_ERR_OBJ   -2
#define	TIMER_ERR_MODE   -3
Typedefs
typedef struct _cftimer	cftimer

---

Detailed Description

Atrinik timers support header file.

A timer is a kind of "clock" associated with an object. When the counter of a timer reaches 0, it is removed from the list of active timers and an EVENT_TIMER is generated for the target object.

Note:

Don't confuse "EVENT_TIMER" and "EVENT_TIME" - the first one is called when a timer delay has reached 0 while EVENT_TIME is triggered each time the object gets the opportunity to move.

Author:

Yann Chachkoff

Definition in file timers.h.

---

Define Documentation

#define MAX_TIMERS   1000

Timer limits.

You can't create more than 1000 timers (I created the timers table as a static one not (only) because I was too lazy/incompetent to implement is as a dynamic linked-list, but because:

1. 1000 should be quite enough,
2. 1000 does not use a lot of memory,
3. it would be easier to adapt to some form of multithreading support with a static list.

Anyway, if you think 1000 is not enough, you can safely increase this - memory should not be a problem in that case, given the size of a cftimer.

Definition at line 94 of file timers.h.

---

Typedef Documentation

typedef struct _cftimer cftimer

The timer structure.