Merge branch 'master' into Mario/stats_eloranking
[xonotic/xonotic-data.pk3dir.git] / qcsrc / server / utils.qh
1 #pragma once
2
3 int maxclients;
4
5 const string STR_PLAYER = "player";
6 const string STR_SPECTATOR = "spectator";
7 const string STR_OBSERVER = "observer";
8
9 #define IS_PLAYER(v) ((v).classname == STR_PLAYER)
10 #define IS_SPEC(v) ((v).classname == STR_SPECTATOR)
11 #define IS_OBSERVER(v) ((v).classname == STR_OBSERVER)
12
13 #define IS_CLIENT(v) (v.flags & FL_CLIENT)
14 /** want: (IS_CLIENT(v) && !IS_REAL_CLIENT(v)) */
15 #define IS_BOT_CLIENT(v) (clienttype(v) == CLIENTTYPE_BOT)
16 #define IS_FAKE_CLIENT(v) (clienttype(v) == CLIENTTYPE_NOTACLIENT)
17 #define IS_REAL_CLIENT(v) (clienttype(v) == CLIENTTYPE_REAL)
18 /** was: (clienttype(v) == CLIENTTYPE_NOTACLIENT) */
19 #define IS_NOT_A_CLIENT(v) (!IS_CLIENT(v))
20
21 #define IS_MONSTER(v) (v.flags & FL_MONSTER)
22 #define IS_VEHICLE(v) (v.vehicle_flags & VHF_ISVEHICLE)
23 #define IS_TURRET(v) (v.turret_flags & TUR_FLAG_ISTURRET)
24
25 #define IS_MOVABLE(v) ((IS_PLAYER(v) || IS_MONSTER(v)) && !STAT(FROZEN, v))
26
27 // NOTE: FOR_EACH_CLIENTSLOT deprecated! Use the following instead: FOREACH_CLIENTSLOT(true, { code; });
28 // NOTE: FOR_EACH_CLIENT deprecated! Use the following instead: FOREACH_CLIENT(true, { code; });
29 // NOTE: FOR_EACH_REALCLIENT deprecated! Use the following instead: FOREACH_CLIENT(IS_REAL_CLIENT(it), { code; });
30
31 // NOTE: FOR_EACH_PLAYER deprecated! Use the following instead: FOREACH_CLIENT(IS_PLAYER(it), { code; });
32 // NOTE: FOR_EACH_SPEC deprecated! Use the following instead: FOREACH_CLIENT(IS_SPEC(it), { code; });
33 // NOTE: FOR_EACH_OBSERVER deprecated! Use the following instead: FOREACH_CLIENT(IS_OBSERVER(it), { code; });
34 // NOTE: FOR_EACH_REALPLAYER deprecated! Use the following instead: FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), { code; });
35
36 #define FOREACH_CLIENTSLOT(cond, body) \
37         MACRO_BEGIN \
38                 for(int _i = 1; _i <= maxclients; ++_i) \
39                 { \
40                         const noref int i = _i; \
41                         ITER_CONST noref entity it = ftoe(i); \
42                         if(cond) { LAMBDA(body) } \
43                 } \
44         MACRO_END
45
46 #define FOREACH_CLIENT(cond, body) FOREACH_CLIENTSLOT(IS_CLIENT(it) && (cond), LAMBDA(body))
47
48 // using the "inside out" version of knuth-fisher-yates shuffle
49 // https://en.wikipedia.org/wiki/Fisher–Yates_shuffle
50 entity _FCR_clients[255];
51 bool _FCR_entered = false;
52 #define FOREACH_CLIENT_RANDOM(cond, body) \
53         MACRO_BEGIN \
54                 if (_FCR_entered) LOG_FATAL("FOREACH_CLIENT_RANDOM must not be nested"); \
55                 _FCR_entered = true; \
56                 int _cnt = 0; \
57                 FOREACH_CLIENT(cond, { \
58                         int _j = floor(random() * (_cnt + 1)); \
59                         if (_j != _cnt) \
60                                 _FCR_clients[_cnt] = _FCR_clients[_j]; \
61                         _FCR_clients[_j] = it; \
62                         ++_cnt; \
63                 }); \
64                 for (int _i = 0; _i < _cnt; ++_i) \
65                 { \
66                         const noref int i = _i; \
67                         ITER_CONST noref entity it = _FCR_clients[i]; \
68                         if (cond) { LAMBDA(body) } \
69                 } \
70                 _FCR_entered = false; \
71         MACRO_END
72
73 // NOTE: FOR_EACH_MONSTER deprecated! Use the following instead: IL_EACH(g_monsters, true, { code; });