Xonotic
utils.qh
Go to the documentation of this file.
1 #pragma once
2 
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 
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 
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 #define IS_DEAD(s) ((s).deadflag != DEAD_NO)
27 
28 #define CENTER_OR_VIEWOFS(ent) (ent.origin + (IS_PLAYER(ent) ? ent.view_ofs : ((ent.mins + ent.maxs) * 0.5)))
29 
30 // NOTE: FOR_EACH_CLIENTSLOT deprecated! Use the following instead: FOREACH_CLIENTSLOT(true, { code; });
31 // NOTE: FOR_EACH_CLIENT deprecated! Use the following instead: FOREACH_CLIENT(true, { code; });
32 // NOTE: FOR_EACH_REALCLIENT deprecated! Use the following instead: FOREACH_CLIENT(IS_REAL_CLIENT(it), { code; });
33 
34 // NOTE: FOR_EACH_PLAYER deprecated! Use the following instead: FOREACH_CLIENT(IS_PLAYER(it), { code; });
35 // NOTE: FOR_EACH_SPEC deprecated! Use the following instead: FOREACH_CLIENT(IS_SPEC(it), { code; });
36 // NOTE: FOR_EACH_OBSERVER deprecated! Use the following instead: FOREACH_CLIENT(IS_OBSERVER(it), { code; });
37 // NOTE: FOR_EACH_REALPLAYER deprecated! Use the following instead: FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), { code; });
38 
39 #define FOREACH_CLIENTSLOT(cond, body) \
40  MACRO_BEGIN \
41  for(int _i = 1; _i <= maxclients; ++_i) \
42  { \
43  const noref int i = _i; \
44  ITER_CONST noref entity it = ftoe(i); \
45  if(cond) { LAMBDA(body) } \
46  } \
47  MACRO_END
48 
49 #define FOREACH_CLIENT(cond, body) FOREACH_CLIENTSLOT(IS_CLIENT(it) && (cond), LAMBDA(body))
50 
51 // using the "inside out" version of knuth-fisher-yates shuffle
52 // https://en.wikipedia.org/wiki/Fisher–Yates_shuffle
54 bool _FCR_entered = false;
55 #define FOREACH_CLIENT_RANDOM(cond, body) \
56  MACRO_BEGIN \
57  if (_FCR_entered) LOG_FATAL("FOREACH_CLIENT_RANDOM must not be nested"); \
58  _FCR_entered = true; \
59  int _cnt = 0; \
60  FOREACH_CLIENT(cond, { \
61  int _j = floor(random() * (_cnt + 1)); \
62  if (_j != _cnt) \
63  _FCR_clients[_cnt] = _FCR_clients[_j]; \
64  _FCR_clients[_j] = it; \
65  ++_cnt; \
66  }); \
67  for (int _i = 0; _i < _cnt; ++_i) \
68  { \
69  const noref int i = _i; \
70  ITER_CONST noref entity it = _FCR_clients[i]; \
71  if (cond) { LAMBDA(body) } \
72  } \
73  _FCR_entered = false; \
74  MACRO_END
75 
76 // NOTE: FOR_EACH_MONSTER deprecated! Use the following instead: IL_EACH(g_monsters, true, { code; });
const string STR_SPECTATOR
Definition: utils.qh:6
entity() spawn
entity _FCR_clients[255]
Definition: utils.qh:53
const string STR_OBSERVER
Definition: utils.qh:7
const string STR_PLAYER
Definition: utils.qh:5
bool _FCR_entered
Definition: utils.qh:54
int maxclients
Definition: utils.qh:3