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