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