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