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