Merge branch 'master' into Mario/buffs
[xonotic/xonotic-data.pk3dir.git] / qcsrc / common / constants.qh
1 // COMMIT-TODO: Update if necessary before committing
2 // Revision 1: additional statistics sent (flag caps, returns, deaths)
3 // Revision 2: Mapvote preview pictures
4 // Revision 3: optimized map vote protocol
5 // Revision 4: CSQC config var system
6 // Revision 5: mapvote time fix
7 // Revision 6: more robust against packet loss/delays, also show not yet connected clients
8 // Revision 7: packet loss column
9 // Revision 8: race
10 // Revision 9: race delta
11 // Revision 10: scoreboard force
12 // Revision 11: scoreboard unforce; spectator support beginning
13 // Revision 12: smaller scores updates (SERVER: requires new engine)
14 // Revision 13: pointparticles
15 // Revision 14: laser
16 // Revision 15: zoom
17 // Revision 16: multi-weapons
18 // Revision 17: multi-weaponimpulses
19 // Revision 18: warmup
20 // Revision 19: fog
21 // Revision 20: naggers
22 // Revision 21: entcs for players optimized (position data down from 12 to 7 bytes); waypointsprites in csqc for team radar
23 // Revision 22: hook shot origin
24 #define CSQC_REVISION 22
25
26 const float AS_STRING = 1;
27 const float AS_INT = 2;
28 const float AS_FLOAT_TRUNCATED = 2;
29 const float AS_FLOAT = 8;
30
31 const float TE_CSQC_PICTURE = 100;
32 const float TE_CSQC_RACE = 101;
33 const float TE_CSQC_NEXGUNBEAMPARTICLE = 103;
34 const float TE_CSQC_LIGHTNINGARC = 104;
35 const float TE_CSQC_TEAMNAGGER = 105;
36 const float TE_CSQC_PINGPLREPORT = 106;
37 const float TE_CSQC_TARGET_MUSIC = 107;
38 const float TE_CSQC_WEAPONCOMPLAIN = 108;
39 const float TE_CSQC_NEX_SCOPE = 109;
40 const float TE_CSQC_MINELAYER_MAXMINES = 110;
41 const float TE_CSQC_HAGAR_MAXROCKETS = 111;
42 const float TE_CSQC_VEHICLESETUP = 112;
43 const float TE_CSQC_SVNOTICE = 113;
44
45 const float RACE_NET_CHECKPOINT_HIT_QUALIFYING = 0; // byte checkpoint, short time, short recordtime, string recordholder
46 const float RACE_NET_CHECKPOINT_CLEAR = 1;
47 const float RACE_NET_CHECKPOINT_NEXT_QUALIFYING = 2; // byte nextcheckpoint, short recordtime, string recordholder
48 const float RACE_NET_CHECKPOINT_HIT_RACE = 3; // byte checkpoint, short delta, byte lapsdelta, string opponent
49 const float RACE_NET_CHECKPOINT_HIT_RACE_BY_OPPONENT = 4; // byte checkpoint, short delta, byte lapsdelta, string opponent
50 const float RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING = 5; // byte nextcheckpoint, float laptime, short recordtime, string recordholder
51 const float RACE_NET_PENALTY_RACE = 6; // byte penaltytime, string reason
52 const float RACE_NET_PENALTY_QUALIFYING = 7; // byte penaltytime, string reason
53 const float RACE_NET_SERVER_RECORD = 8; // server record, sent to client
54 const float RACE_NET_SPEED_AWARD = 9; // speed award, sent to client
55 const float RACE_NET_SPEED_AWARD_BEST = 10; // all time best speed award, sent to client
56 const float RACE_NET_SERVER_RANKINGS = 11;
57 const float RACE_NET_SERVER_STATUS = 12;
58 const float RANKINGS_CNT = 15;
59
60 const float ENT_CLIENT = 0;
61 const float ENT_CLIENT_DEAD = 1;
62 const float ENT_CLIENT_ENTCS = 2;
63 const float ENT_CLIENT_SCORES_INFO = 3;
64 const float ENT_CLIENT_SCORES = 4;
65 const float ENT_CLIENT_TEAMSCORES = 5;
66 const float ENT_CLIENT_POINTPARTICLES = 6;
67 const float ENT_CLIENT_RAINSNOW = 7;
68 const float ENT_CLIENT_LASER = 8;
69 const float ENT_CLIENT_NAGGER = 9; // flags [votecalledvote]
70 const float ENT_CLIENT_WAYPOINT = 10; // flags origin [team displayrule] [spritename] [spritename2] [spritename3] [lifetime maxdistance hideable]
71 const float ENT_CLIENT_RADARLINK = 11; // flags [startorigin] [endorigin] [startcolor+16*endcolor]
72 const float ENT_CLIENT_PROJECTILE = 12;
73 const float ENT_CLIENT_GIBSPLASH = 13;
74 const float ENT_CLIENT_DAMAGEINFO = 14;
75 const float ENT_CLIENT_CASING = 15;
76 const float ENT_CLIENT_INIT = 16;
77 const float ENT_CLIENT_MAPVOTE = 17;
78 const float ENT_CLIENT_CLIENTDATA = 18;
79 const float ENT_CLIENT_RANDOMSEED = 19;
80 const float ENT_CLIENT_WALL = 20;
81 const float ENT_CLIENT_SPIDERBOT = 21;
82 const float ENT_CLIENT_MODELEFFECT = 22;
83 const float ENT_CLIENT_TUBANOTE = 23;
84 const float ENT_CLIENT_WARPZONE = 24;
85 const float ENT_CLIENT_WARPZONE_CAMERA = 25;
86 const float ENT_CLIENT_TRIGGER_MUSIC = 26;
87 const float ENT_CLIENT_HOOK = 27;
88 const float ENT_CLIENT_LGBEAM = 28;
89 const float ENT_CLIENT_GAUNTLET = 29;
90 const float ENT_CLIENT_ACCURACY = 30;
91 const float ENT_CLIENT_SHOWNAMES = 31;
92 const float ENT_CLIENT_WARPZONE_TELEPORTED = 32;
93 const float ENT_CLIENT_MODEL = 33;
94 const float ENT_CLIENT_ITEM = 34;
95 const float ENT_CLIENT_BUMBLE_RAYGUN = 35;
96 const float ENT_CLIENT_SPAWNPOINT = 36;
97 const float ENT_CLIENT_SPAWNEVENT = 37;
98 const float ENT_CLIENT_NOTIFICATION = 38;
99
100 const float ENT_CLIENT_TURRET = 40;
101 const float ENT_CLIENT_AUXILIARYXHAIR = 50;
102 const float ENT_CLIENT_VEHICLE = 60;
103
104 const float SPRITERULE_DEFAULT = 0;
105 const float SPRITERULE_TEAMPLAY = 1;
106
107 const float RADARICON_NONE = 0;
108 const float RADARICON_FLAG = 1;
109 const float RADARICON_FLAGCARRIER = 1;
110 const float RADARICON_HERE = 1; // TODO make these 3 and 4, and make images for them
111 const float RADARICON_DANGER = 1;
112 const float RADARICON_WAYPOINT = 1;
113 const float RADARICON_HELPME = 1;
114 const float RADARICON_CONTROLPOINT = 1;
115 const float RADARICON_GENERATOR = 1;
116 const float RADARICON_OBJECTIVE = 1;
117 const float RADARICON_DOMPOINT = 1;
118 const float RADARICON_POWERUP = 1;
119 const float RADARICON_TAGGED = 1;
120
121 ///////////////////////////
122 // keys pressed
123 const float KEY_FORWARD = 1;
124 const float KEY_BACKWARD = 2;
125 const float KEY_LEFT = 4;
126 const float KEY_RIGHT = 8;
127 const float KEY_JUMP = 16;
128 const float KEY_CROUCH = 32;
129 const float KEY_ATCK = 64;
130 const float KEY_ATCK2 = 128;
131
132 ///////////////////////////
133 // cvar constants
134
135 const float CVAR_SAVE = 1;
136 const float CVAR_NOTIFY = 2;
137 const float CVAR_READONLY = 4;
138
139 ///////////////////////////
140 // csqc communication stuff
141
142 const float STAT_KH_KEYS = 32;
143 const float STAT_CTF_STATE = 33;
144 const float STAT_WEAPONS = 35;
145 const float STAT_SWITCHWEAPON = 36;
146 const float STAT_GAMESTARTTIME = 37;
147 const float STAT_STRENGTH_FINISHED = 38;
148 const float STAT_INVINCIBLE_FINISHED = 39;
149 const float STAT_PRESSED_KEYS = 42;
150 const float STAT_ALLOW_OLDNEXBEAM = 43; // this stat could later contain some other bits of info, like, more server-side particle config
151 const float STAT_FUEL = 44;
152 const float STAT_NB_METERSTART = 45;
153 const float STAT_SHOTORG = 46; // compressShotOrigin
154 const float STAT_LEADLIMIT = 47;
155 const float STAT_WEAPON_CLIPLOAD = 48;
156 const float STAT_WEAPON_CLIPSIZE = 49;
157 const float STAT_NEX_CHARGE = 50;
158 const float STAT_LAST_PICKUP = 51;
159 const float STAT_HUD = 52;
160 const float STAT_NEX_CHARGEPOOL = 53;
161 const float STAT_HIT_TIME = 54;
162 const float STAT_TYPEHIT_TIME = 55;
163 const float STAT_LAYED_MINES = 56;
164 const float STAT_HAGAR_LOAD = 57;
165 const float STAT_SWITCHINGWEAPON = 58;
166 const float STAT_SUPERWEAPONS_FINISHED = 59;
167
168 const float STAT_VEHICLESTAT_HEALTH = 60;
169 const float STAT_VEHICLESTAT_SHIELD = 61;
170 const float STAT_VEHICLESTAT_ENERGY = 62;
171 const float STAT_VEHICLESTAT_AMMO1 = 63;
172 const float STAT_VEHICLESTAT_RELOAD1 = 64;
173 const float STAT_VEHICLESTAT_AMMO2 = 65;
174 const float STAT_VEHICLESTAT_RELOAD2 = 66;
175
176 const float STAT_SECRETS_TOTAL = 70;
177 const float STAT_SECRETS_FOUND = 71;
178
179 const float STAT_RESPAWN_TIME = 72;
180 const float STAT_ROUNDSTARTTIME = 73;
181
182 const float STAT_WEAPONS2 = 74;
183 const float STAT_WEAPONS3 = 75;
184
185 const float STAT_MONSTERS_TOTAL = 76;
186 const float STAT_MONSTERS_KILLED = 77;
187
188 const float STAT_BUFFS = 78;
189
190 // mod stats (1xx)
191 const float STAT_REDALIVE = 100;
192 const float STAT_BLUEALIVE = 101;
193 const float STAT_YELLOWALIVE = 102;
194 const float STAT_PINKALIVE = 103;
195
196 // freeze tag
197 const float STAT_FROZEN = 104;
198 const float STAT_REVIVE_PROGRESS = 105;
199
200 // domination
201 const float STAT_DOM_TOTAL_PPS = 100;
202 const float STAT_DOM_PPS_RED = 101;
203 const float STAT_DOM_PPS_BLUE = 102;
204 const float STAT_DOM_PPS_PINK = 103;
205 const float STAT_DOM_PPS_YELLOW = 104;
206
207 //const float STAT_SPIDERBOT_AIM 53 // compressShotOrigin
208 //const float STAT_SPIDERBOT_TARGET 54 // compressShotOrigin
209
210 // see DP source, quakedef.h
211 const float STAT_MOVEVARS_AIRSPEEDLIMIT_NONQW = 222;
212 const float STAT_MOVEVARS_AIRSTRAFEACCEL_QW = 223;
213 const float STAT_MOVEVARS_MAXSPEED = 244;
214 const float STAT_MOVEVARS_AIRACCEL_QW = 254;
215
216 const float CTF_STATE_ATTACK = 1;
217 const float CTF_STATE_DEFEND = 2;
218 const float CTF_STATE_COMMANDER = 3;
219
220 const float HUD_NORMAL = 0;
221 const float HUD_VEHICLE_FIRST = 10;
222 const float HUD_SPIDERBOT = 10;
223 const float HUD_WAKIZASHI = 11;
224 const float HUD_RAPTOR = 12;
225 const float HUD_BUMBLEBEE = 13;
226 const float HUD_BUMBLEBEE_GUN = 14;
227 const float HUD_VEHICLE_LAST = 14;
228
229 const vector eX = '1 0 0';
230 const vector eY = '0 1 0';
231 const vector eZ = '0 0 1';
232
233 // moved that here so the client knows the max.
234 // # of maps, I'll use arrays for them :P
235 #define MAPVOTE_COUNT 10
236
237 /**
238  * Lower scores are better (e.g. suicides)
239  */
240 #define SFL_LOWER_IS_BETTER 1
241
242 /**
243  * Don't show zero values as scores
244  */
245 #define SFL_HIDE_ZERO 2
246
247 /**
248  * Allow a column to be hidden (do not automatically add it even if it is a sorting key)
249  */
250 #define SFL_ALLOW_HIDE 16
251
252 /**
253  * Display as a rank (with st, nd, rd, th suffix)
254  */
255 #define SFL_RANK 32
256
257 /**
258  * Display as mm:ss.s, value is stored as 10ths of a second (AND 0 is the worst possible value!)
259  */
260 #define SFL_TIME 64
261
262 // not an extra constant yet
263 #define SFL_ZERO_IS_WORST SFL_TIME
264
265 /**
266  * Scoring priority (NOTE: PRIMARY is used for fraglimit)
267  */
268 #define SFL_SORT_PRIO_SECONDARY 4
269 #define SFL_SORT_PRIO_PRIMARY 8
270 #define SFL_SORT_PRIO_MASK 12
271
272 /**
273  * Score indices
274  */
275 #define MAX_SCORE 10
276 #define MAX_TEAMSCORE 2
277
278 #define ST_SCORE 0
279 #define SP_KILLS 0
280 #define SP_DEATHS 1
281 #define SP_SUICIDES 2
282 #define SP_SCORE 3
283 // game mode specific indices are not in common/, but in server/scores_rules.qc!
284
285 const float CH_INFO = 0;
286 const float CH_TRIGGER = -3;
287 const float CH_WEAPON_A = -1;
288 const float CH_WEAPON_SINGLE = 1;
289 const float CH_VOICE = -2;
290 const float CH_BGM_SINGLE = 8;
291 const float CH_AMBIENT = -9;
292 const float CH_TRIGGER_SINGLE = 3;
293 const float CH_SHOTS = -4;
294 const float CH_SHOTS_SINGLE = 4;
295 const float CH_WEAPON_B = -1;
296 const float CH_PAIN = -6;
297 const float CH_PAIN_SINGLE = 6;
298 const float CH_PLAYER = -7;
299 const float CH_PLAYER_SINGLE = 7;
300 const float CH_TUBA_SINGLE = 5;
301
302 const float ATTEN_NONE = 0;
303 const float ATTEN_MIN = 0.015625;
304 const float ATTEN_NORM = 0.5;
305 const float ATTEN_LARGE = 1;
306 const float ATTEN_IDLE = 2;
307 const float ATTEN_STATIC = 3;
308 const float ATTEN_MAX = 3.984375;
309
310 #define VOL_BASE 0.7
311 #define VOL_BASEVOICE 1.0
312
313 // this sets sounds and other properties of the projectiles in csqc
314 const float PROJECTILE_ELECTRO = 1;
315 const float PROJECTILE_ROCKET = 2;
316 const float PROJECTILE_TAG = 3;
317 const float PROJECTILE_CRYLINK = 5;
318 const float PROJECTILE_ELECTRO_BEAM = 6;
319 const float PROJECTILE_GRENADE = 7;
320 const float PROJECTILE_GRENADE_BOUNCING = 8;
321 const float PROJECTILE_MINE = 9;
322 const float PROJECTILE_LASER = 10;
323 const float PROJECTILE_HLAC = 11;
324 const float PROJECTILE_SEEKER = 12;
325 const float PROJECTILE_FLAC = 13;
326 const float PROJECTILE_PORTO_RED = 14;
327 const float PROJECTILE_PORTO_BLUE = 15;
328 const float PROJECTILE_HOOKBOMB = 16;
329 const float PROJECTILE_HAGAR = 17;
330 const float PROJECTILE_HAGAR_BOUNCING = 18;
331 const float PROJECTILE_CRYLINK_BOUNCING = 20;
332 const float PROJECTILE_FIREBALL = 21;
333 const float PROJECTILE_FIREMINE = 22;
334
335 const float PROJECTILE_RAPTORCANNON = 24;
336 const float PROJECTILE_RAPTORBOMB = 25;
337 const float PROJECTILE_RAPTORBOMBLET = 26;
338 const float PROJECTILE_SPIDERROCKET = 27;
339 const float PROJECTILE_WAKIROCKET = 28;
340 const float PROJECTILE_WAKICANNON = 29;
341
342 const float PROJECTILE_BUMBLE_GUN = 30;
343 const float PROJECTILE_BUMBLE_BEAM = 31;
344
345 const float PROJECTILE_MAGE_SPIKE = 32;
346 const float PROJECTILE_SHAMBLER_LIGHTNING = 33;
347
348 const float PROJECTILE_NADE_RED = 50;
349 const float PROJECTILE_NADE_RED_BURN = 51;
350 const float PROJECTILE_NADE_BLUE = 52;
351 const float PROJECTILE_NADE_BLUE_BURN = 53;
352 const float PROJECTILE_NADE_YELLOW = 54;
353 const float PROJECTILE_NADE_YELLOW_BURN = 55;
354 const float PROJECTILE_NADE_PINK = 56;
355 const float PROJECTILE_NADE_PINK_BURN = 57;
356 const float PROJECTILE_NADE = 58;
357 const float PROJECTILE_NADE_BURN = 59;
358
359 const float SPECIES_HUMAN = 0;
360 const float SPECIES_ROBOT_SOLID = 1;
361 const float SPECIES_ALIEN = 2;
362 const float SPECIES_ANIMAL = 3;
363 const float SPECIES_ROBOT_RUSTY = 4;
364 const float SPECIES_ROBOT_SHINY = 5;
365 const float SPECIES_RESERVED = 15;
366
367 #define FRAGS_PLAYER 0
368 #define FRAGS_SPECTATOR -666
369 #define FRAGS_LMS_LOSER -616
370 #define FRAGS_PLAYER_NONSOLID -616
371 // we can use this frags value for both
372
373 // water levels
374 const float WATERLEVEL_NONE = 0;
375 const float WATERLEVEL_WETFEET = 1;
376 const float WATERLEVEL_SWIMMING = 2;
377 const float WATERLEVEL_SUBMERGED = 3;
378
379 const float MAX_SHOT_DISTANCE = 32768;
380
381 // weapon requests
382 const float WR_SETUP = 1; // (SVQC) setup weapon data
383 const float WR_THINK = 2; // (SVQC) logic to run every frame
384 const float WR_CHECKAMMO1 = 3; // (SVQC) checks ammo for weapon
385 const float WR_CHECKAMMO2 = 4; // (SVQC) checks ammo for weapon
386 const float WR_AIM = 5; // (SVQC) runs bot aiming code for this weapon
387 const float WR_PRECACHE = 6; // (CSQC and SVQC) precaches models/sounds used by this weapon
388 const float WR_SUICIDEMESSAGE = 7; // (SVQC) notification number for suicide message (may inspect w_deathtype for details)
389 const float WR_KILLMESSAGE = 8; // (SVQC) notification number for kill message (may inspect w_deathtype for details)
390 const float WR_RELOAD = 9; // (SVQC) does not need to do anything
391 const float WR_RESETPLAYER = 10; // (SVQC) does not need to do anything
392 const float WR_IMPACTEFFECT = 11; // (CSQC) impact effect
393 const float WR_SWITCHABLE = 12; // (CSQC) impact effect
394 const float WR_PLAYERDEATH = 13; // (SVQC) does not need to do anything
395 const float WR_GONETHINK = 14; // (SVQC) logic to run every frame, also if no longer having the weapon as long as the switch away has not been performed
396
397 #define SERVERFLAG_ALLOW_FULLBRIGHT 1
398 #define SERVERFLAG_TEAMPLAY 2
399 #define SERVERFLAG_PLAYERSTATS 4
400
401 // FIXME/EXPLAINME: why?
402 noref var vector autocvar_sv_player_maxs = '16 16 45';
403 noref var vector autocvar_sv_player_mins = '-16 -16 -24';
404 noref var vector autocvar_sv_player_viewoffset = '0 0 20';
405 noref var vector autocvar_sv_player_crouch_maxs = '16 16 25';
406 noref var vector autocvar_sv_player_crouch_mins = '-16 -16 -24';
407 noref var vector autocvar_sv_player_crouch_viewoffset = '0 0 20';
408 noref var vector autocvar_sv_player_headsize = '24 24 12';
409
410 #define PL_VIEW_OFS autocvar_sv_player_viewoffset
411 #define PL_MIN autocvar_sv_player_mins
412 #define PL_MAX autocvar_sv_player_maxs
413 #define PL_CROUCH_VIEW_OFS autocvar_sv_player_crouch_viewoffset
414 #define PL_CROUCH_MIN autocvar_sv_player_crouch_mins
415 #define PL_CROUCH_MAX autocvar_sv_player_crouch_maxs
416 #define PL_HEAD autocvar_sv_player_headsize
417
418 // helpers
419 #define PL_VIEW_OFS_z autocvar_sv_player_viewoffset_z
420 #define PL_MIN_z autocvar_sv_player_mins_z
421 #define PL_MAX_z autocvar_sv_player_maxs_z
422 #define PL_CROUCH_VIEW_OFS_z autocvar_sv_player_crouch_viewoffset_z
423 #define PL_CROUCH_MIN_z autocvar_sv_player_mins_z
424 #define PL_HEAD_x autocvar_sv_player_headsize_x
425 #define PL_HEAD_y autocvar_sv_player_headsize_y
426 #define PL_HEAD_z autocvar_sv_player_headsize_z
427
428 // spawnpoint prios
429 #define SPAWN_PRIO_NEAR_TEAMMATE_FOUND 200
430 #define SPAWN_PRIO_NEAR_TEAMMATE_SAMETEAM 100
431 #define SPAWN_PRIO_RACE_PREVIOUS_SPAWN 50
432 #define SPAWN_PRIO_GOOD_DISTANCE 10
433
434 // URI handles
435 #define URI_GET_DISCARD 0
436 #define URI_GET_IPBAN 1
437 #define URI_GET_IPBAN_END 16
438 #define URI_GET_CURL 17
439 #define URI_GET_CURL_END 32
440 #define URI_GET_UPDATENOTIFICATION 33
441 #define URI_GET_URLLIB 128
442 #define URI_GET_URLLIB_END 191