0c5a2644a15d9df30ef640a20d5de7710ede1fa3
[xonotic/xonotic-data.pk3dir.git] / qcsrc / server / miscfunctions.qh
1 #ifndef MISCFUNCTIONS_H
2 #define MISCFUNCTIONS_H
3
4 #include "t_items.qh"
5
6 #include "mutators/events.qh"
7 #include "mutators/gamemode_race.qh"
8
9 #include "../common/constants.qh"
10 #include "../common/mapinfo.qh"
11 #include "../common/turrets/all.qh"
12
13 #ifdef RELEASE
14 #define cvar_string_normal builtin_cvar_string
15 #define cvar_normal builtin_cvar
16 #else
17 string cvar_string_normal(string n)
18 {
19         if (!(cvar_type(n) & CVAR_TYPEFLAG_EXISTS))
20                 backtrace(strcat("Attempt to access undefined cvar: ", n));
21         return builtin_cvar_string(n);
22 }
23
24 float cvar_normal(string n)
25 {
26         return stof(cvar_string_normal(n));
27 }
28 #endif
29 #define cvar_set_normal builtin_cvar_set
30
31 .vector dropped_origin;
32 .void(void) uncustomizeentityforclient;
33 .float uncustomizeentityforclient_set;
34 .float nottargeted;
35
36 entity eliminatedPlayers;
37 void EliminatedPlayers_Init(float(entity) isEliminated_func);
38
39 string admin_name(void);
40
41 void write_recordmarker(entity pl, float tstart, float dt);
42
43 void play2all(string samp);
44
45 void DistributeEvenly_Init(float amount, float totalweight);
46 float DistributeEvenly_Get(float weight);
47
48 void modeleffect_spawn(string m, float s, float f, vector o, vector v, vector ang, vector angv, float s0, float s2, float a, float t1, float t2);
49
50 void shockwave_spawn(string m, vector org, float sz, float t1, float t2);
51
52 void play2team(float t, string filename);
53
54 void GetCvars_handleFloat(string thisname, float f, .float field, string name);
55
56 float spamsound(entity e, float chan, string samp, float vol, float _atten);
57
58 void GetCvars_handleString(string thisname, float f, .string field, string name);
59
60 void precache_all_playermodels(string pattern);
61
62 void soundat(entity e, vector o, float chan, string samp, float vol, float _atten);
63
64 void defer(float fdelay, void() func);
65
66 void UncustomizeEntitiesRun();
67 void InitializeEntitiesRun();
68
69 void stopsoundto(float _dest, entity e, float chan);
70 void soundtoat(float _dest, entity e, vector o, float chan, string samp, float vol, float _atten);
71 float ExponentialFalloff(float mindist, float maxdist, float halflifedist, float d);
72
73 vector shotorg_adjust(vector vecs, float y_is_right, float visual);
74
75 float DistributeEvenly_amount;
76 float DistributeEvenly_totalweight;
77 void objerror(string s);
78 void droptofloor();
79 void() SUB_Remove;
80
81 void attach_sameorigin(entity e, entity to, string tag);
82
83 void crosshair_trace(entity pl);
84
85 void crosshair_trace_plusvisibletriggers(entity pl);
86
87 void detach_sameorigin(entity e);
88
89 void follow_sameorigin(entity e, entity to);
90
91 string formatmessage(string msg);
92
93 void GameLogEcho(string s);
94
95 void GameLogInit();
96
97 void GameLogClose();
98
99 void GetCvars(float f);
100
101 string GetMapname();
102
103 float isPushable(entity e);
104
105 float LostMovetypeFollow(entity ent);
106
107 string uid2name(string myuid);
108
109 float MoveToRandomMapLocation(entity e, float goodcontents, float badcontents, float badsurfaceflags, float attempts, float maxaboveground, float minviewdistance);
110
111 string NearestLocation(vector p);
112
113 void play2(entity e, string filename);
114
115 string playername(entity p);
116
117 void precache();
118
119 void remove_safely(entity e);
120
121 void remove_unsafely(entity e);
122
123 void SetMovetypeFollow(entity ent, entity e);
124
125 vector shotorg_adjust_values(vector vecs, float y_is_right, float visual, float algn);
126
127 void soundto(float dest, entity e, float chan, string samp, float vol, float atten);
128
129 void stopsound(entity e, float chan);
130
131 float tracebox_hits_box(vector start, vector mi, vector ma, vector end, vector thmi, vector thma);
132
133 void traceline_antilag (entity source, vector v1, vector v2, float nomonst, entity forent, float lag);
134
135 void WarpZone_crosshair_trace(entity pl);
136
137 void WarpZone_traceline_antilag (entity source, vector v1, vector v2, float nomonst, entity forent, float lag);
138
139
140 #define ITEM_TOUCH_NEEDKILL() (((trace_dpstartcontents | trace_dphitcontents) & DPCONTENTS_NODROP) || (trace_dphitq3surfaceflags & Q3SURFACEFLAG_SKY))
141 #define ITEM_DAMAGE_NEEDKILL(dt) (((dt) == DEATH_HURTTRIGGER) || ((dt) == DEATH_SLIME) || ((dt) == DEATH_LAVA) || ((dt) == DEATH_SWAMP))
142
143 #define PROJECTILE_TOUCH if(WarpZone_Projectile_Touch()) return
144
145 const string STR_PLAYER = "player";
146 const string STR_SPECTATOR = "spectator";
147 const string STR_OBSERVER = "observer";
148
149 #define IS_PLAYER(v)                    (v.classname == STR_PLAYER)
150 #define IS_SPEC(v)                              (v.classname == STR_SPECTATOR)
151 #define IS_OBSERVER(v)                  (v.classname == STR_OBSERVER)
152 #define IS_CLIENT(v)                    (v.flags & FL_CLIENT)
153 #define IS_BOT_CLIENT(v)                (clienttype(v) == CLIENTTYPE_BOT)
154 #define IS_REAL_CLIENT(v)               (clienttype(v) == CLIENTTYPE_REAL)
155 #define IS_NOT_A_CLIENT(v)              (clienttype(v) == CLIENTTYPE_NOTACLIENT)
156
157 #define IS_MONSTER(v)                   (v.flags & FL_MONSTER)
158 #define IS_VEHICLE(v)                   (v.vehicle_flags & VHF_ISVEHICLE)
159 #define IS_TURRET(v)                    (v.turret_flags & TUR_FLAG_ISTURRET)
160
161 #define FOR_EACH_CLIENTSLOT(v) for(v = world; (v = nextent(v)) && (num_for_edict(v) <= maxclients); )
162 #define FOR_EACH_CLIENT(v) FOR_EACH_CLIENTSLOT(v) if(IS_CLIENT(v))
163 #define FOR_EACH_REALCLIENT(v) FOR_EACH_CLIENT(v) if(IS_REAL_CLIENT(v))
164
165 #define FOR_EACH_PLAYER(v) FOR_EACH_CLIENT(v) if(IS_PLAYER(v))
166 #define FOR_EACH_SPEC(v) FOR_EACH_CLIENT(v) if (!IS_PLAYER(v)) // Samual: shouldn't this be IS_SPEC(v)? and rather create a separate macro to include observers too
167 #define FOR_EACH_REALPLAYER(v) FOR_EACH_REALCLIENT(v) if(IS_PLAYER(v))
168
169 #define FOR_EACH_MONSTER(v) for(v = world; (v = findflags(v, flags, FL_MONSTER)) != world; )
170
171 #define CENTER_OR_VIEWOFS(ent) (ent.origin + (IS_PLAYER(ent) ? ent.view_ofs : ((ent.mins + ent.maxs) * 0.5)))
172
173 // copies a string to a tempstring (so one can strunzone it)
174 string strcat1(string s) = #115; // FRIK_FILE
175
176 float logfile_open;
177 float logfile;
178
179 #define strstr strstrofs
180 /*
181 // NOTE: DO NOT USE THIS FUNCTION TOO OFTEN.
182 // IT WILL MOST PROBABLY DESTROY _ALL_ OTHER TEMP
183 // STRINGS AND TAKE QUITE LONG. haystack and needle MUST
184 // BE CONSTANT OR strzoneD!
185 float strstr(string haystack, string needle, float offset)
186 {
187         float len, endpos;
188         string found;
189         len = strlen(needle);
190         endpos = strlen(haystack) - len;
191         while(offset <= endpos)
192         {
193                 found = substring(haystack, offset, len);
194                 if(found == needle)
195                         return offset;
196                 offset = offset + 1;
197         }
198         return -1;
199 }
200 */
201
202 const float NUM_NEAREST_ENTITIES = 4;
203 entity nearest_entity[NUM_NEAREST_ENTITIES];
204 float nearest_length[NUM_NEAREST_ENTITIES];
205
206
207 //#NO AUTOCVARS START
208
209 float g_pickup_shells;
210 float g_pickup_shells_max;
211 float g_pickup_nails;
212 float g_pickup_nails_max;
213 float g_pickup_rockets;
214 float g_pickup_rockets_max;
215 float g_pickup_cells;
216 float g_pickup_cells_max;
217 float g_pickup_plasma;
218 float g_pickup_plasma_max;
219 float g_pickup_fuel;
220 float g_pickup_fuel_jetpack;
221 float g_pickup_fuel_max;
222 float g_pickup_armorsmall;
223 float g_pickup_armorsmall_max;
224 float g_pickup_armorsmall_anyway;
225 float g_pickup_armormedium;
226 float g_pickup_armormedium_max;
227 float g_pickup_armormedium_anyway;
228 float g_pickup_armorbig;
229 float g_pickup_armorbig_max;
230 float g_pickup_armorbig_anyway;
231 float g_pickup_armorlarge;
232 float g_pickup_armorlarge_max;
233 float g_pickup_armorlarge_anyway;
234 float g_pickup_healthsmall;
235 float g_pickup_healthsmall_max;
236 float g_pickup_healthsmall_anyway;
237 float g_pickup_healthmedium;
238 float g_pickup_healthmedium_max;
239 float g_pickup_healthmedium_anyway;
240 float g_pickup_healthlarge;
241 float g_pickup_healthlarge_max;
242 float g_pickup_healthlarge_anyway;
243 float g_pickup_healthmega;
244 float g_pickup_healthmega_max;
245 float g_pickup_healthmega_anyway;
246 float g_pickup_ammo_anyway;
247 float g_pickup_weapons_anyway;
248 float g_weaponarena;
249 WepSet g_weaponarena_weapons;
250 float g_weaponarena_random;
251 float g_weaponarena_random_with_blaster;
252 string g_weaponarena_list;
253 float g_weaponspeedfactor;
254 float g_weaponratefactor;
255 float g_weapondamagefactor;
256 float g_weaponforcefactor;
257 float g_weaponspreadfactor;
258
259 WepSet start_weapons;
260 WepSet start_weapons_default;
261 WepSet start_weapons_defaultmask;
262 int start_items;
263 float start_ammo_shells;
264 float start_ammo_nails;
265 float start_ammo_rockets;
266 float start_ammo_cells;
267 float start_ammo_plasma;
268 float start_ammo_fuel;
269 float start_health;
270 float start_armorvalue;
271 WepSet warmup_start_weapons;
272 WepSet warmup_start_weapons_default;
273 WepSet warmup_start_weapons_defaultmask;
274 #define WARMUP_START_WEAPONS ((g_warmup_allguns == 1) ? (warmup_start_weapons & (weaponsInMap | start_weapons)) : warmup_start_weapons)
275 float warmup_start_ammo_shells;
276 float warmup_start_ammo_nails;
277 float warmup_start_ammo_rockets;
278 float warmup_start_ammo_cells;
279 float warmup_start_ammo_plasma;
280 float warmup_start_ammo_fuel;
281 float warmup_start_health;
282 float warmup_start_armorvalue;
283 float g_weapon_stay;
284
285 float want_weapon(entity weaponinfo, float allguns); // WEAPONTODO: what still needs done?
286 void readplayerstartcvars();
287
288 float g_bugrigs;
289 float g_bugrigs_planar_movement;
290 float g_bugrigs_planar_movement_car_jumping;
291 float g_bugrigs_reverse_spinning;
292 float g_bugrigs_reverse_speeding;
293 float g_bugrigs_reverse_stopping;
294 float g_bugrigs_air_steering;
295 float g_bugrigs_angle_smoothing;
296 float g_bugrigs_friction_floor;
297 float g_bugrigs_friction_brake;
298 float g_bugrigs_friction_air;
299 float g_bugrigs_accel;
300 float g_bugrigs_speed_ref;
301 float g_bugrigs_speed_pow;
302 float g_bugrigs_steer;
303
304 float sv_autotaunt;
305 float sv_taunt;
306
307 string GetGametype(); // g_world.qc
308 void mutators_add(); // mutators.qc
309 void readlevelcvars(void)
310 {
311         // load mutators
312         mutators_add();
313
314         if(cvar("sv_allow_fullbright"))
315                 serverflags |= SERVERFLAG_ALLOW_FULLBRIGHT;
316
317     g_bugrigs = cvar("g_bugrigs");
318     g_bugrigs_planar_movement = cvar("g_bugrigs_planar_movement");
319     g_bugrigs_planar_movement_car_jumping = cvar("g_bugrigs_planar_movement_car_jumping");
320     g_bugrigs_reverse_spinning = cvar("g_bugrigs_reverse_spinning");
321     g_bugrigs_reverse_speeding = cvar("g_bugrigs_reverse_speeding");
322     g_bugrigs_reverse_stopping = cvar("g_bugrigs_reverse_stopping");
323     g_bugrigs_air_steering = cvar("g_bugrigs_air_steering");
324     g_bugrigs_angle_smoothing = cvar("g_bugrigs_angle_smoothing");
325     g_bugrigs_friction_floor = cvar("g_bugrigs_friction_floor");
326     g_bugrigs_friction_brake = cvar("g_bugrigs_friction_brake");
327     g_bugrigs_friction_air = cvar("g_bugrigs_friction_air");
328     g_bugrigs_accel = cvar("g_bugrigs_accel");
329     g_bugrigs_speed_ref = cvar("g_bugrigs_speed_ref");
330     g_bugrigs_speed_pow = cvar("g_bugrigs_speed_pow");
331     g_bugrigs_steer = cvar("g_bugrigs_steer");
332
333         g_instagib = cvar("g_instagib");
334
335         sv_clones = cvar("sv_clones");
336         sv_foginterval = cvar("sv_foginterval");
337         g_cloaked = cvar("g_cloaked");
338         g_footsteps = cvar("g_footsteps");
339         g_jetpack = cvar("g_jetpack");
340         sv_maxidle = cvar("sv_maxidle");
341         sv_maxidle_spectatorsareidle = cvar("sv_maxidle_spectatorsareidle");
342         sv_autotaunt = cvar("sv_autotaunt");
343         sv_taunt = cvar("sv_taunt");
344
345         warmup_stage = cvar("g_warmup");
346         g_warmup_limit = cvar("g_warmup_limit");
347         g_warmup_allguns = cvar("g_warmup_allguns");
348         g_warmup_allow_timeout = cvar("g_warmup_allow_timeout");
349
350         if ((g_race && g_race_qualifying == 2) || g_assault || cvar("g_campaign"))
351                 warmup_stage = 0; // these modes cannot work together, sorry
352
353         g_pickup_respawntime_weapon = cvar("g_pickup_respawntime_weapon");
354         g_pickup_respawntime_superweapon = cvar("g_pickup_respawntime_superweapon");
355         g_pickup_respawntime_ammo = cvar("g_pickup_respawntime_ammo");
356         g_pickup_respawntime_short = cvar("g_pickup_respawntime_short");
357         g_pickup_respawntime_medium = cvar("g_pickup_respawntime_medium");
358         g_pickup_respawntime_long = cvar("g_pickup_respawntime_long");
359         g_pickup_respawntime_powerup = cvar("g_pickup_respawntime_powerup");
360         g_pickup_respawntimejitter_weapon = cvar("g_pickup_respawntimejitter_weapon");
361         g_pickup_respawntimejitter_superweapon = cvar("g_pickup_respawntimejitter_superweapon");
362         g_pickup_respawntimejitter_ammo = cvar("g_pickup_respawntimejitter_ammo");
363         g_pickup_respawntimejitter_short = cvar("g_pickup_respawntimejitter_short");
364         g_pickup_respawntimejitter_medium = cvar("g_pickup_respawntimejitter_medium");
365         g_pickup_respawntimejitter_long = cvar("g_pickup_respawntimejitter_long");
366         g_pickup_respawntimejitter_powerup = cvar("g_pickup_respawntimejitter_powerup");
367
368         g_weaponspeedfactor = cvar("g_weaponspeedfactor");
369         g_weaponratefactor = cvar("g_weaponratefactor");
370         g_weapondamagefactor = cvar("g_weapondamagefactor");
371         g_weaponforcefactor = cvar("g_weaponforcefactor");
372         g_weaponspreadfactor = cvar("g_weaponspreadfactor");
373
374         g_pickup_shells = cvar("g_pickup_shells");
375         g_pickup_shells_max = cvar("g_pickup_shells_max");
376         g_pickup_nails = cvar("g_pickup_nails");
377         g_pickup_nails_max = cvar("g_pickup_nails_max");
378         g_pickup_rockets = cvar("g_pickup_rockets");
379         g_pickup_rockets_max = cvar("g_pickup_rockets_max");
380         g_pickup_cells = cvar("g_pickup_cells");
381         g_pickup_cells_max = cvar("g_pickup_cells_max");
382         g_pickup_plasma = cvar("g_pickup_plasma");
383         g_pickup_plasma_max = cvar("g_pickup_plasma_max");
384         g_pickup_fuel = cvar("g_pickup_fuel");
385         g_pickup_fuel_jetpack = cvar("g_pickup_fuel_jetpack");
386         g_pickup_fuel_max = cvar("g_pickup_fuel_max");
387         g_pickup_armorsmall = cvar("g_pickup_armorsmall");
388         g_pickup_armorsmall_max = cvar("g_pickup_armorsmall_max");
389         g_pickup_armorsmall_anyway = cvar("g_pickup_armorsmall_anyway");
390         g_pickup_armormedium = cvar("g_pickup_armormedium");
391         g_pickup_armormedium_max = cvar("g_pickup_armormedium_max");
392         g_pickup_armormedium_anyway = cvar("g_pickup_armormedium_anyway");
393         g_pickup_armorbig = cvar("g_pickup_armorbig");
394         g_pickup_armorbig_max = cvar("g_pickup_armorbig_max");
395         g_pickup_armorbig_anyway = cvar("g_pickup_armorbig_anyway");
396         g_pickup_armorlarge = cvar("g_pickup_armorlarge");
397         g_pickup_armorlarge_max = cvar("g_pickup_armorlarge_max");
398         g_pickup_armorlarge_anyway = cvar("g_pickup_armorlarge_anyway");
399         g_pickup_healthsmall = cvar("g_pickup_healthsmall");
400         g_pickup_healthsmall_max = cvar("g_pickup_healthsmall_max");
401         g_pickup_healthsmall_anyway = cvar("g_pickup_healthsmall_anyway");
402         g_pickup_healthmedium = cvar("g_pickup_healthmedium");
403         g_pickup_healthmedium_max = cvar("g_pickup_healthmedium_max");
404         g_pickup_healthmedium_anyway = cvar("g_pickup_healthmedium_anyway");
405         g_pickup_healthlarge = cvar("g_pickup_healthlarge");
406         g_pickup_healthlarge_max = cvar("g_pickup_healthlarge_max");
407         g_pickup_healthlarge_anyway = cvar("g_pickup_healthlarge_anyway");
408         g_pickup_healthmega = cvar("g_pickup_healthmega");
409         g_pickup_healthmega_max = cvar("g_pickup_healthmega_max");
410         g_pickup_healthmega_anyway = cvar("g_pickup_healthmega_anyway");
411
412         g_pickup_ammo_anyway = cvar("g_pickup_ammo_anyway");
413         g_pickup_weapons_anyway = cvar("g_pickup_weapons_anyway");
414
415     g_weapon_stay = cvar(strcat("g_", GetGametype(), "_weapon_stay"));
416     if(!g_weapon_stay)
417         g_weapon_stay = cvar("g_weapon_stay");
418
419         if (!warmup_stage)
420                 game_starttime = time + cvar("g_start_delay");
421
422         for(int i = WEP_FIRST; i <= WEP_LAST; ++i)
423                 _WEP_ACTION(i, WR_INIT);
424
425         readplayerstartcvars();
426 }
427
428 //#NO AUTOCVARS END
429
430
431 // Sound functions
432 //string precache_sound (string s) = #19;
433 // hack
434 float precache_sound_index (string s) = #19;
435
436 const float SND_VOLUME = 1;
437 const float SND_ATTENUATION = 2;
438 const float SND_LARGEENTITY = 8;
439 const float SND_LARGESOUND = 16;
440
441 const float INITPRIO_FIRST                              = 0;
442 const float INITPRIO_GAMETYPE                   = 0;
443 const float INITPRIO_GAMETYPE_FALLBACK  = 1;
444 const float INITPRIO_FINDTARGET                 = 10;
445 const float INITPRIO_DROPTOFLOOR                = 20;
446 const float INITPRIO_SETLOCATION                = 90;
447 const float INITPRIO_LINKDOORS                  = 91;
448 const float INITPRIO_LAST                               = 99;
449
450 .void(void) initialize_entity;
451 .float initialize_entity_order;
452 .entity initialize_entity_next;
453 entity initialize_entity_first;
454
455
456
457
458
459 float sound_allowed(float dest, entity e);
460 void InitializeEntity(entity e, void(void) func, float order);
461 void SetCustomizer(entity e, float(void) customizer, void(void) uncustomizer);
462 void Net_LinkEntity(entity e, bool docull, float dt, bool(entity, int) sendfunc);
463
464 #endif