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