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