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