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