Radar icons: fix colour
[xonotic/xonotic-data.pk3dir.git] / qcsrc / common / constants.qh
1 #ifndef CONSTANTS_H
2 #define CONSTANTS_H
3
4 // COMMIT-TODO: Update if necessary before committing
5 // Revision 1: additional statistics sent (flag caps, returns, deaths)
6 // Revision 2: Mapvote preview pictures
7 // Revision 3: optimized map vote protocol
8 // Revision 4: CSQC config var system
9 // Revision 5: mapvote time fix
10 // Revision 6: more robust against packet loss/delays, also show not yet connected clients
11 // Revision 7: packet loss column
12 // Revision 8: race
13 // Revision 9: race delta
14 // Revision 10: scoreboard force
15 // Revision 11: scoreboard unforce; spectator support beginning
16 // Revision 12: smaller scores updates (SERVER: requires new engine)
17 // Revision 13: pointparticles
18 // Revision 14: laser
19 // Revision 15: zoom
20 // Revision 16: multi-weapons
21 // Revision 17: multi-weaponimpulses
22 // Revision 18: warmup
23 // Revision 19: fog
24 // Revision 20: naggers
25 // Revision 21: entcs for players optimized (position data down from 12 to 7 bytes); waypointsprites in csqc for team radar
26 // Revision 22: hook shot origin
27 #define CSQC_REVISION 22
28
29 const int AS_STRING = 1;
30 const int AS_INT = 2;
31 const int AS_FLOAT_TRUNCATED = 2;
32 const int AS_FLOAT = 8;
33
34 const int TE_CSQC_MUTATOR = 99;
35 #define MUTATOR_HASH(s) crc16(true, s)
36 #define WriteMutator(to, s) do { \
37     WriteByte(to, TE_CSQC_MUTATOR); \
38     WriteLong(to, MUTATOR_HASH(#s)); \
39 } while (0)
40 #define ReadMutator() ReadLong()
41 #define ReadMutatorEquals(read, s) (read == MUTATOR_HASH(#s))
42 const int TE_CSQC_PICTURE = 100;
43 const int TE_CSQC_RACE = 101;
44 const int TE_CSQC_VORTEXBEAMPARTICLE = 103;
45 const int TE_CSQC_ARC = 104;
46 const int TE_CSQC_TEAMNAGGER = 105;
47 const int TE_CSQC_PINGPLREPORT = 106;
48 const int TE_CSQC_TARGET_MUSIC = 107;
49 const int TE_CSQC_WEAPONCOMPLAIN = 108;
50 const int TE_CSQC_VORTEX_SCOPE = 109;
51 const int TE_CSQC_MINELAYER_MAXMINES = 110;
52 const int TE_CSQC_HAGAR_MAXROCKETS = 111;
53 const int TE_CSQC_VEHICLESETUP = 112;
54 const int TE_CSQC_SVNOTICE = 113;
55 const int TE_CSQC_SHOCKWAVEPARTICLE = 114;
56
57 const int RACE_NET_CHECKPOINT_HIT_QUALIFYING = 0; // byte checkpoint, short time, short recordtime, string recordholder
58 const int RACE_NET_CHECKPOINT_CLEAR = 1;
59 const int RACE_NET_CHECKPOINT_NEXT_QUALIFYING = 2; // byte nextcheckpoint, short recordtime, string recordholder
60 const int RACE_NET_CHECKPOINT_HIT_RACE = 3; // byte checkpoint, short delta, byte lapsdelta, string opponent
61 const int RACE_NET_CHECKPOINT_HIT_RACE_BY_OPPONENT = 4; // byte checkpoint, short delta, byte lapsdelta, string opponent
62 const int RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING = 5; // byte nextcheckpoint, float laptime, short recordtime, string recordholder
63 const int RACE_NET_PENALTY_RACE = 6; // byte penaltytime, string reason
64 const int RACE_NET_PENALTY_QUALIFYING = 7; // byte penaltytime, string reason
65 const int RACE_NET_SERVER_RECORD = 8; // server record, sent to client
66 const int RACE_NET_SPEED_AWARD = 9; // speed award, sent to client
67 const int RACE_NET_SPEED_AWARD_BEST = 10; // all time best speed award, sent to client
68 const int RACE_NET_SERVER_RANKINGS = 11;
69 const int RACE_NET_SERVER_STATUS = 12;
70 const int RANKINGS_CNT = 15;
71
72 const int ENT_CLIENT = 0;
73 const int ENT_CLIENT_DEAD = 1;
74 const int ENT_CLIENT_ENTCS = 2;
75 const int ENT_CLIENT_SCORES_INFO = 3;
76 const int ENT_CLIENT_SCORES = 4;
77 const int ENT_CLIENT_TEAMSCORES = 5;
78 const int ENT_CLIENT_POINTPARTICLES = 6;
79 const int ENT_CLIENT_RAINSNOW = 7;
80 const int ENT_CLIENT_LASER = 8;
81 const int ENT_CLIENT_NAGGER = 9; // flags [votecalledvote]
82 const int ENT_CLIENT_RADARLINK = 11; // flags [startorigin] [endorigin] [startcolor+16*endcolor]
83 const int ENT_CLIENT_PROJECTILE = 12;
84 const int ENT_CLIENT_GIBSPLASH = 13;
85 const int ENT_CLIENT_DAMAGEINFO = 14;
86 const int ENT_CLIENT_INIT = 16;
87 const int ENT_CLIENT_MAPVOTE = 17;
88 const int ENT_CLIENT_CLIENTDATA = 18;
89 const int ENT_CLIENT_RANDOMSEED = 19;
90 const int ENT_CLIENT_WALL = 20;
91 const int ENT_CLIENT_SPIDERBOT = 21;
92 const int ENT_CLIENT_MODELEFFECT = 22;
93 const int ENT_CLIENT_TUBANOTE = 23;
94 const int ENT_CLIENT_WARPZONE = 24;
95 const int ENT_CLIENT_WARPZONE_CAMERA = 25;
96 const int ENT_CLIENT_TRIGGER_MUSIC = 26;
97 const int ENT_CLIENT_HOOK = 27;
98 const int ENT_CLIENT_INVENTORY = 28;
99 const int ENT_CLIENT_ARC_BEAM = 29; // WEAPONTODO: fix numbers
100 const int ENT_CLIENT_ACCURACY = 30;
101 const int ENT_CLIENT_SHOWNAMES = 31;
102 const int ENT_CLIENT_WARPZONE_TELEPORTED = 32;
103 const int ENT_CLIENT_MODEL = 33;
104 const int ENT_CLIENT_ITEM = 34;
105 const int ENT_CLIENT_BUMBLE_RAYGUN = 35;
106 const int ENT_CLIENT_SPAWNPOINT = 36;
107 const int ENT_CLIENT_SPAWNEVENT = 37;
108 const int ENT_CLIENT_NOTIFICATION = 38;
109 const int ENT_CLIENT_ELIMINATEDPLAYERS = 39;
110 const int ENT_CLIENT_TURRET = 40;
111 const int ENT_CLIENT_AUXILIARYXHAIR = 50;
112 const int ENT_CLIENT_VEHICLE = 60;
113 const int ENT_CLIENT_LADDER = 61;
114 const int ENT_CLIENT_TRIGGER_PUSH = 62;
115 const int ENT_CLIENT_TARGET_PUSH = 63;
116 const int ENT_CLIENT_CONVEYOR = 64;
117 const int ENT_CLIENT_DOOR = 65;
118 const int ENT_CLIENT_TRAIN = 66;
119 const int ENT_CLIENT_PLAT = 67;
120 const int ENT_CLIENT_TRIGGER_IMPULSE = 68;
121 const int ENT_CLIENT_SWAMP = 69;
122 const int ENT_CLIENT_CORNER = 70;
123 const int ENT_CLIENT_KEYLOCK = 71;
124 const int ENT_CLIENT_GENERATOR = 72;
125 const int ENT_CLIENT_CONTROLPOINT_ICON = 73;
126 const int ENT_CLIENT_EFFECT = 74;
127 const int ENT_CLIENT_MINIGAME = 75;
128 const int ENT_CLIENT_VIEWLOC = 78;
129 const int ENT_CLIENT_VIEWLOC_TRIGGER = 79;
130
131 const int ENT_CLIENT_MUTATOR = TE_CSQC_MUTATOR; // 99
132
133 const int SPRITERULE_DEFAULT = 0;
134 const int SPRITERULE_TEAMPLAY = 1;
135 const int SPRITERULE_SPECTATOR = 2;
136
137 ///////////////////////////
138 // keys pressed
139 const int KEY_FORWARD = 1;
140 const int KEY_BACKWARD = 2;
141 const int KEY_LEFT = 4;
142 const int KEY_RIGHT = 8;
143 const int KEY_JUMP = 16;
144 const int KEY_CROUCH = 32;
145 const int KEY_ATCK = 64;
146 const int KEY_ATCK2 = 128;
147
148 ///////////////////////////
149 // cvar constants
150
151 const int CVAR_SAVE = 1;
152 const int CVAR_NOTIFY = 2;
153 const int CVAR_READONLY = 4;
154
155 ///////////////////////////
156 // csqc communication stuff
157
158 const int CTF_STATE_ATTACK = 1;
159 const int CTF_STATE_DEFEND = 2;
160 const int CTF_STATE_COMMANDER = 3;
161
162 const int HUD_NORMAL = 0;
163 const int HUD_BUMBLEBEE_GUN = 25;
164
165 // moved that here so the client knows the max.
166 // # of maps, I'll use arrays for them :P
167 const int MAPVOTE_COUNT = 30;
168
169 /**
170  * Lower scores are better (e.g. suicides)
171  */
172 const int SFL_LOWER_IS_BETTER = 1;
173
174 /**
175  * Don't show zero values as scores
176  */
177 const int SFL_HIDE_ZERO = 2;
178
179 /**
180  * Allow a column to be hidden (do not automatically add it even if it is a sorting key)
181  */
182 const int SFL_ALLOW_HIDE = 16;
183
184 /**
185  * Display as a rank (with st, nd, rd, th suffix)
186  */
187 const int SFL_RANK = 32;
188
189 /**
190  * Display as mm:ss.s, value is stored as 10ths of a second (AND 0 is the worst possible value!)
191  */
192 const int SFL_TIME = 64;
193
194 // not an extra constant yet
195 #define SFL_ZERO_IS_WORST SFL_TIME
196
197 /**
198  * Scoring priority (NOTE: PRIMARY is used for fraglimit)
199  */
200 const int SFL_SORT_PRIO_SECONDARY = 4;
201 const int SFL_SORT_PRIO_PRIMARY = 8;
202 const int SFL_SORT_PRIO_MASK = 12;
203
204 /**
205  * Score indices
206  */
207 #define MAX_SCORE 10
208 #define MAX_TEAMSCORE 2
209
210 const int ST_SCORE = 0;
211 const int SP_KILLS = 0;
212 const int SP_DEATHS = 1;
213 const int SP_SUICIDES = 2;
214 const int SP_SCORE = 3;
215 // game mode specific indices are not in common/, but in server/scores_rules.qc!
216
217 const int CH_INFO = 0;
218 const int CH_TRIGGER = -3;
219 const int CH_WEAPON_A = -1;
220 const int CH_WEAPON_SINGLE = 1;
221 const int CH_VOICE = -2;
222 const int CH_BGM_SINGLE = 8;
223 const int CH_AMBIENT = -9;
224 const int CH_TRIGGER_SINGLE = 3;
225 const int CH_SHOTS = -4;
226 const int CH_SHOTS_SINGLE = 4;
227 const int CH_WEAPON_B = -1;
228 const int CH_PAIN = -6;
229 const int CH_PAIN_SINGLE = 6;
230 const int CH_PLAYER = -7;
231 const int CH_PLAYER_SINGLE = 7;
232 const int CH_TUBA_SINGLE = 5;
233
234 const float ATTEN_NONE = 0;
235 const float ATTEN_MIN = 0.015625;
236 const float ATTEN_NORM = 0.5;
237 const float ATTEN_LARGE = 1;
238 const float ATTEN_IDLE = 2;
239 const float ATTEN_STATIC = 3;
240 const float ATTEN_MAX = 3.984375;
241
242 const float VOL_BASE = 0.7;
243 const float VOL_BASEVOICE = 1.0;
244
245 // WEAPONTODO: move this into separate/new projectile handling code // this sets sounds and other properties of the projectiles in csqc
246 const int PROJECTILE_ELECTRO = 1;
247 const int PROJECTILE_ROCKET = 2;
248 const int PROJECTILE_TAG = 3;
249 const int PROJECTILE_CRYLINK = 5;
250 const int PROJECTILE_ELECTRO_BEAM = 6;
251 const int PROJECTILE_GRENADE = 7;
252 const int PROJECTILE_GRENADE_BOUNCING = 8;
253 const int PROJECTILE_MINE = 9;
254 const int PROJECTILE_BLASTER = 10;
255 const int PROJECTILE_HLAC = 11;
256 const int PROJECTILE_SEEKER = 12;
257 const int PROJECTILE_FLAC = 13;
258 const int PROJECTILE_PORTO_RED = 14;
259 const int PROJECTILE_PORTO_BLUE = 15;
260 const int PROJECTILE_HOOKBOMB = 16;
261 const int PROJECTILE_HAGAR = 17;
262 const int PROJECTILE_HAGAR_BOUNCING = 18;
263 const int PROJECTILE_CRYLINK_BOUNCING = 20;
264 const int PROJECTILE_FIREBALL = 21;
265 const int PROJECTILE_FIREMINE = 22;
266
267 const int PROJECTILE_RAPTORCANNON = 24;
268 const int PROJECTILE_RAPTORBOMB = 25;
269 const int PROJECTILE_RAPTORBOMBLET = 26;
270 const int PROJECTILE_SPIDERROCKET = 27;
271 const int PROJECTILE_WAKIROCKET = 28;
272 const int PROJECTILE_WAKICANNON = 29;
273
274 const int PROJECTILE_BUMBLE_GUN = 30;
275 const int PROJECTILE_BUMBLE_BEAM = 31;
276
277 const int PROJECTILE_MAGE_SPIKE = 32;
278 const int PROJECTILE_SHAMBLER_LIGHTNING = 33;
279
280 const int PROJECTILE_ROCKETMINSTA_LASER = 34;
281
282 // projectile IDs 40-50 reserved
283
284 const int PROJECTILE_RPC = 60;
285
286 const int SPECIES_HUMAN = 0;
287 const int SPECIES_ROBOT_SOLID = 1;
288 const int SPECIES_ALIEN = 2;
289 const int SPECIES_ANIMAL = 3;
290 const int SPECIES_ROBOT_RUSTY = 4;
291 const int SPECIES_ROBOT_SHINY = 5;
292 const int SPECIES_RESERVED = 15;
293
294 const int FRAGS_PLAYER = 0;
295 const int FRAGS_SPECTATOR = -666;
296 const int FRAGS_LMS_LOSER = -616;
297 const int FRAGS_PLAYER_NONSOLID = -616;
298 // we can use this frags value for both
299
300 // water levels
301 const int WATERLEVEL_NONE = 0;
302 const int WATERLEVEL_WETFEET = 1;
303 const int WATERLEVEL_SWIMMING = 2;
304 const int WATERLEVEL_SUBMERGED = 3;
305 const int SERVERFLAG_ALLOW_FULLBRIGHT = 1;
306 const int SERVERFLAG_TEAMPLAY = 2;
307 const int SERVERFLAG_PLAYERSTATS = 4;
308
309 // FIXME/EXPLAINME: why? Mario: because
310 vector autocvar_sv_player_maxs = '16 16 45';
311 vector autocvar_sv_player_mins = '-16 -16 -24';
312 vector autocvar_sv_player_viewoffset = '0 0 20';
313 vector autocvar_sv_player_crouch_maxs = '16 16 25';
314 vector autocvar_sv_player_crouch_mins = '-16 -16 -24';
315 vector autocvar_sv_player_crouch_viewoffset = '0 0 20';
316 vector autocvar_sv_player_headsize = '24 24 12';
317
318
319 // not so constant
320 #ifdef SVQC
321 #define PL_VIEW_OFS autocvar_sv_player_viewoffset
322 #define PL_MIN autocvar_sv_player_mins
323 #define PL_MAX autocvar_sv_player_maxs
324 #define PL_CROUCH_VIEW_OFS autocvar_sv_player_crouch_viewoffset
325 #define PL_CROUCH_MIN autocvar_sv_player_crouch_mins
326 #define PL_CROUCH_MAX autocvar_sv_player_crouch_maxs
327 #define PL_HEAD autocvar_sv_player_headsize
328 #elif defined(CSQC)
329 #define PL_VIEW_OFS vec3(getstatf(STAT_PL_VIEW_OFS1), getstatf(STAT_PL_VIEW_OFS2), getstatf(STAT_PL_VIEW_OFS3))
330 #define PL_MIN vec3(getstatf(STAT_PL_MIN1), getstatf(STAT_PL_MIN2), getstatf(STAT_PL_MIN3))
331 #define PL_MAX vec3(getstatf(STAT_PL_MAX1), getstatf(STAT_PL_MAX2), getstatf(STAT_PL_MAX3))
332 #define PL_CROUCH_VIEW_OFS vec3(getstatf(STAT_PL_CROUCH_VIEW_OFS1), getstatf(STAT_PL_CROUCH_VIEW_OFS2), getstatf(STAT_PL_CROUCH_VIEW_OFS3))
333 #define PL_CROUCH_MIN vec3(getstatf(STAT_PL_CROUCH_MIN1), getstatf(STAT_PL_CROUCH_MIN2), getstatf(STAT_PL_CROUCH_MIN3))
334 #define PL_CROUCH_MAX vec3(getstatf(STAT_PL_CROUCH_MAX1), getstatf(STAT_PL_CROUCH_MAX2), getstatf(STAT_PL_CROUCH_MAX3))
335 #endif
336
337 // a bit more constant
338 const vector PL_MAX_CONST = '16 16 45';
339 const vector PL_MIN_CONST = '-16 -16 -24';
340
341 // spawnpoint prios
342 const int SPAWN_PRIO_NEAR_TEAMMATE_FOUND = 200;
343 const int SPAWN_PRIO_NEAR_TEAMMATE_SAMETEAM = 100;
344 const int SPAWN_PRIO_RACE_PREVIOUS_SPAWN = 50;
345 const int SPAWN_PRIO_GOOD_DISTANCE = 10;
346
347 // gametype vote flags
348 const int GTV_FORBIDDEN = 0; // Cannot be voted
349 const int GTV_AVAILABLE = 1; // Can be voted
350 const int GTV_CUSTOM    = 2; // Custom entry
351 #endif