Merge branch 'Mario/qc_updates' into TimePath/csqc_prediction
[xonotic/xonotic-data.pk3dir.git] / qcsrc / common / constants.qh
1 #ifndef CONSTANTS_H
2 #define CONSTANTS_H
3
4 // COMMIT-TODO: Update if necessary before committing
5 // Revision 1: additional statistics sent (flag caps, returns, deaths)
6 // Revision 2: Mapvote preview pictures
7 // Revision 3: optimized map vote protocol
8 // Revision 4: CSQC config var system
9 // Revision 5: mapvote time fix
10 // Revision 6: more robust against packet loss/delays, also show not yet connected clients
11 // Revision 7: packet loss column
12 // Revision 8: race
13 // Revision 9: race delta
14 // Revision 10: scoreboard force
15 // Revision 11: scoreboard unforce; spectator support beginning
16 // Revision 12: smaller scores updates (SERVER: requires new engine)
17 // Revision 13: pointparticles
18 // Revision 14: laser
19 // Revision 15: zoom
20 // Revision 16: multi-weapons
21 // Revision 17: multi-weaponimpulses
22 // Revision 18: warmup
23 // Revision 19: fog
24 // Revision 20: naggers
25 // Revision 21: entcs for players optimized (position data down from 12 to 7 bytes); waypointsprites in csqc for team radar
26 // Revision 22: hook shot origin
27 #define CSQC_REVISION 22
28
29 const int AS_STRING = 1;
30 const int AS_INT = 2;
31 const int AS_FLOAT_TRUNCATED = 2;
32 const int AS_FLOAT = 8;
33
34 const int TE_CSQC_PICTURE = 100;
35 const int TE_CSQC_RACE = 101;
36 const int TE_CSQC_VORTEXBEAMPARTICLE = 103;
37 const int TE_CSQC_ARC = 104;
38 const int TE_CSQC_TEAMNAGGER = 105;
39 const int TE_CSQC_PINGPLREPORT = 106;
40 const int TE_CSQC_TARGET_MUSIC = 107;
41 const int TE_CSQC_WEAPONCOMPLAIN = 108;
42 const int TE_CSQC_VORTEX_SCOPE = 109;
43 const int TE_CSQC_MINELAYER_MAXMINES = 110;
44 const int TE_CSQC_HAGAR_MAXROCKETS = 111;
45 const int TE_CSQC_VEHICLESETUP = 112;
46 const int TE_CSQC_SVNOTICE = 113;
47 const int TE_CSQC_SHOCKWAVEPARTICLE = 114;
48
49 const int RACE_NET_CHECKPOINT_HIT_QUALIFYING = 0; // byte checkpoint, short time, short recordtime, string recordholder
50 const int RACE_NET_CHECKPOINT_CLEAR = 1;
51 const int RACE_NET_CHECKPOINT_NEXT_QUALIFYING = 2; // byte nextcheckpoint, short recordtime, string recordholder
52 const int RACE_NET_CHECKPOINT_HIT_RACE = 3; // byte checkpoint, short delta, byte lapsdelta, string opponent
53 const int RACE_NET_CHECKPOINT_HIT_RACE_BY_OPPONENT = 4; // byte checkpoint, short delta, byte lapsdelta, string opponent
54 const int RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING = 5; // byte nextcheckpoint, float laptime, short recordtime, string recordholder
55 const int RACE_NET_PENALTY_RACE = 6; // byte penaltytime, string reason
56 const int RACE_NET_PENALTY_QUALIFYING = 7; // byte penaltytime, string reason
57 const int RACE_NET_SERVER_RECORD = 8; // server record, sent to client
58 const int RACE_NET_SPEED_AWARD = 9; // speed award, sent to client
59 const int RACE_NET_SPEED_AWARD_BEST = 10; // all time best speed award, sent to client
60 const int RACE_NET_SERVER_RANKINGS = 11;
61 const int RACE_NET_SERVER_STATUS = 12;
62 const int RANKINGS_CNT = 15;
63
64 const int ENT_CLIENT = 0;
65 const int ENT_CLIENT_DEAD = 1;
66 const int ENT_CLIENT_ENTCS = 2;
67 const int ENT_CLIENT_SCORES_INFO = 3;
68 const int ENT_CLIENT_SCORES = 4;
69 const int ENT_CLIENT_TEAMSCORES = 5;
70 const int ENT_CLIENT_POINTPARTICLES = 6;
71 const int ENT_CLIENT_RAINSNOW = 7;
72 const int ENT_CLIENT_LASER = 8;
73 const int ENT_CLIENT_NAGGER = 9; // flags [votecalledvote]
74 const int ENT_CLIENT_WAYPOINT = 10; // flags origin [team displayrule] [spritename] [spritename2] [spritename3] [lifetime maxdistance hideable]
75 const int ENT_CLIENT_RADARLINK = 11; // flags [startorigin] [endorigin] [startcolor+16*endcolor]
76 const int ENT_CLIENT_PROJECTILE = 12;
77 const int ENT_CLIENT_GIBSPLASH = 13;
78 const int ENT_CLIENT_DAMAGEINFO = 14;
79 const int ENT_CLIENT_CASING = 15;
80 const int ENT_CLIENT_INIT = 16;
81 const int ENT_CLIENT_MAPVOTE = 17;
82 const int ENT_CLIENT_CLIENTDATA = 18;
83 const int ENT_CLIENT_RANDOMSEED = 19;
84 const int ENT_CLIENT_WALL = 20;
85 const int ENT_CLIENT_SPIDERBOT = 21;
86 const int ENT_CLIENT_MODELEFFECT = 22;
87 const int ENT_CLIENT_TUBANOTE = 23;
88 const int ENT_CLIENT_WARPZONE = 24;
89 const int ENT_CLIENT_WARPZONE_CAMERA = 25;
90 const int ENT_CLIENT_TRIGGER_MUSIC = 26;
91 const int ENT_CLIENT_HOOK = 27;
92 const int ENT_CLIENT_ARC_BEAM = 29; // WEAPONTODO: fix numbers
93 const int ENT_CLIENT_ACCURACY = 30;
94 const int ENT_CLIENT_SHOWNAMES = 31;
95 const int ENT_CLIENT_WARPZONE_TELEPORTED = 32;
96 const int ENT_CLIENT_MODEL = 33;
97 const int ENT_CLIENT_ITEM = 34;
98 const int ENT_CLIENT_BUMBLE_RAYGUN = 35;
99 const int ENT_CLIENT_SPAWNPOINT = 36;
100 const int ENT_CLIENT_SPAWNEVENT = 37;
101 const int ENT_CLIENT_NOTIFICATION = 38;
102 const int ENT_CLIENT_ELIMINATEDPLAYERS = 39;
103 const int ENT_CLIENT_TURRET = 40;
104 const int ENT_CLIENT_AUXILIARYXHAIR = 50;
105 const int ENT_CLIENT_VEHICLE = 60;
106 const int ENT_CLIENT_LADDER = 61;
107 const int ENT_CLIENT_TRIGGER_PUSH = 62;
108 const int ENT_CLIENT_TARGET_PUSH = 63;
109 const int ENT_CLIENT_CONVEYOR = 64;
110
111 const int ENT_CLIENT_HEALING_ORB = 80;
112
113 const int SPRITERULE_DEFAULT = 0;
114 const int SPRITERULE_TEAMPLAY = 1;
115
116 const int RADARICON_NONE = 0;
117 const int RADARICON_FLAG = 1;
118 const int RADARICON_FLAGCARRIER = 1;
119 const int RADARICON_HERE = 1; // TODO make these 3 and 4, and make images for them
120 const int RADARICON_DANGER = 1;
121 const int RADARICON_WAYPOINT = 1;
122 const int RADARICON_HELPME = 1;
123 const int RADARICON_CONTROLPOINT = 1;
124 const int RADARICON_GENERATOR = 1;
125 const int RADARICON_OBJECTIVE = 1;
126 const int RADARICON_DOMPOINT = 1;
127 const int RADARICON_POWERUP = 1;
128 const int RADARICON_TAGGED = 1;
129
130 ///////////////////////////
131 // keys pressed
132 const int KEY_FORWARD = 1;
133 const int KEY_BACKWARD = 2;
134 const int KEY_LEFT = 4;
135 const int KEY_RIGHT = 8;
136 const int KEY_JUMP = 16;
137 const int KEY_CROUCH = 32;
138 const int KEY_ATCK = 64;
139 const int KEY_ATCK2 = 128;
140
141 ///////////////////////////
142 // cvar constants
143
144 const int CVAR_SAVE = 1;
145 const int CVAR_NOTIFY = 2;
146 const int CVAR_READONLY = 4;
147
148 ///////////////////////////
149 // csqc communication stuff
150
151 const int CTF_STATE_ATTACK = 1;
152 const int CTF_STATE_DEFEND = 2;
153 const int CTF_STATE_COMMANDER = 3;
154
155 const int HUD_NORMAL = 0;
156 const int HUD_VEHICLE_FIRST = 10;
157 const int HUD_SPIDERBOT = 10;
158 const int HUD_WAKIZASHI = 11;
159 const int HUD_RAPTOR = 12;
160 const int HUD_BUMBLEBEE = 13;
161 const int HUD_BUMBLEBEE_GUN = 14;
162 const int HUD_VEHICLE_LAST = 14;
163
164 const vector eX = '1 0 0';
165 const vector eY = '0 1 0';
166 const vector eZ = '0 0 1';
167
168 // moved that here so the client knows the max.
169 // # of maps, I'll use arrays for them :P
170 const int MAPVOTE_COUNT = 30;
171
172 /**
173  * Lower scores are better (e.g. suicides)
174  */
175 const int SFL_LOWER_IS_BETTER = 1;
176
177 /**
178  * Don't show zero values as scores
179  */
180 const int SFL_HIDE_ZERO = 2;
181
182 /**
183  * Allow a column to be hidden (do not automatically add it even if it is a sorting key)
184  */
185 const int SFL_ALLOW_HIDE = 16;
186
187 /**
188  * Display as a rank (with st, nd, rd, th suffix)
189  */
190 const int SFL_RANK = 32;
191
192 /**
193  * Display as mm:ss.s, value is stored as 10ths of a second (AND 0 is the worst possible value!)
194  */
195 const int SFL_TIME = 64;
196
197 // not an extra constant yet
198 #define SFL_ZERO_IS_WORST SFL_TIME
199
200 /**
201  * Scoring priority (NOTE: PRIMARY is used for fraglimit)
202  */
203 const int SFL_SORT_PRIO_SECONDARY = 4;
204 const int SFL_SORT_PRIO_PRIMARY = 8;
205 const int SFL_SORT_PRIO_MASK = 12;
206
207 /**
208  * Score indices
209  */
210 #define MAX_SCORE 10
211 #define MAX_TEAMSCORE 2
212
213 const int ST_SCORE = 0;
214 const int SP_KILLS = 0;
215 const int SP_DEATHS = 1;
216 const int SP_SUICIDES = 2;
217 const int SP_SCORE = 3;
218 // game mode specific indices are not in common/, but in server/scores_rules.qc!
219
220 const int CH_INFO = 0;
221 const int CH_TRIGGER = -3;
222 const int CH_WEAPON_A = -1;
223 const int CH_WEAPON_SINGLE = 1;
224 const int CH_VOICE = -2;
225 const int CH_BGM_SINGLE = 8;
226 const int CH_AMBIENT = -9;
227 const int CH_TRIGGER_SINGLE = 3;
228 const int CH_SHOTS = -4;
229 const int CH_SHOTS_SINGLE = 4;
230 const int CH_WEAPON_B = -1;
231 const int CH_PAIN = -6;
232 const int CH_PAIN_SINGLE = 6;
233 const int CH_PLAYER = -7;
234 const int CH_PLAYER_SINGLE = 7;
235 const int CH_TUBA_SINGLE = 5;
236
237 const float ATTEN_NONE = 0;
238 const float ATTEN_MIN = 0.015625;
239 const float ATTEN_NORM = 0.5;
240 const float ATTEN_LARGE = 1;
241 const float ATTEN_IDLE = 2;
242 const float ATTEN_STATIC = 3;
243 const float ATTEN_MAX = 3.984375;
244
245 const float VOL_BASE = 0.7;
246 const float VOL_BASEVOICE = 1.0;
247
248 // WEAPONTODO: move this into separate/new projectile handling code // this sets sounds and other properties of the projectiles in csqc
249 const int PROJECTILE_ELECTRO = 1;
250 const int PROJECTILE_ROCKET = 2;
251 const int PROJECTILE_TAG = 3;
252 const int PROJECTILE_CRYLINK = 5;
253 const int PROJECTILE_ELECTRO_BEAM = 6;
254 const int PROJECTILE_GRENADE = 7;
255 const int PROJECTILE_GRENADE_BOUNCING = 8;
256 const int PROJECTILE_MINE = 9;
257 const int PROJECTILE_BLASTER = 10;
258 const int PROJECTILE_HLAC = 11;
259 const int PROJECTILE_SEEKER = 12;
260 const int PROJECTILE_FLAC = 13;
261 const int PROJECTILE_PORTO_RED = 14;
262 const int PROJECTILE_PORTO_BLUE = 15;
263 const int PROJECTILE_HOOKBOMB = 16;
264 const int PROJECTILE_HAGAR = 17;
265 const int PROJECTILE_HAGAR_BOUNCING = 18;
266 const int PROJECTILE_CRYLINK_BOUNCING = 20;
267 const int PROJECTILE_FIREBALL = 21;
268 const int PROJECTILE_FIREMINE = 22;
269
270 const int PROJECTILE_RAPTORCANNON = 24;
271 const int PROJECTILE_RAPTORBOMB = 25;
272 const int PROJECTILE_RAPTORBOMBLET = 26;
273 const int PROJECTILE_SPIDERROCKET = 27;
274 const int PROJECTILE_WAKIROCKET = 28;
275 const int PROJECTILE_WAKICANNON = 29;
276
277 const int PROJECTILE_BUMBLE_GUN = 30;
278 const int PROJECTILE_BUMBLE_BEAM = 31;
279
280 const int PROJECTILE_MAGE_SPIKE = 32;
281 const int PROJECTILE_SHAMBLER_LIGHTNING = 33;
282
283 const int PROJECTILE_RPC = 60;
284
285 const int SPECIES_HUMAN = 0;
286 const int SPECIES_ROBOT_SOLID = 1;
287 const int SPECIES_ALIEN = 2;
288 const int SPECIES_ANIMAL = 3;
289 const int SPECIES_ROBOT_RUSTY = 4;
290 const int SPECIES_ROBOT_SHINY = 5;
291 const int SPECIES_RESERVED = 15;
292
293 const int FRAGS_PLAYER = 0;
294 const int FRAGS_SPECTATOR = -666;
295 const int FRAGS_LMS_LOSER = -616;
296 const int FRAGS_PLAYER_NONSOLID = -616;
297 // we can use this frags value for both
298
299 // water levels
300 const int WATERLEVEL_NONE = 0;
301 const int WATERLEVEL_WETFEET = 1;
302 const int WATERLEVEL_SWIMMING = 2;
303 const int WATERLEVEL_SUBMERGED = 3;
304 const int SERVERFLAG_ALLOW_FULLBRIGHT = 1;
305 const int SERVERFLAG_TEAMPLAY = 2;
306 const int SERVERFLAG_PLAYERSTATS = 4;
307
308 // FIXME/EXPLAINME: why?
309 vector autocvar_sv_player_maxs = '16 16 45';
310 vector autocvar_sv_player_mins = '-16 -16 -24';
311 vector autocvar_sv_player_viewoffset = '0 0 20';
312 vector autocvar_sv_player_crouch_maxs = '16 16 25';
313 vector autocvar_sv_player_crouch_mins = '-16 -16 -24';
314 vector autocvar_sv_player_crouch_viewoffset = '0 0 20';
315 vector autocvar_sv_player_headsize = '24 24 12';
316
317 #define PL_VIEW_OFS autocvar_sv_player_viewoffset
318 #define PL_MIN autocvar_sv_player_mins
319 #define PL_MAX autocvar_sv_player_maxs
320 #define PL_CROUCH_VIEW_OFS autocvar_sv_player_crouch_viewoffset
321 #define PL_CROUCH_MIN autocvar_sv_player_crouch_mins
322 #define PL_CROUCH_MAX autocvar_sv_player_crouch_maxs
323 #define PL_HEAD autocvar_sv_player_headsize
324
325 // helpers
326 #define PL_VIEW_OFS_z autocvar_sv_player_viewoffset.z
327 #define PL_MIN_z autocvar_sv_player_mins.z
328 #define PL_MAX_z autocvar_sv_player_maxs.z
329 #define PL_CROUCH_VIEW_OFS_z autocvar_sv_player_crouch_viewoffset.z
330 #define PL_CROUCH_MIN_z autocvar_sv_player_mins.z
331 #define PL_HEAD_x autocvar_sv_player_headsize.x
332 #define PL_HEAD_y autocvar_sv_player_headsize.y
333 #define PL_HEAD_z autocvar_sv_player_headsize.z
334
335 // spawnpoint prios
336 const int SPAWN_PRIO_NEAR_TEAMMATE_FOUND = 200;
337 const int SPAWN_PRIO_NEAR_TEAMMATE_SAMETEAM = 100;
338 const int SPAWN_PRIO_RACE_PREVIOUS_SPAWN = 50;
339 const int SPAWN_PRIO_GOOD_DISTANCE = 10;
340
341 // URI handles
342 const int URI_GET_DISCARD = 0;
343 const int URI_GET_IPBAN = 1;
344 const int URI_GET_IPBAN_END = 16;
345 const int URI_GET_CURL = 17;
346 const int URI_GET_CURL_END = 32;
347 const int URI_GET_UPDATENOTIFICATION = 33;
348 const int URI_GET_URLLIB = 128;
349 const int URI_GET_URLLIB_END = 191;
350
351 // gametype votes
352 const int GTV_AVAILABLE = 0;
353 // for later use in per-map gametype filtering
354 const int GTV_FORBIDDEN = 2;
355 #endif