Merge commit 'origin/master' into divVerent/tag_seeker
[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 // probably put these in common/
27 // so server/ and client/ can be synced better
28 const float GAME_DEATHMATCH             = 1;
29 const float GAME_TEAM_DEATHMATCH        = 2;
30 const float GAME_DOMINATION             = 3;
31 const float GAME_CTF                    = 4;
32 const float GAME_RUNEMATCH              = 5;
33 const float GAME_LMS                    = 6;
34 const float GAME_ARENA          = 7;
35 const float GAME_KEYHUNT                = 8;
36 const float GAME_ASSAULT                = 9;
37 const float GAME_ONSLAUGHT      = 10;
38 const float GAME_RACE   = 11;
39 const float GAME_NEXBALL = 12;
40 const float GAME_CTS = 13;
41 const float GAME_CA             = 14;
42
43 const float AS_STRING           = 1;
44 const float AS_INT              = 2;
45 const float AS_FLOAT_TRUNCATED  = 2;
46 const float AS_FLOAT            = 8;
47
48 const float TE_CSQC_PICTURE = 100;
49 const float TE_CSQC_RACE = 101;
50 const float TE_CSQC_SPAWN = 102;
51 const float TE_CSQC_ZCURVEPARTICLES = 103;
52 const float TE_CSQC_NEXGUNBEAMPARTICLE = 104;
53 const float TE_CSQC_LIGHTNINGARC = 105;
54 const float TE_CSQC_TEAMNAGGER = 106;
55 const float TE_CSQC_PINGPLREPORT = 107;
56 const float TE_CSQC_VOTE = 108;
57 const float TE_CSQC_VOTERESET = 109;
58 const float TE_CSQC_ANNOUNCE = 110;
59 const float TE_CSQC_TARGET_MUSIC = 111;
60
61 const float RACE_NET_CHECKPOINT_HIT_QUALIFYING = 0; // byte checkpoint, short time, short recordtime, string recordholder
62 const float RACE_NET_CHECKPOINT_CLEAR = 1;
63 const float RACE_NET_CHECKPOINT_NEXT_QUALIFYING = 2; // byte nextcheckpoint, short recordtime, string recordholder
64 const float RACE_NET_CHECKPOINT_HIT_RACE = 3; // byte checkpoint, short delta, byte lapsdelta, string opponent
65 const float RACE_NET_CHECKPOINT_HIT_RACE_BY_OPPONENT = 4; // byte checkpoint, short delta, byte lapsdelta, string opponent
66 const float RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING = 5; // byte nextcheckpoint, float laptime, short recordtime, string recordholder
67 const float RACE_NET_PENALTY_RACE = 6; // byte penaltytime, string reason
68 const float RACE_NET_PENALTY_QUALIFYING = 7; // byte penaltytime, string reason
69 const float RACE_NET_SERVER_RECORD = 8; // server record, sent to client
70 const float RACE_NET_SPEED_AWARD = 9; // speed award, sent to client
71 const float RACE_NET_SPEED_AWARD_BEST = 10; // all time best speed award, sent to client
72 const float RACE_NET_SERVER_RANKINGS = 11;
73 const float RACE_NET_SERVER_STATUS = 12;
74 const float RANKINGS_CNT = 15;
75
76 const float ENT_CLIENT = 0;
77 const float ENT_CLIENT_DEAD = 1;
78 const float ENT_CLIENT_ENTCS = 2;
79 const float ENT_CLIENT_SCORES_INFO = 3;
80 const float ENT_CLIENT_SCORES = 4;
81 const float ENT_CLIENT_TEAMSCORES = 5;
82 const float ENT_CLIENT_POINTPARTICLES = 6;
83 const float ENT_CLIENT_RAINSNOW = 7;
84 const float ENT_CLIENT_LASER = 8;
85 const float ENT_CLIENT_NAGGER = 9; // flags [votecalledvote]
86 const float ENT_CLIENT_WAYPOINT = 10; // flags origin [team displayrule] [spritename] [spritename2] [spritename3] [lifetime maxdistance hideable]
87 const float ENT_CLIENT_RADARLINK = 11; // flags [startorigin] [endorigin] [startcolor+16*endcolor]
88 const float ENT_CLIENT_PROJECTILE = 12;
89 const float ENT_CLIENT_GIBSPLASH = 13;
90 const float ENT_CLIENT_DAMAGEINFO = 14;
91 const float ENT_CLIENT_CASING = 15;
92 const float ENT_CLIENT_INIT = 16;
93 const float ENT_CLIENT_MAPVOTE = 17;
94 const float ENT_CLIENT_CLIENTDATA = 18;
95 const float ENT_CLIENT_RANDOMSEED = 19;
96 const float ENT_CLIENT_WALL = 20;
97 const float ENT_CLIENT_SPIDERBOT = 21;
98 const float ENT_CLIENT_MODELEFFECT = 22;
99 const float ENT_CLIENT_TUBANOTE = 23;
100 const float ENT_CLIENT_WARPZONE = 24;
101 const float ENT_CLIENT_WARPZONE_CAMERA = 25;
102 const float ENT_CLIENT_TRIGGER_MUSIC = 26;
103
104 const float ENT_CLIENT_TURRET = 40;
105
106 const float SPRITERULE_DEFAULT = 0;
107 const float SPRITERULE_TEAMPLAY = 1;
108
109 const float RADARICON_FLAG = 1;
110 const float RADARICON_FLAGCARRIER = 1;
111 const float RADARICON_HERE = 1; // TODO make these 3 and 4, and make images for them
112 const float RADARICON_DANGER = 1;
113 const float RADARICON_WAYPOINT = 1;
114 const float RADARICON_HELPME = 1;
115 const float RADARICON_CONTROLPOINT = 1;
116 const float RADARICON_GENERATOR = 1;
117 const float RADARICON_OBJECTIVE = 1;
118 const float RADARICON_DOMPOINT = 1;
119 const float RADARICON_POWERUP = 1;
120
121 ///////////////////////////
122 // key constants
123
124 //
125 // these are the key numbers that should be passed to Key_Event
126 //
127 const float K_TAB                       =       9;
128 const float K_ENTER             =       13;
129 const float K_ESCAPE            =       27;
130 const float K_SPACE             =       32;
131
132 // normal keys should be passed as lowercased ascii
133
134 const float K_BACKSPACE =       127;
135 const float K_UPARROW           =       128;
136 const float K_DOWNARROW =       129;
137 const float K_LEFTARROW =       130;
138 const float K_RIGHTARROW        =       131;
139
140 const float K_ALT               =       132;
141 const float K_CTRL      =       133;
142 const float K_SHIFT     =       134;
143 const float K_F1                =       135;
144 const float K_F2                =       136;
145 const float K_F3                =       137;
146 const float K_F4                =       138;
147 const float K_F5                =       139;
148 const float K_F6                =       140;
149 const float K_F7                =       141;
150 const float K_F8                =       142;
151 const float K_F9                =       143;
152 const float K_F10               =       144;
153 const float K_F11               =       145;
154 const float K_F12               =       146;
155 const float K_INS               =       147;
156 const float K_DEL               =       148;
157 const float K_PGDN      =       149;
158 const float K_PGUP      =       150;
159 const float K_HOME      =       151;
160 const float K_END               =       152;
161
162 const float K_KP_HOME                   =       160;
163 const float K_KP_UPARROW                =       161;
164 const float K_KP_PGUP                   =       162;
165 const float K_KP_LEFTARROW      =       163;
166 const float K_KP_5                      =       164;
167 const float K_KP_RIGHTARROW     =       165;
168 const float K_KP_END                    =       166;
169 const float K_KP_DOWNARROW      =       167;
170 const float K_KP_PGDN                   =       168;
171 const float K_KP_ENTER          =       169;
172 const float K_KP_INS            =       170;
173 const float K_KP_DEL                    =       171;
174 const float K_KP_SLASH          =       172;
175 const float K_KP_MINUS          =       173;
176 const float K_KP_PLUS                   =       174;
177
178 const float K_PAUSE             =       255;
179
180 //
181 // joystick buttons
182 //
183 const float K_JOY1              =       768;
184 const float K_JOY2              =       769;
185 const float K_JOY3              =       770;
186 const float K_JOY4              =       771;
187
188 //
189 // aux keys are for multi-buttoned joysticks to generate so they can use
190 // the normal binding process
191 //
192 const float K_AUX1              =       772;
193 const float K_AUX2              =       773;
194 const float K_AUX3              =       774;
195 const float K_AUX4              =       775;
196 const float K_AUX5              =       776;
197 const float K_AUX6              =       777;
198 const float K_AUX7              =       778;
199 const float K_AUX8              =       779;
200 const float K_AUX9              =       780;
201 const float K_AUX10             =       781;
202 const float K_AUX11             =       782;
203 const float K_AUX12             =       783;
204 const float K_AUX13             =       784;
205 const float K_AUX14             =       785;
206 const float K_AUX15             =       786;
207 const float K_AUX16             =       787;
208 const float K_AUX17             =       788;
209 const float K_AUX18             =       789;
210 const float K_AUX19             =       790;
211 const float K_AUX20             =       791;
212 const float K_AUX21             =       792;
213 const float K_AUX22             =       793;
214 const float K_AUX23             =       794;
215 const float K_AUX24             =       795;
216 const float K_AUX25             =       796;
217 const float K_AUX26             =       797;
218 const float K_AUX27             =       798;
219 const float K_AUX28             =       799;
220 const float K_AUX29             =       800;
221 const float K_AUX30             =       801;
222 const float K_AUX31             =       802;
223 const float K_AUX32             =       803;
224
225 //
226 // mouse buttons generate virtual keys
227 //
228 const float K_MOUSE1            =       512;
229 const float K_MOUSE2            =       513;
230 const float K_MOUSE3            =       514;
231 const float K_MWHEELUP  =       515;
232 const float K_MWHEELDOWN        =       516;
233 const float K_MOUSE4            =       517;
234 const float K_MOUSE5            =       518;
235 const float K_MOUSE6            =       519;
236 const float K_MOUSE7            =       520;
237 const float K_MOUSE8            =       521;
238 const float K_MOUSE9            =       522;
239 const float K_MOUSE10           =       523;
240 const float K_MOUSE11           =       524;
241 const float K_MOUSE12           =       525;
242 const float K_MOUSE13           =       526;
243 const float K_MOUSE14           =       527;
244 const float K_MOUSE15           =       528;
245 const float K_MOUSE16           =       529;
246
247 ///////////////////////////
248 // keys pressed
249 const float KEY_FORWARD         =       1;
250 const float KEY_BACKWARD        =       2;
251 const float KEY_LEFT            =       4;
252 const float KEY_RIGHT           =       8;
253 const float KEY_JUMP            =       16;
254 const float KEY_CROUCH          =       32;
255
256 ///////////////////////////
257 // cvar constants
258
259 float CVAR_SAVE         = 1;
260 float CVAR_NOTIFY       = 2;
261 float CVAR_READONLY     = 4;
262
263 ///////////////////////////
264 // csqc communication stuff
265
266 const float STAT_KH_KEYS = 32;
267 const float STAT_CTF_STATE = 33;
268 const float STAT_WEAPONS = 35;
269 const float STAT_SWITCHWEAPON = 36;
270 const float STAT_GAMESTARTTIME = 37;
271 const float STAT_STRENGTH_FINISHED = 38;
272 const float STAT_INVINCIBLE_FINISHED = 39;
273 const float STAT_DAMAGE_HITS = 40; // Used by the weapon stats code, represents the total amount of damage done to other players
274 const float STAT_DAMAGE_FIRED = 41;// Used by the weapon stats code, represents the total amount of potential damage fired
275 const float STAT_PRESSED_KEYS = 42;
276 const float STAT_ALLOW_OLDNEXBEAM = 43; // this stat could later contain some other bits of info, like, more server-side particle config
277 const float STAT_FUEL = 44;
278 const float STAT_NB_METERSTART = 45;
279 const float STAT_SHOTORG = 46; // compressShotOrigin
280 const float STAT_LEADLIMIT = 47;
281 const float STAT_BULLETS_LOADED = 48;
282 const float CTF_STATE_ATTACK = 1;
283 const float CTF_STATE_DEFEND = 2;
284 const float CTF_STATE_COMMANDER = 3;
285
286 const float STAT_HUD = 50;
287 const float HUD_NORMAL = 0;
288 const float HUD_SPIDERBOT = 10;
289 const float HUD_WAKIZASHI = 11;
290 const float HUD_RAPTOR    = 12;
291
292 const float STAT_VEHICLESTAT_HEALTH  = 60;
293 const float STAT_VEHICLESTAT_SHIELD  = 61;
294 const float STAT_VEHICLESTAT_ENERGY  = 62;
295 const float STAT_VEHICLESTAT_AMMO1   = 63;
296 const float STAT_VEHICLESTAT_RELOAD1 = 64;
297 const float STAT_VEHICLESTAT_AMMO2   = 65;
298 const float STAT_VEHICLESTAT_RELOAD2 = 66;
299
300 //const float STAT_SPIDERBOT_AIM     53 // compressShotOrigin
301 //const float STAT_SPIDERBOT_TARGET  54 // compressShotOrigin
302
303
304
305
306 // moved that here so the client knows the max.
307 // # of maps, I'll use arrays for them :P
308 #define MAPVOTE_COUNT 10
309
310 /**
311  * Lower scores are better (e.g. suicides)
312  */
313 #define SFL_LOWER_IS_BETTER     1
314
315 /**
316  * Don't show zero values as scores
317  */
318 #define SFL_HIDE_ZERO           2
319
320 /**
321  * Allow a column to be hidden (do not automatically add it even if it is a sorting key)
322  */
323 #define SFL_ALLOW_HIDE         16
324
325 /**
326  * Display as a rank (with st, nd, rd, th suffix)
327  */
328 #define SFL_RANK               32
329
330 /**
331  * Display as mm:ss.s, value is stored as 10ths of a second (AND 0 is the worst possible value!)
332  */
333 #define SFL_TIME               64
334
335 // not an extra constant yet
336 #define SFL_ZERO_IS_WORST SFL_TIME
337
338 /**
339  * Scoring priority (NOTE: PRIMARY is used for fraglimit)
340  */
341 #define SFL_SORT_PRIO_SECONDARY 4
342 #define SFL_SORT_PRIO_PRIMARY   8
343 #define SFL_SORT_PRIO_MASK     12
344
345 /**
346  * Score indices
347  */
348 #define MAX_SCORE 10
349 #define MAX_TEAMSCORE 2
350
351 #define ST_SCORE 0
352 #define SP_KILLS 0
353 #define SP_DEATHS 1
354 #define SP_SUICIDES 2
355 #define SP_SCORE 3
356 // game mode specific indices are not in common/, but in server/scores_rules.qc!
357
358 // this assignment must match menu/xonotic/dialog_settings_misc.c!
359 float   CHAN_AUTO                               = 0;
360         // on world: announcers, ...                     INFO
361         // on players: item pickup                       ITEMS
362         // on entities: UNUSED
363         // on csqc: UNUSED
364 float   CHAN_WEAPON                             = 1; // Weapon fire
365         // on world: UNUSED
366         // on players: weapon firing                     WEAPONS
367         // on entities: turret firing                    WEAPONS
368         // on csqc: UNUSED
369 float   CHAN_VOICE                              = 2; // Voice/Radio
370         // on world: UNUSED
371         // on players: voice                             VOICE
372         // on entities: ambient                          AMBIENT
373         // on csqc: background music                     BGM
374 float   CHAN_TRIGGER                    = 3; // Triggers/Items
375         // on world: UNUSED
376         // on players: item pickup                       ITEMS
377         // on entities: platforms moving etc.            ITEMS
378         // on csqc: UNUSED
379 float   CHAN_PROJECTILE                 = 4; // Projectiles
380         // on world: UNUSED
381         // on players: projectiles hitting player        SHOTS
382         // on entities: projectiles                      SHOTS
383         // on csqc: projectile sounds                    SHOTS
384 float   CHAN_WEAPON2                    = 5; // Nex fire (separated as it is a very long sound)
385         // on world: UNUSED
386         // on players: weapon firing                     WEAPONS
387         // on entities: turret firing                    WEAPONS
388         // on csqc: UNUSED
389 float   CHAN_PAIN                               = 6; // Pain
390         // on world: UNUSED
391         // on players: pain                              PAIN
392         // on entities: projectiles flying               SHOTS
393         // on csqc: player pain                          PAIN
394 float   CHAN_PLAYER                             = 7; // Player body
395         // on world: UNUSED
396         // on players: player sounds                     PLAYER
397         // on entities: player sounds                    PLAYER
398         // on csqc: UNUSED
399
400 float   ATTN_NONE                               = 0;
401 float   ATTN_MIN                                = 0.015625;
402 float   ATTN_NORM                               = 0.5;
403 float   ATTN_IDLE                               = 2;
404 float   ATTN_STATIC                             = 3;
405 float   ATTN_MAX                                = 3.984375;
406
407 #define VOL_BASE 0.7
408 #define VOL_BASEVOICE 1.0
409
410 // this sets sounds and other properties of the projectiles in csqc
411 float PROJECTILE_ELECTRO = 1;
412 float PROJECTILE_ROCKET = 2;
413 float PROJECTILE_TAG = 3;
414 float PROJECTILE_BULLET = 4;
415 float PROJECTILE_CRYLINK = 5;
416 float PROJECTILE_ELECTRO_BEAM = 6;
417 float PROJECTILE_GRENADE = 7;
418 float PROJECTILE_GRENADE_BOUNCING = 8;
419 float PROJECTILE_LASER = 9;
420 float PROJECTILE_HLAC = 10;
421 float PROJECTILE_SEEKER = 11;
422 float PROJECTILE_FLAC = 12;
423 float PROJECTILE_PORTO_RED = 13;
424 float PROJECTILE_PORTO_BLUE = 14;
425 float PROJECTILE_HOOKBOMB = 15;
426 float PROJECTILE_HAGAR = 16;
427 float PROJECTILE_HAGAR_BOUNCING = 17;
428 float PROJECTILE_BULLET_GLOWING = 18;
429 float PROJECTILE_CRYLINK_BOUNCING = 19;
430 float PROJECTILE_FIREBALL = 20;
431 float PROJECTILE_FIREMINE = 21;
432 float PROJECTILE_BULLET_GLOWING_TRACER = 22;
433
434 float SPECIES_HUMAN        =  0;
435 float SPECIES_ROBOT_SOLID  =  1;
436 float SPECIES_ALIEN        =  2;
437 float SPECIES_ANIMAL       =  3;
438 float SPECIES_ROBOT_RUSTY  =  4;
439 float SPECIES_ROBOT_SHINY  =  5;
440 float SPECIES_RESERVED     = 15;
441
442 // Deathtypes (weapon deathtypes are the IT_* constants below)
443 // NOTE: when adding death types, please add an explanation to Docs/spamlog.txt too.
444 float DEATH_SPECIAL_START = 10000;
445 float DEATH_FALL = 10000;
446 float DEATH_TELEFRAG = 10001;
447 float DEATH_DROWN = 10002;
448 float DEATH_HURTTRIGGER = 10003;
449 float DEATH_LAVA = 10004;
450 float DEATH_SLIME = 10005;
451 float DEATH_KILL = 10006;
452 float DEATH_NOAMMO = 10007;
453 float DEATH_SWAMP = 10008;
454 float DEATH_TEAMCHANGE = 10009;
455 float DEATH_AUTOTEAMCHANGE = 10010;
456 float DEATH_CAMP = 10011;
457 float DEATH_SHOOTING_STAR = 10012;
458 float DEATH_ROT = 10013;
459 float DEATH_MIRRORDAMAGE = 10014;
460 float DEATH_TOUCHEXPLODE = 10015;
461 float DEATH_CHEAT = 10016;
462 float DEATH_FIRE = 10017;
463 float DEATH_TURRET = 10020;
464 float DEATH_QUIET = 10021;
465
466 float DEATH_SBMINIGUN = 10030;
467 float DEATH_SBROCKET  = 10031;
468 float DEATH_SBCRUSH   = 10032;
469 float DEATH_SBBLOWUP  = 10033;
470
471 float DEATH_WAKIGUN    = 10040;
472 float DEATH_WAKIROCKET = 10041;
473 float DEATH_WAKIBLOWUP = 10042;
474
475 float DEATH_CUSTOM = 10300;
476
477
478 float DEATH_WEAPONMASK = 0xFF;
479 float DEATH_HITTYPEMASK = 0x1F00; // which is WAY below 10000 used for normal deaths
480 float HITTYPE_SECONDARY = 0x100;
481 float HITTYPE_SPLASH = 0x200;
482 float HITTYPE_BOUNCE = 0x400;
483 float HITTYPE_HEADSHOT = 0x800;
484 float HITTYPE_RESERVED = 0x1000; // unused yet
485
486 // macros to access these
487 #define DEATH_ISSPECIAL(t)            ((t) >= DEATH_SPECIAL_START)
488 #define DEATH_WEAPONOFWEAPONDEATH(t)  ((t) & DEATH_WEAPONMASK)
489 #define DEATH_ISWEAPON(t,w)           (!DEATH_ISSPECIAL(t) && DEATH_WEAPONOFWEAPONDEATH(t) == (w))
490 #define DEATH_WEAPONOF(t)             (DEATH_ISSPECIAL(t) ? 0 : DEATH_WEAPONOFWEAPONDEATH(t))
491 #define WEP_VALID(w)                  ((w) >= WEP_FIRST && (w) <= WEP_LAST)
492
493 #define FRAGS_PLAYER 0
494 #define FRAGS_SPECTATOR -666
495 #define FRAGS_LMS_LOSER -616
496 #define FRAGS_PLAYER_NONSOLID -616
497 // we can use this frags value for both
498
499 //misc. stuff
500 #define NEWLINES "\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"
501
502 // water levels
503 float WATERLEVEL_NONE = 0;
504 float WATERLEVEL_WETFEET = 1;
505 float WATERLEVEL_SWIMMING = 2;
506 float WATERLEVEL_SUBMERGED = 3;
507
508 float MAX_SHOT_DISTANCE = 32768;