944dcc4ce0a249ce877681f01682219cbc38250e
[xonotic/xonotic-data.pk3dir.git] / qcsrc / server / defs.qh
1 #define INDEPENDENT_ATTACK_FINISHED
2
3 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
16 // Globals
17
18 float ctf_score_value(string parameter);
19
20 float g_dm, g_domination, g_ctf, g_tdm, g_keyhunt, g_onslaught, g_assault, g_arena, g_ca, g_lms, g_runematch, g_race, g_nexball, g_cts, g_freezetag, g_keepaway;
21 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;
22 float g_warmup_limit;
23 float g_warmup_allguns;
24 float g_warmup_allow_timeout;
25 float g_ctf_win_mode;
26 float g_ctf_ignore_frags;
27 float g_ctf_reverse;
28 float g_race_qualifying;
29 float inWarmupStage;
30 float g_pickup_respawntime_weapon;
31 float g_pickup_respawntime_ammo;
32 float g_pickup_respawntime_short;
33 float g_pickup_respawntime_medium;
34 float g_pickup_respawntime_long;
35 float g_pickup_respawntime_powerup;
36 float g_pickup_respawntimejitter_weapon;
37 float g_pickup_respawntimejitter_ammo;
38 float g_pickup_respawntimejitter_short;
39 float g_pickup_respawntimejitter_medium;
40 float g_pickup_respawntimejitter_long;
41 float g_pickup_respawntimejitter_powerup;
42 float g_jetpack;
43
44 float sv_clones;
45 float sv_gentle;
46 float sv_foginterval;
47
48 entity  activator;
49
50 float player_count;
51 float currentbots;
52 float bots_would_leave;
53 float lms_lowest_lives;
54 float lms_next_place;
55 float LMS_NewPlayerLives();
56
57 void UpdateFrags(entity player, float f);
58 .float totalfrags;
59
60 float team1_score, team2_score, team3_score, team4_score;
61
62 float maxclients;
63
64 // Fields
65
66 .void(entity inflictor, entity attacker, float damage, float deathtype, vector hitloc, vector force) event_damage;
67
68 //.string       wad;
69 //.string       map;
70
71 //.float        worldtype;
72 .float  delay;
73 .float  wait;
74 .float  lip;
75 //.float        light_lev;
76 .float  speed;
77 //.float        style;
78 //.float        skill;
79 .float  sounds;
80 .float  platmovetype;
81
82 .string killtarget;
83
84 .vector pos1, pos2;
85 .vector mangle;
86
87 .float cvar_cl_hitsound;
88
89 .float  pain_finished;                  //Added by Supajoe
90 .float  pain_frame;                     //"
91 .float  statdraintime;                  // record the one-second intervals between draining health and armour when they're over 100
92 .float  crouch; // Crouching or not?
93
94 .float  strength_finished;
95 //.float        speed_finished;
96 .float  invincible_finished;
97 //.float        slowmo_finished;
98
99 .vector         finaldest, finalangle;          //plat.qc stuff
100 .void()         think1;
101 .float state;
102 .float          t_length, t_width;
103
104 .vector destvec;                // for rain
105 .float cnt;             // for rain
106 .float count;
107 //.float cnt2;
108
109 .float play_time;
110 .float death_time;
111 .float dead_frame;
112 .float fade_time;
113 .float fade_rate;
114
115 // player animation state
116 .float animstate_startframe;
117 .float animstate_numframes;
118 .float animstate_framerate;
119 .float animstate_starttime;
120 .float animstate_endtime;
121 .float animstate_override;
122 .float animstate_looping;
123
124 // player animation data for this model
125 // each vector is as follows:
126 // _x = startframe
127 // _y = numframes
128 // _z = framerate
129 .vector anim_die1; // player dies
130 .vector anim_die2; // player dies differently
131 .vector anim_draw; // player pulls out a weapon
132 .vector anim_duck; // player crouches (from idle to duckidle)
133 .vector anim_duckwalk; // player walking while crouching
134 .vector anim_duckjump; // player jumping from a crouch
135 .vector anim_duckidle; // player idling while crouching
136 .vector anim_idle; // player standing
137 .vector anim_jump; // player jump
138 .vector anim_pain1; // player flinches from pain
139 .vector anim_pain2; // player flinches from pain, differently
140 .vector anim_shoot; // player shoots
141 .vector anim_taunt; // player taunts others (FIXME: no code references this)
142 .vector anim_run; // player running forward
143 .vector anim_runbackwards; // player running backward
144 .vector anim_strafeleft; // player shuffling left quickly
145 .vector anim_straferight; // player shuffling right quickly
146 .vector anim_dead1; // player dead (must be identical to last frame of die1)
147 .vector anim_dead2; // player dead (must be identical to last frame of die2)
148 .vector anim_forwardright; // player running forward and right
149 .vector anim_forwardleft; // player running forward and left
150 .vector anim_backright; // player running backward and right
151 .vector anim_backleft; // player running back and left
152
153 // weapon animation vectors:
154 .vector anim_fire1;
155 .vector anim_fire2;
156 .vector anim_idle;
157 .vector anim_reload;
158
159 void() player_setupanimsformodel;
160 void setanim(entity e, vector anim, float looping, float override, float restart);
161
162 .string mdl;
163
164 .string playermodel;
165 .string playerskin;
166
167 .float species;
168
169 .float  respawntime;
170 .float  respawntimejitter;
171 //.float        chasecam;
172
173 .float  damageforcescale;
174
175 //.float          gravity;
176
177 .float          dmg;
178
179 // for railgun damage (hitting multiple enemies)
180 .float railgunhit;
181 .float railgunhitsolidbackup;
182 .vector railgunhitloc;
183
184 .float          air_finished;
185 .float          dmgtime;
186
187 .float          killcount;
188 .float hitsound, typehitsound;
189
190 .float watersound_finished;
191 .float iscreature;
192 .vector oldvelocity;
193
194 .float pauseregen_finished;
195 .float pauserothealth_finished;
196 .float pauserotarmor_finished;
197 .float pauserotfuel_finished;
198 .string item_pickupsound;
199
200 // definitions for weaponsystem
201
202 .entity weaponentity;
203 .entity exteriorweaponentity;
204 .vector weaponentity_glowmod;
205 .float switchweapon;
206 .float autoswitch;
207 float weapon_action(float wpn, float wrequest);
208 float client_hasweapon(entity cl, float wpn, float andammo, float complain);
209 void w_clear();
210 void w_ready();
211 // VorteX: standalone think for weapons, so normal think on weaponentity can be reserved by weaponflashes (which needs update even player dies)
212 .float weapon_nextthink;
213 .void() weapon_think;
214
215 //float PLAYER_WEAPONSELECTION_DELAY = );
216 float   PLAYER_WEAPONSELECTION_SPEED = 18;
217 vector  PLAYER_WEAPONSELECTION_RANGE = '0 20 -40';
218
219 // weapon states (self.weaponentity.state)
220 float WS_CLEAR                  = 0; // no weapon selected
221 float WS_RAISE                  = 1; // raise frame
222 float WS_DROP                   = 2; // deselecting frame
223 float WS_INUSE                  = 3; // fire state
224 float WS_READY                  = 4; // idle frame
225
226 // there is 2 weapon tics that can run in one server frame
227 #define W_TICSPERFRAME 2
228
229 void weapon_defaultspawnfunc(float wpn);
230
231 string w_deathtypestring;
232
233 void(entity client, string s) centerprint_builtin = #73;
234 .vector dest1, dest2;
235
236 float gameover;
237 float intermission_running;
238 float intermission_exittime;
239 float alreadychangedlevel;
240
241
242 .float runes;
243
244
245 .float welcomemessage_time;
246 .float version;
247
248 // minstagib vars
249 .float jump_interval;    // laser refire
250
251 //swamp
252 .float in_swamp;              // bool
253 .entity swampslug;            // Uses this to release from swamp ("untouch" fix)
254
255 // footstep interval
256 .float nextstep;
257
258 .float ready;
259 #define RESTART_COUNTDOWN 10
260 float restart_mapalreadyrestarted; //bool, indicates whether reset_map() was already executed
261 entity restartTimer;
262 void restartTimer_Think();
263 float blockSpectators; //if set, new or existing spectators or observers will be removed unless they become a player within g_maxplayers_spectator_blocktime seconds
264 .float spectatortime; //point in time since the client is spectating or observing
265 void checkSpectatorBlock();
266
267 .float winning;
268 .float jointime; // time of joining
269 .float alivetime; // time of being alive
270
271 float nJoinAllowed(float includeMe);
272 #define PREVENT_JOIN_TEXT "^1You may not join the game at this time.\n\nThe player limit reached maximum capacity."
273
274 //sv_timeout: pauses the game by setting the gamespeed to a really low value (see TIMEOUT_SLOWMO_VALUE)
275 #define TIMEOUT_SLOWMO_VALUE 0.0001
276 float sys_frametime; // gets initialised in worlspawn, saves the value from autocvar_sys_ticrate
277 float remainingTimeoutTime; // contains the time in seconds that the active timeout has left
278 float remainingLeadTime; // contains the number of seconds left of the leadtime (before the timeout starts)
279 float timeoutStatus; // (values: 0, 1, 2) contains whether a timeout is not active (0), was called but still at leadtime (1) or is active (2)
280 .float allowedTimeouts; // contains the number of allowed timeouts for each player
281 entity timeoutInitiator; // contains the entity of the player who started the last timeout
282 float orig_slowmo; // contains the value of autocvar_slowmo so that, after timeout finished, it isn't set to slowmo 1 necessarily
283 .vector lastV_angle; //used when pausing the game in order to force the player to keep his old view angle fixed
284 entity timeoutHandler; //responsible for centerprinting the timeout countdowns and playing sounds
285 void timeoutHandler_Think();
286 void evaluateTimeout();
287 void evaluateTimein();
288 string getTimeoutText(float addOneSecond);
289
290 .float spawnshieldtime;
291
292 .float lms_nextcheck;
293 .float lms_traveled_distance;
294
295 .entity flagcarried;
296
297 .entity lastrocket;
298
299 .float playerid;
300 float playerid_last;
301 .float noalign;         // if set to 1, the item or spawnpoint won't be dropped to the floor
302
303 .vector spawnorigin;
304
305 .vector death_origin;
306 .vector killer_origin;
307
308 float default_player_alpha;
309 float default_weapon_alpha;
310
311 .float() customizeentityforclient;
312 .float cvar_cl_handicap;
313 .float cvar_cl_playerdetailreduction;
314 .float cvar_scr_centertime;
315 .float cvar_cl_shownames;
316 .string cvar_g_xonoticversion;
317 .string cvar_cl_weaponpriority;
318 .string cvar_cl_weaponpriorities[10];
319 #ifdef ALLOW_FORCEMODELS
320 .float cvar_cl_forceplayermodels;
321 .float cvar_cl_forceplayermodelsfromxonotic;
322 float sv_clforceplayermodels;
323 #endif
324 float sv_loddistance1;
325 float sv_loddistance2;
326 .float cvar_cl_gunalign;
327 .float cvar_cl_noantilag;
328
329 .string weaponorder_byimpulse;
330
331 .float cvar_cl_allow_uid2name;
332 .float cvar_cl_allow_uidtracking;
333 .string stored_netname;
334
335 void Announce(string snd);
336 void AnnounceTo(entity e, string snd);
337
338 .float version_nagtime;
339
340 .float modelindex_lod0;
341 .float modelindex_lod0_from_xonotic;
342 .float skinindex;
343 .float modelindex_lod1;
344 .float modelindex_lod2;
345
346 #define NUM_JUMPPADSUSED 3
347 .float jumppadcount;
348 .entity jumppadsused[NUM_JUMPPADSUSED];
349
350 string gamemode_name;
351 float teams_matter;
352
353 float startitem_failed;
354
355 void DropFlag(entity flag, entity penalty_receiver, entity attacker);
356 void DropBall(entity ball, vector org, vector vel);
357 void DropAllRunes(entity pl);
358
359
360 typedef .float floatfield;
361 floatfield Item_CounterField(float it);
362
363 float W_AmmoItemCode(float wpn);
364 float W_WeaponBit(float wpn);
365 string W_Name(float weaponid);
366
367 void UpdateSelectedPlayer();
368 void ClearSelectedPlayer();
369 .entity selected_player;
370 .entity last_selected_player;
371 .float selected_player_time; // when this player has been selected
372 .float selected_player_count; // how long this player has been directly pointed to
373 .float selected_player_display_needs_update; // are regular updates necessary? (health)
374 .float selected_player_display_timeout; // when the selection will time out
375
376 void FixIntermissionClient(entity e);
377 void FixClientCvars(entity e);
378
379 float weaponsInMap;
380
381 void centerprint_atprio(entity e, float prio, string s);
382 void centerprint_expire(entity e, float prio);
383 void centerprint(entity e, string s);
384
385 .float respawn_countdown; // next number to count
386
387 float bot_waypoints_for_items;
388
389 .float attack_finished_for[WEP_MAXCOUNT];
390 .float attack_finished_single;
391 #ifdef INDEPENDENT_ATTACK_FINISHED
392 #define ATTACK_FINISHED_FOR(ent,w) ((ent).(attack_finished_for[(w) - WEP_FIRST]))
393 #else
394 #define ATTACK_FINISHED_FOR(ent,w) ((ent).attack_finished_single)
395 #endif
396 #define ATTACK_FINISHED(ent) ATTACK_FINISHED_FOR(ent,(ent).weapon)
397
398 // assault game mode: Which team is attacking in this round?
399 float assault_attacker_team;
400
401 // speedrun: when 1, player auto teleports back when capture timeout happens
402 .float speedrunning;
403
404 // Q3 support
405 .float notteam;
406 .float notsingle;
407 .float notfree;
408 .float notq3a;
409 float q3acompat_machineshotgunswap;
410
411 // database
412 float ServerProgsDB;
413 float TemporaryDB;
414
415 .float team_saved;
416
417 float some_spawn_has_been_used;
418 float have_team_spawns; // 0 = no team spawns requested, -1 = team spawns requested but none found, 1 = team spawns requested and found
419
420 // set when showing a kill countdown
421 .entity killindicator;
422 .float killindicator_teamchange;
423
424 void Damage (entity targ, entity inflictor, entity attacker, float damage, float deathtype, vector hitloc, vector force);
425
426 float lockteams;
427
428 .float parm_idlesince;
429 float sv_maxidle;
430 float sv_maxidle_spectatorsareidle;
431
432 float sv_pogostick;
433 float tracebox_hits_trigger_hurt(vector start, vector mi, vector ma, vector end);
434
435 float next_pingtime;
436
437 .float Version;
438 .float SendFlags;
439 .float(entity to, float sendflags) SendEntity;
440
441 // player sounds, voice messages
442 // TODO implemented fall and falling
443 #define ALLPLAYERSOUNDS \
444                 _VOICEMSG(death) \
445                 _VOICEMSG(fall) \
446                 _VOICEMSG(drown) \
447                 _VOICEMSG(gasp) \
448                 _VOICEMSG(jump) \
449                 _VOICEMSG(pain25) \
450                 _VOICEMSG(pain50) \
451                 _VOICEMSG(pain75) \
452                 _VOICEMSG(pain100)
453 #define ALLVOICEMSGS \
454                 _VOICEMSG(attack) \
455                 _VOICEMSG(attackinfive) \
456                 _VOICEMSG(meet) \
457                 _VOICEMSG(seenflag) \
458                 _VOICEMSG(taunt) \
459                 _VOICEMSG(teamshoot)
460
461 #define _VOICEMSG(m) .string playersound_##m;
462 ALLPLAYERSOUNDS
463 ALLVOICEMSGS
464 #undef _VOICEMSG
465
466 // reserved sound names for the future (models lack sounds for them):
467 //              _VOICEMSG(affirmative) \
468 //              _VOICEMSG(attacking) \
469 //              _VOICEMSG(defending) \
470 //              _VOICEMSG(roaming) \
471 //              _VOICEMSG(onmyway) \
472 //              _VOICEMSG(droppedflag) \
473 //              _VOICEMSG(flagcarriertakingdamage) \
474 //              _VOICEMSG(negative) \
475 //              _VOICEMSG(seenenemy) \
476 //              _VOICEMSG(fall) \
477 //              _VOICEMSG(getflag) \
478 //              _VOICEMSG(incoming) \
479 //              _VOICEMSG(coverme) \
480 //              _VOICEMSG(needhelp) \
481 //              _VOICEMSG(defend) \
482 //              _VOICEMSG(freelance) \
483 //              _VOICEMSG(falling) \
484
485 string globalsound_fall;
486 string globalsound_metalfall;
487 string globalsound_step;
488 string globalsound_metalstep;
489
490 #define VOICETYPE_PLAYERSOUND 10
491 #define VOICETYPE_TEAMRADIO 11
492 #define VOICETYPE_LASTATTACKER 12
493 #define VOICETYPE_LASTATTACKER_ONLY 13
494 #define VOICETYPE_AUTOTAUNT 14
495 #define VOICETYPE_TAUNT 15
496
497 void PrecachePlayerSounds(string f);
498 void PrecacheGlobalSound(string samplestring);
499 void UpdatePlayerSounds();
500 void ClearPlayerSounds();
501 void PlayerSound(.string samplefield, float channel, float voicetype);
502 void GlobalSound(string samplestring, float channel, float voicetype);
503 void FakeGlobalSound(string samplestring, float channel, float voicetype);
504 void VoiceMessage(string type, string message);
505 float GetPlayerSoundSampleField_notFound;
506 .string GetVoiceMessageSampleField(string type)
507
508 // autotaunt system
509 .float cvar_cl_autotaunt;
510 .float cvar_cl_voice_directional;
511 .float cvar_cl_voice_directional_taunt_attenuation;
512
513 .float version_mismatch;
514
515 float independent_players;
516 #define IS_INDEPENDENT_PLAYER(e) ((e).solid == SOLID_TRIGGER)
517 #define MAKE_INDEPENDENT_PLAYER(e) (((e).solid = SOLID_TRIGGER) + ((e).frags = FRAGS_PLAYER_NONSOLID))
518 // we're using + here instead of , because fteqcc sucks
519
520 string clientstuff;
521 .float phase;
522 .float weapons;
523 .float pressedkeys;
524
525 .float porto_forbidden;
526
527 .string fog;
528
529 string cvar_changes;
530 string cvar_purechanges;
531 float cvar_purechanges_count;
532
533 float game_starttime; //point in time when the countdown is over
534 .float stat_game_starttime;
535
536 .float stat_sv_airaccel_qw;
537 .float stat_sv_airstrafeaccel_qw;
538 .float stat_sv_airspeedlimit_nonqw;
539 .float stat_sv_maxspeed;
540
541 void W_Porto_Remove (entity p);
542
543 .float projectiledeathtype;
544
545 .string message2;
546
547 vector railgun_start, railgun_end; // filled by FireRailgunBullet, used by damage code for head shot
548 .float stat_allow_oldnexbeam;
549
550 // reset to 0 on weapon switch
551 // may be useful to all weapons
552 .float bulletcounter;
553
554 void target_voicescript_next(entity pl);
555 void target_voicescript_clear(entity pl);
556
557 .string target2;
558 .string target3;
559 .string target4;
560 .float trigger_reverse;
561
562 // Nexball 
563 .entity ballcarried; // Also used for keepaway
564 .float metertime;
565 float g_nexball_meter_period;
566
567 void SUB_DontUseTargets();
568 void SUB_UseTargets();
569
570 .void() reset; // if set, an entity is reset using this
571 .void() reset2; // if set, an entity is reset using this (after calling ALL the reset functions for other entities)
572
573 void ClientData_Touch(entity e);
574
575 vector debug_shotorg; // if non-zero, overrides the shot origin of all weapons
576
577 // the QC VM sucks
578 #define BITXOR(v,b)        ((v) + (b) - 2 * ((v) & (b)))
579 #define BITXOR_ASSIGN(v,b) ((v) += ((b) - 2 * ((v) & (b))))
580
581 .float wasplayer;
582
583 float servertime, serverprevtime, serverframetime;
584
585 .entity soundentity;
586
587 .float ammo_fuel;
588
589 .vector prevorigin;
590
591 //flood fields
592 .float nickspamtime; // time of last nick change
593 .float nickspamcount;
594 .float floodcontrol_chat;
595 .float floodcontrol_chatteam;
596 .float floodcontrol_chattell;
597 .float floodcontrol_voice;
598 .float floodcontrol_voiceteam;
599
600 .float stat_shotorg; // networked stat for trueaim HUD
601
602 string matchid;
603 .float hitplotfh;
604 .string noise4;
605
606 .float last_pickup;
607
608 .float stat_leadlimit;
609
610 float radar_showennemies;
611
612 #ifdef PROFILING
613 float client_cefc_accumulator;
614 float client_cefc_accumulatortime;
615 #endif
616
617 .float sniperrifle_bulletcounter;
618 .float wish_reload;
619
620 #define PROJECTILE_MAKETRIGGER(e) (e).solid = SOLID_CORPSE; (e).dphitcontentsmask = DPCONTENTS_SOLID | DPCONTENTS_BODY | DPCONTENTS_CORPSE
621 // when doing this, hagar can go through clones
622 // #define PROJECTILE_MAKETRIGGER(e) (e).solid = SOLID_BBOX
623
624 .float spectatee_status;
625 .float zoomstate;
626 .float bloodloss_timer;
627 .float restriction;
628
629 .entity clientdata;
630 .entity personal;
631
632 string deathmessage;
633
634 .float just_joined;
635
636 .float cvar_cl_accuracy_data_share;
637 .float cvar_cl_accuracy_data_receive;
638
639 .float cvar_cl_weaponimpulsemode;
640 .float selectweapon; // last selected weapon of the player
641
642 .float ballistics_density; // wall piercing factor, larger = bullet can pass through more
643
644 #define ACTIVE_NOT              0
645 #define ACTIVE_ACTIVE   1
646 #define ACTIVE_IDLE     2
647 #define ACTIVE_BUSY     2
648 #define ACTIVE_TOGGLE   3
649 .float active;
650 .float (float act_state) setactive;
651 .entity realowner;
652
653 .float nex_charge;
654 .float nex_charge_rottime;
655 .float nex_chargepool_ammo;
656
657 float allowed_to_spawn; // boolean variable used by the clan arena code to determine if a player can spawn (after the round has ended)
658
659 float serverflags;
660
661 .float team_forced; // can be a team number to force a team, or 0 for default action, or -1 for forced spectator
662
663 .float freezetag_frozen;
664 .float freezetag_revive_progress;
665
666 .entity muzzle_flash;
667 .float misc_bulletcounter;      // replaces uzi & hlac bullet counter.