Merge remote-tracking branch 'origin/master' into terencehill/MOTD_bugfix
[xonotic/xonotic-data.pk3dir.git] / qcsrc / server / defs.qh
1 #define INDEPENDENT_ATTACK_FINISHED
2
3 noref float require_spawnfunc_prefix; // if this float exists, only functions with spawnfunc_ name prefix qualify as spawn functions
4
5 #define BUTTON_ATCK       button0
6 #define BUTTON_JUMP       button2
7 #define BUTTON_ATCK2      button3
8 #define BUTTON_ZOOM       button4
9 #define BUTTON_CROUCH     button5
10 #define BUTTON_HOOK       button6
11 #define BUTTON_INFO       button7
12 #define BUTTON_CHAT       buttonchat
13 #define BUTTON_USE        buttonuse
14 #define BUTTON_DRAG       button8
15 #define BUTTON_ZOOMSCRIPT button9
16
17 // Globals
18
19 float g_cloaked, g_footsteps, g_jump_grunt, g_grappling_hook, g_midair, g_minstagib, g_pinata, g_norecoil, g_minstagib_invis_alpha, g_bloodloss;
20 float g_warmup_limit;
21 float g_warmup_allguns;
22 float g_warmup_allow_timeout;
23 float g_race_qualifying;
24 float inWarmupStage;
25 float g_pickup_respawntime_weapon;
26 float g_pickup_respawntime_superweapon;
27 float g_pickup_respawntime_ammo;
28 float g_pickup_respawntime_short;
29 float g_pickup_respawntime_medium;
30 float g_pickup_respawntime_long;
31 float g_pickup_respawntime_powerup;
32 float g_pickup_respawntimejitter_weapon;
33 float g_pickup_respawntimejitter_superweapon;
34 float g_pickup_respawntimejitter_ammo;
35 float g_pickup_respawntimejitter_short;
36 float g_pickup_respawntimejitter_medium;
37 float g_pickup_respawntimejitter_long;
38 float g_pickup_respawntimejitter_powerup;
39 float g_jetpack;
40
41 float sv_clones;
42 float sv_foginterval;
43
44 entity  activator;
45
46 float player_count;
47 float currentbots;
48 float bots_would_leave;
49 float lms_lowest_lives;
50 float lms_next_place;
51 float LMS_NewPlayerLives();
52
53 void UpdateFrags(entity player, float f);
54 .float totalfrags;
55
56 float team1_score, team2_score, team3_score, team4_score;
57
58 float maxclients;
59
60 // flag set on worldspawn so that the code knows if it is dedicated or not
61 float server_is_dedicated; 
62
63 // Fields
64
65 .void(entity inflictor, entity attacker, float damage, float deathtype, vector hitloc, vector force) event_damage;
66
67 //.string       wad;
68 //.string       map;
69
70 //.float        worldtype;
71 .float  delay;
72 .float  wait;
73 .float  lip;
74 //.float        light_lev;
75 .float  speed;
76 //.float        style;
77 //.float        skill;
78 .float  sounds;
79 .float  platmovetype;
80
81 .string killtarget;
82
83 .vector pos1, pos2;
84 .vector mangle;
85
86 .float  pain_finished;                  //Added by Supajoe
87 .float  pain_frame;                     //"
88 .float  statdraintime;                  // record the one-second intervals between draining health and armour when they're over 100
89 .float  crouch; // Crouching or not?
90
91 .float  strength_finished;
92 .float  invincible_finished;
93 .float  superweapons_finished;
94
95 .vector         finaldest, finalangle;          //plat.qc stuff
96 .void()         think1;
97 .float state;
98 .float          t_length, t_width;
99
100 .vector destvec;                // for rain
101 .vector destvec2;               // for train
102 .float cnt;             // for rain
103 .float count;
104 //.float cnt2;
105
106 .float play_time;
107 .float respawn_time;
108 .float death_time;
109 .float fade_time;
110 .float fade_rate;
111
112 // player animation state
113 .float animstate_startframe;
114 .float animstate_numframes;
115 .float animstate_framerate;
116 .float animstate_starttime;
117 .float animstate_endtime;
118 .float animstate_override;
119 .float animstate_looping;
120
121 // weapon animation vectors:
122 .vector anim_fire1;
123 .vector anim_fire2;
124 .vector anim_idle;
125 .vector anim_reload;
126
127 void() player_setupanimsformodel;
128 void setanim(entity e, vector anim, float looping, float override, float restart);
129
130 .string mdl;
131
132 .string playermodel;
133 .string playerskin;
134
135 .float species;
136
137 .float  respawntime;
138 .float  respawntimejitter;
139 //.float        chasecam;
140
141 .float  damageforcescale;
142 #define MIN_DAMAGEEXTRARADIUS 2
143 #define MAX_DAMAGEEXTRARADIUS 16
144 .float damageextraradius;
145
146 //.float          gravity;
147
148 .float          dmg;
149
150 // for railgun damage (hitting multiple enemies)
151 .float railgunhit;
152 .float railgunhitsolidbackup;
153 .vector railgunhitloc;
154
155 .float          air_finished;
156 .float          dmgtime;
157
158 .float          killcount;
159 .float hitsound, typehitsound;
160
161 .float watersound_finished;
162 .float iscreature;
163 .float damagedbycontents;
164 .float damagedbytriggers;
165 .float pushable;
166 .float teleportable;
167 .vector oldvelocity;
168
169 .float pauseregen_finished;
170 .float pauserothealth_finished;
171 .float pauserotarmor_finished;
172 .float pauserotfuel_finished;
173 .string item_pickupsound;
174
175 // definitions for weaponsystem
176
177 .entity weaponentity;
178 .entity exteriorweaponentity;
179 .vector weaponentity_glowmod;
180
181 //.float weapon; // current weapon
182 .float switchweapon; // weapon requested to switch to
183 .float switchingweapon; // weapon currently being switched to (is copied from switchweapon once switch is possible)
184 .string weaponname; // name of .weapon
185
186 .float autoswitch;
187 float weapon_action(float wpn, float wrequest);
188 float client_hasweapon(entity cl, float wpn, float andammo, float complain);
189 void w_clear();
190 void w_ready();
191 // VorteX: standalone think for weapons, so normal think on weaponentity can be reserved by weaponflashes (which needs update even player dies)
192 .float weapon_nextthink;
193 .void() weapon_think;
194
195 //float PLAYER_WEAPONSELECTION_DELAY = );
196 float   PLAYER_WEAPONSELECTION_SPEED = 18;
197 vector  PLAYER_WEAPONSELECTION_RANGE = '0 20 -40';
198
199 // weapon states (self.weaponentity.state)
200 float WS_CLEAR                  = 0; // no weapon selected
201 float WS_RAISE                  = 1; // raise frame
202 float WS_DROP                   = 2; // deselecting frame
203 float WS_INUSE                  = 3; // fire state
204 float WS_READY                  = 4; // idle frame
205
206 // there is 2 weapon tics that can run in one server frame
207 #define W_TICSPERFRAME 2
208
209 void weapon_defaultspawnfunc(float wpn);
210
211 .vector dest1, dest2;
212
213 float gameover;
214 float intermission_running;
215 float intermission_exittime;
216 float alreadychangedlevel;
217
218 // Keys player is holding
219 .float itemkeys;
220 // message delay for func_door locked by keys and key locks
221 // this field is used on player entities
222 .float key_door_messagetime;
223
224
225 .float version;
226
227 //swamp
228 .float in_swamp;              // bool
229 .entity swampslug;            // Uses this to release from swamp ("untouch" fix)
230
231 // footstep interval
232 .float nextstep;
233
234 float blockSpectators; //if set, new or existing spectators or observers will be removed unless they become a player within g_maxplayers_spectator_blocktime seconds
235 .float spectatortime; //point in time since the client is spectating or observing
236 void checkSpectatorBlock();
237
238 float game_completion_ratio; // 0 at start, 1 near end
239 .float winning;
240 .float jointime; // time of joining
241 .float alivetime; // time of being alive
242 .float motd_actived_time; // used for both motd and campaign_message
243
244 float nJoinAllowed(entity ignore);
245
246 .float spawnshieldtime;
247
248 .float lms_nextcheck;
249 .float lms_traveled_distance;
250
251 .entity flagcarried;
252
253 .float playerid;
254 float playerid_last;
255 .float noalign;         // if set to 1, the item or spawnpoint won't be dropped to the floor
256
257 .vector spawnorigin;
258
259 .vector death_origin;
260 .vector killer_origin;
261
262 float default_player_alpha;
263 float default_weapon_alpha;
264
265 .float() customizeentityforclient;
266 .float cvar_cl_handicap;
267 .float cvar_cl_clippedspectating;
268 .float cvar_cl_autoscreenshot;
269 .float cvar_cl_movement_track_canjump;
270 .float cvar_cl_newusekeysupported;
271
272 .string cvar_g_xonoticversion;
273 .string cvar_cl_weaponpriority;
274 .string cvar_cl_weaponpriorities[10];
275 .float cvar_cl_gunalign;
276 .float cvar_cl_noantilag;
277
278 .string weaponorder_byimpulse;
279
280 .float cvar_cl_allow_uid2name;
281 .float cvar_cl_allow_uidtracking;
282 .string stored_netname;
283
284 .float version_nagtime;
285
286 #define NUM_JUMPPADSUSED 3
287 .float jumppadcount;
288 .entity jumppadsused[NUM_JUMPPADSUSED];
289
290 string gamemode_name;
291
292 float startitem_failed;
293
294 typedef .float floatfield;
295 floatfield Item_CounterField(float it);
296
297 float W_AmmoItemCode(float wpn);
298 string W_Name(float weaponid);
299 string W_Apply_Weaponreplace(string in);
300
301 void FixIntermissionClient(entity e);
302 void FixClientCvars(entity e);
303
304 WEPSET_DECLARE_A(weaponsInMap);
305
306 .float respawn_countdown; // next number to count
307
308 float bot_waypoints_for_items;
309
310 .float attack_finished_for[WEP_MAXCOUNT];
311 .float attack_finished_single;
312 #ifdef INDEPENDENT_ATTACK_FINISHED
313 #define ATTACK_FINISHED_FOR(ent,w) ((ent).(attack_finished_for[(w) - WEP_FIRST]))
314 #else
315 #define ATTACK_FINISHED_FOR(ent,w) ((ent).attack_finished_single)
316 #endif
317 #define ATTACK_FINISHED(ent) ATTACK_FINISHED_FOR(ent,(ent).weapon)
318
319 // assault game mode: Which team is attacking in this round?
320 float assault_attacker_team;
321
322 // speedrun: when 1, player auto teleports back when capture timeout happens
323 .float speedrunning;
324
325 // database
326 float ServerProgsDB;
327 float TemporaryDB;
328
329 .float team_saved;
330
331 float some_spawn_has_been_used;
332 float have_team_spawns; // 0 = no team spawns requested, -1 = team spawns requested but none found, 1 = team spawns requested and found
333 float have_team_spawns_forteam[17]; // 0 = this team has no spawns, 1 = this team has spawns; team 0 is the "no-team"
334
335 // set when showing a kill countdown
336 .entity killindicator;
337 .float killindicator_teamchange;
338
339 void Damage (entity targ, entity inflictor, entity attacker, float damage, float deathtype, vector hitloc, vector force);
340
341 float lockteams;
342
343 .float parm_idlesince;
344 float sv_maxidle;
345 float sv_maxidle_spectatorsareidle;
346
347 float tracebox_hits_trigger_hurt(vector start, vector mi, vector ma, vector end);
348
349 float next_pingtime;
350
351 .float Version;
352 .float SendFlags;
353 .float(entity to, float sendflags) SendEntity;
354
355 // player sounds, voice messages
356 // TODO implemented fall and falling
357 #define ALLPLAYERSOUNDS \
358                 _VOICEMSG(death) \
359                 _VOICEMSG(drown) \
360                 _VOICEMSG(fall) \
361                 _VOICEMSG(fall) \
362                 _VOICEMSG(falling) \
363                 _VOICEMSG(gasp) \
364                 _VOICEMSG(jump) \
365                 _VOICEMSG(pain100) \
366                 _VOICEMSG(pain25) \
367                 _VOICEMSG(pain50) \
368                 _VOICEMSG(pain75)
369
370 #define ALLVOICEMSGS \
371                 _VOICEMSG(attack) \
372                 _VOICEMSG(attackinfive) \
373                 _VOICEMSG(coverme) \
374                 _VOICEMSG(defend) \
375                 _VOICEMSG(freelance) \
376                 _VOICEMSG(incoming) \
377                 _VOICEMSG(meet) \
378                 _VOICEMSG(needhelp) \
379                 _VOICEMSG(seenflag) \
380                 _VOICEMSG(taunt) \
381                 _VOICEMSG(teamshoot)
382
383 #define _VOICEMSG(m) .string playersound_##m;
384 ALLPLAYERSOUNDS
385 ALLVOICEMSGS
386 #undef _VOICEMSG
387
388 // reserved sound names for the future (some models lack sounds for them):
389 //              _VOICEMSG(flagcarriertakingdamage) \
390 //              _VOICEMSG(getflag) \
391 // reserved sound names for the future (ALL models lack sounds for them):
392 //              _VOICEMSG(affirmative) \
393 //              _VOICEMSG(attacking) \
394 //              _VOICEMSG(defending) \
395 //              _VOICEMSG(roaming) \
396 //              _VOICEMSG(onmyway) \
397 //              _VOICEMSG(droppedflag) \
398 //              _VOICEMSG(negative) \
399 //              _VOICEMSG(seenenemy) \
400
401 string globalsound_fall;
402 string globalsound_metalfall;
403 string globalsound_step;
404 string globalsound_metalstep;
405
406 #define VOICETYPE_PLAYERSOUND 10
407 #define VOICETYPE_TEAMRADIO 11
408 #define VOICETYPE_LASTATTACKER 12
409 #define VOICETYPE_LASTATTACKER_ONLY 13
410 #define VOICETYPE_AUTOTAUNT 14
411 #define VOICETYPE_TAUNT 15
412
413 void PrecachePlayerSounds(string f);
414 void PrecacheGlobalSound(string samplestring);
415 void UpdatePlayerSounds();
416 void ClearPlayerSounds();
417 void PlayerSound(.string samplefield, float channel, float voicetype);
418 void GlobalSound(string samplestring, float channel, float voicetype);
419 void FakeGlobalSound(string samplestring, float channel, float voicetype);
420 void VoiceMessage(string type, string message);
421 float GetPlayerSoundSampleField_notFound;
422 .string GetVoiceMessageSampleField(string type);
423
424 // autotaunt system
425 .float cvar_cl_autotaunt;
426 .float cvar_cl_voice_directional;
427 .float cvar_cl_voice_directional_taunt_attenuation;
428
429 .float version_mismatch;
430
431 float independent_players;
432 #define INDEPENDENT_PLAYERS (autocvar__independent_players ? (autocvar__independent_players > 0) : independent_players)
433 #define IS_INDEPENDENT_PLAYER(e) ((e).solid == SOLID_TRIGGER)
434 #define MAKE_INDEPENDENT_PLAYER(e) (((e).solid = SOLID_TRIGGER) + ((e).frags = FRAGS_PLAYER_NONSOLID))
435 // we're using + here instead of , because fteqcc sucks
436
437 string clientstuff;
438 .float phase;
439 .float pressedkeys;
440
441 .float porto_forbidden;
442
443 .string fog;
444
445 string cvar_changes;
446 string cvar_purechanges;
447 float cvar_purechanges_count;
448
449 float game_starttime; //point in time when the countdown is over
450 .float stat_game_starttime;
451
452 .float stat_sv_airaccel_qw;
453 .float stat_sv_airstrafeaccel_qw;
454 .float stat_sv_airspeedlimit_nonqw;
455 .float stat_sv_maxspeed;
456
457 void W_Porto_Remove (entity p);
458
459 .float projectiledeathtype;
460
461 .string message2;
462
463 vector railgun_start, railgun_end; // filled by FireRailgunBullet, used by damage code for head shot
464 .float stat_allow_oldnexbeam;
465
466 // reset to 0 on weapon switch
467 // may be useful to all weapons
468 .float bulletcounter;
469
470 void target_voicescript_next(entity pl);
471 void target_voicescript_clear(entity pl);
472
473 .string target2;
474 .string target3;
475 .string target4;
476 .float target_random;
477 .float trigger_reverse;
478
479 // Nexball 
480 .entity ballcarried; // Also used for keepaway
481 .float metertime;
482 float g_nexball_meter_period;
483
484 void SUB_DontUseTargets();
485 void SUB_UseTargets();
486
487 .void() reset; // if set, an entity is reset using this
488 .void() reset2; // if set, an entity is reset using this (after calling ALL the reset functions for other entities)
489
490 void ClientData_Touch(entity e);
491
492 //vector debug_shotorg; // if non-zero, overrides the shot origin of all weapons
493
494 .float wasplayer;
495
496 float servertime, serverprevtime, serverframetime;
497
498 .entity soundentity;
499
500 .float ammo_fuel;
501
502 .vector prevorigin;
503
504 //flood fields
505 .float nickspamtime; // time of last nick change
506 .float nickspamcount;
507 .float floodcontrol_chat;
508 .float floodcontrol_chatteam;
509 .float floodcontrol_chattell;
510 .float floodcontrol_voice;
511 .float floodcontrol_voiceteam;
512
513 .float stat_shotorg; // networked stat for trueaim HUD
514
515 string matchid;
516 .float hitplotfh;
517
518 .float last_pickup;
519
520 .float hit_time; 
521 .float typehit_time; 
522
523 .float stat_leadlimit;
524
525 float radar_showennemies;
526
527 #ifdef PROFILING
528 float client_cefc_accumulator;
529 float client_cefc_accumulatortime;
530 #endif
531
532 ..float current_ammo;
533
534 .float weapon_load[WEP_MAXCOUNT];
535 .float ammo_none; // used by the reloading system, must always be 0
536 .float clip_load;
537 .float old_clip_load;
538 .float clip_size;
539
540 .entity lastrocket;
541 .float minelayer_mines;
542 .float nex_charge;
543 .float nex_charge_rottime;
544 .float nex_chargepool_ammo;
545 .float hagar_load;
546
547 .float grab; // 0 = can't grab, 1 = owner can grab, 2 = owner and team mates can grab, 3 = anyone can grab
548
549 #define PROJECTILE_MAKETRIGGER(e) (e).solid = SOLID_CORPSE; (e).dphitcontentsmask = DPCONTENTS_SOLID | DPCONTENTS_BODY | DPCONTENTS_CORPSE
550 // when doing this, hagar can go through clones
551 // #define PROJECTILE_MAKETRIGGER(e) (e).solid = SOLID_BBOX
552
553 .float spectatee_status;
554 .float zoomstate;
555 .float bloodloss_timer;
556 .float restriction;
557
558 .entity clientdata;
559 .entity personal;
560
561 string deathmessage;
562
563 .float just_joined;
564
565 .float cvar_cl_accuracy_data_share;
566 .float cvar_cl_accuracy_data_receive;
567
568 .float cvar_cl_weaponimpulsemode;
569 .float selectweapon; // last selected weapon of the player
570
571 .float ballistics_density; // wall piercing factor, larger = bullet can pass through more
572
573 #define ACTIVE_NOT              0
574 #define ACTIVE_ACTIVE   1
575 #define ACTIVE_IDLE     2
576 #define ACTIVE_BUSY     2
577 #define ACTIVE_TOGGLE   3
578 .float active;
579 .void (float act_state) setactive;
580 .entity realowner;
581
582 float allowed_to_spawn; // boolean variable used by the clan arena code to determine if a player can spawn (after the round has ended)
583
584 float serverflags;
585
586 .float team_forced; // can be a team number to force a team, or 0 for default action, or -1 for forced spectator
587
588 .float player_blocked;
589
590 .float freezetag_frozen;
591 .float freezetag_revive_progress;
592
593 .entity muzzle_flash;
594 .float misc_bulletcounter;      // replaces uzi & hlac bullet counter.
595
596 .float stat_respawn_time; // shows respawn time, and is negative when awaiting respawn
597
598 void PlayerUseKey();
599
600 typedef vector(entity player, entity spot, vector current) spawn_evalfunc_t;
601 .spawn_evalfunc_t spawn_evalfunc;
602
603 .entity conveyor;
604
605 string modname;
606
607 .float missile_flags;
608 #define MIF_SPLASH 2
609 #define MIF_ARC 4
610 #define MIF_PROXY 8
611 #define MIF_GUIDED_MANUAL 16
612 #define MIF_GUIDED_HEAT 32
613 #define MIF_GUIDED_LASER 64
614 #define MIF_GUIDED_AI 128
615 #define MIF_GUIDED_TAG 128
616 #define MIF_GUIDED_ALL (MIF_GUIDED_MANUAL | MIF_GUIDED_HEAT | MIF_GUIDED_LASER | MIF_GUIDED_AI | MIF_GUIDED_TAG)
617 #define MIF_GUIDED_TRACKING (MIF_GUIDED_HEAT | MIF_GUIDED_LASER | MIF_GUIDED_AI | MIF_GUIDED_TAG)
618 #define MIF_GUIDED_CONFUSABLE (MIF_GUIDED_HEAT | MIF_GUIDED_AI)
619
620 #define MISSILE_IS_CONFUSABLE(m) ((m.missile_flags & MIF_GUIDED_CONFUSABLE) ? TRUE : FALSE)
621 #define MISSILE_IS_GUIDED(m) ((m.missile_flags & MIF_GUIDED_ALL) ? TRUE : FALSE)
622 #define MISSILE_IS_TRACKING(m) ((m.missile_flags & MIF_GUIDED_TRACKING) ? TRUE : FALSE)