Merge branch 'master' into mirceakitsune/sandbox
[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 ctf_score_value(string parameter);
20
21 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;
22 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;
23 float g_warmup_limit;
24 float g_warmup_allguns;
25 float g_warmup_allow_timeout;
26 float g_ctf_win_mode;
27 float g_ctf_ignore_frags;
28 float g_ctf_reverse;
29 float g_race_qualifying;
30 float inWarmupStage;
31 float g_pickup_respawntime_weapon;
32 float g_pickup_respawntime_ammo;
33 float g_pickup_respawntime_short;
34 float g_pickup_respawntime_medium;
35 float g_pickup_respawntime_long;
36 float g_pickup_respawntime_powerup;
37 float g_pickup_respawntimejitter_weapon;
38 float g_pickup_respawntimejitter_ammo;
39 float g_pickup_respawntimejitter_short;
40 float g_pickup_respawntimejitter_medium;
41 float g_pickup_respawntimejitter_long;
42 float g_pickup_respawntimejitter_powerup;
43 float g_jetpack;
44
45 float sv_clones;
46 float sv_gentle;
47 float sv_foginterval;
48
49 entity  activator;
50
51 float player_count;
52 float currentbots;
53 float bots_would_leave;
54 float lms_lowest_lives;
55 float lms_next_place;
56 float LMS_NewPlayerLives();
57
58 void UpdateFrags(entity player, float f);
59 .float totalfrags;
60
61 float team1_score, team2_score, team3_score, team4_score;
62
63 float maxclients;
64
65 // Fields
66
67 .void(entity inflictor, entity attacker, float damage, float deathtype, vector hitloc, vector force) event_damage;
68
69 //.string       wad;
70 //.string       map;
71
72 //.float        worldtype;
73 .float  delay;
74 .float  wait;
75 .float  lip;
76 //.float        light_lev;
77 .float  speed;
78 //.float        style;
79 //.float        skill;
80 .float  sounds;
81 .float  platmovetype;
82
83 .string killtarget;
84
85 .vector pos1, pos2;
86 .vector mangle;
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 .vector anim_melee; // player doing the melee action
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 .float damagedbycontents;
193 .vector oldvelocity;
194
195 .float pauseregen_finished;
196 .float pauserothealth_finished;
197 .float pauserotarmor_finished;
198 .float pauserotfuel_finished;
199 .string item_pickupsound;
200
201 // definitions for weaponsystem
202
203 .entity weaponentity;
204 .entity exteriorweaponentity;
205 .vector weaponentity_glowmod;
206
207 //.float weapon; // current weapon
208 .float switchweapon; // weapon requested to switch to
209 .float switchingweapon; // weapon currently being switched to (is copied from switchweapon once switch is possible)
210 .string weaponname; // name of .weapon
211
212 .float autoswitch;
213 float weapon_action(float wpn, float wrequest);
214 float client_hasweapon(entity cl, float wpn, float andammo, float complain);
215 void w_clear();
216 void w_ready();
217 // VorteX: standalone think for weapons, so normal think on weaponentity can be reserved by weaponflashes (which needs update even player dies)
218 .float weapon_nextthink;
219 .void() weapon_think;
220
221 //float PLAYER_WEAPONSELECTION_DELAY = );
222 float   PLAYER_WEAPONSELECTION_SPEED = 18;
223 vector  PLAYER_WEAPONSELECTION_RANGE = '0 20 -40';
224
225 // weapon states (self.weaponentity.state)
226 float WS_CLEAR                  = 0; // no weapon selected
227 float WS_RAISE                  = 1; // raise frame
228 float WS_DROP                   = 2; // deselecting frame
229 float WS_INUSE                  = 3; // fire state
230 float WS_READY                  = 4; // idle frame
231
232 // there is 2 weapon tics that can run in one server frame
233 #define W_TICSPERFRAME 2
234
235 void weapon_defaultspawnfunc(float wpn);
236
237 string w_deathtypestring;
238
239 .vector dest1, dest2;
240
241 float gameover;
242 float intermission_running;
243 float intermission_exittime;
244 float alreadychangedlevel;
245
246
247 .float runes;
248
249 // Keys player is holding
250 .float itemkeys;
251 // message delay for func_door locked by keys and key locks
252 // this field is used on player entities
253 .float key_door_messagetime;
254
255
256 .float version;
257
258 // minstagib vars
259 .float jump_interval;    // laser refire
260
261 //swamp
262 .float in_swamp;              // bool
263 .entity swampslug;            // Uses this to release from swamp ("untouch" fix)
264
265 // footstep interval
266 .float nextstep;
267
268 .float ready;
269 #define RESTART_COUNTDOWN 10
270 float restart_mapalreadyrestarted; //bool, indicates whether reset_map() was already executed
271 entity restartTimer;
272 void restartTimer_Think();
273 float blockSpectators; //if set, new or existing spectators or observers will be removed unless they become a player within g_maxplayers_spectator_blocktime seconds
274 .float spectatortime; //point in time since the client is spectating or observing
275 void checkSpectatorBlock();
276
277 .float winning;
278 .float jointime; // time of joining
279 .float alivetime; // time of being alive
280
281 float nJoinAllowed(float includeMe);
282 #define PREVENT_JOIN_TEXT "^1You may not join the game at this time.\n\nThe player limit reached maximum capacity."
283
284 //sv_timeout: pauses the game by setting the gamespeed to a really low value (see TIMEOUT_SLOWMO_VALUE)
285 #define TIMEOUT_SLOWMO_VALUE 0.0001
286 float sys_frametime; // gets initialised in worlspawn, saves the value from autocvar_sys_ticrate
287 float remainingTimeoutTime; // contains the time in seconds that the active timeout has left
288 float remainingLeadTime; // contains the number of seconds left of the leadtime (before the timeout starts)
289 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)
290 .float allowedTimeouts; // contains the number of allowed timeouts for each player
291 entity timeoutInitiator; // contains the entity of the player who started the last timeout
292 float orig_slowmo; // contains the value of autocvar_slowmo so that, after timeout finished, it isn't set to slowmo 1 necessarily
293 .vector lastV_angle; //used when pausing the game in order to force the player to keep his old view angle fixed
294 entity timeoutHandler; //responsible for centerprinting the timeout countdowns and playing sounds
295 void timeoutHandler_Think();
296 void evaluateTimeout();
297 void evaluateTimein();
298
299 .float spawnshieldtime;
300
301 .float lms_nextcheck;
302 .float lms_traveled_distance;
303
304 .entity flagcarried;
305
306 .entity lastrocket;
307
308 .float playerid;
309 float playerid_last;
310 .float noalign;         // if set to 1, the item or spawnpoint won't be dropped to the floor
311
312 .vector spawnorigin;
313
314 .vector death_origin;
315 .vector killer_origin;
316
317 float default_player_alpha;
318 float default_weapon_alpha;
319
320 .float() customizeentityforclient;
321 .float cvar_cl_handicap;
322 .float cvar_cl_playerdetailreduction;
323 .float cvar_cl_clippedspectating;
324 .float cvar_cl_autoscreenshot;
325 .float cvar_cl_movement_track_canjump;
326 .float cvar_cl_newusekeysupported;
327
328 .string cvar_g_xonoticversion;
329 .string cvar_cl_weaponpriority;
330 .string cvar_cl_weaponpriorities[10];
331 #ifdef ALLOW_FORCEMODELS
332 .float cvar_cl_forceplayermodels;
333 .float cvar_cl_forceplayermodelsfromxonotic;
334 float sv_clforceplayermodels;
335 #endif
336 float sv_loddistance1;
337 float sv_loddistance2;
338 .float cvar_cl_gunalign;
339 .float cvar_cl_noantilag;
340
341 .string weaponorder_byimpulse;
342
343 .float cvar_cl_allow_uid2name;
344 .float cvar_cl_allow_uidtracking;
345 .string stored_netname;
346
347 void Announce(string snd);
348 void AnnounceTo(entity e, string snd);
349
350 .float version_nagtime;
351
352 .float modelindex_lod0;
353 .float modelindex_lod0_from_xonotic;
354 .float skinindex;
355 .float modelindex_lod1;
356 .float modelindex_lod2;
357
358 #define NUM_JUMPPADSUSED 3
359 .float jumppadcount;
360 .entity jumppadsused[NUM_JUMPPADSUSED];
361
362 string gamemode_name;
363
364 float startitem_failed;
365
366 void DropFlag(entity flag, entity penalty_receiver, entity attacker);
367 void DropBall(entity ball, vector org, vector vel);
368 void DropAllRunes(entity pl);
369
370
371 typedef .float floatfield;
372 floatfield Item_CounterField(float it);
373
374 float W_AmmoItemCode(float wpn);
375 float W_WeaponBit(float wpn);
376 string W_Name(float weaponid);
377
378 void FixIntermissionClient(entity e);
379 void FixClientCvars(entity e);
380
381 float weaponsInMap;
382
383 .float respawn_countdown; // next number to count
384
385 float bot_waypoints_for_items;
386
387 .float attack_finished_for[WEP_MAXCOUNT];
388 .float attack_finished_single;
389 #ifdef INDEPENDENT_ATTACK_FINISHED
390 #define ATTACK_FINISHED_FOR(ent,w) ((ent).(attack_finished_for[(w) - WEP_FIRST]))
391 #else
392 #define ATTACK_FINISHED_FOR(ent,w) ((ent).attack_finished_single)
393 #endif
394 #define ATTACK_FINISHED(ent) ATTACK_FINISHED_FOR(ent,(ent).weapon)
395
396 // assault game mode: Which team is attacking in this round?
397 float assault_attacker_team;
398
399 // speedrun: when 1, player auto teleports back when capture timeout happens
400 .float speedrunning;
401
402 // database
403 float ServerProgsDB;
404 float TemporaryDB;
405
406 .float team_saved;
407
408 float some_spawn_has_been_used;
409 float have_team_spawns; // 0 = no team spawns requested, -1 = team spawns requested but none found, 1 = team spawns requested and found
410 float have_team_spawns_forteam[17]; // 0 = this team has no spawns, 1 = this team has spawns; team 0 is the "no-team"
411
412 // set when showing a kill countdown
413 .entity killindicator;
414 .float killindicator_teamchange;
415
416 void Damage (entity targ, entity inflictor, entity attacker, float damage, float deathtype, vector hitloc, vector force);
417
418 float lockteams;
419
420 .float parm_idlesince;
421 float sv_maxidle;
422 float sv_maxidle_spectatorsareidle;
423
424 float tracebox_hits_trigger_hurt(vector start, vector mi, vector ma, vector end);
425
426 float next_pingtime;
427
428 .float Version;
429 .float SendFlags;
430 .float(entity to, float sendflags) SendEntity;
431
432 // player sounds, voice messages
433 // TODO implemented fall and falling
434 #define ALLPLAYERSOUNDS \
435                 _VOICEMSG(death) \
436                 _VOICEMSG(drown) \
437                 _VOICEMSG(fall) \
438                 _VOICEMSG(fall) \
439                 _VOICEMSG(falling) \
440                 _VOICEMSG(gasp) \
441                 _VOICEMSG(jump) \
442                 _VOICEMSG(pain100) \
443                 _VOICEMSG(pain25) \
444                 _VOICEMSG(pain50) \
445                 _VOICEMSG(pain75)
446
447 #define ALLVOICEMSGS \
448                 _VOICEMSG(attack) \
449                 _VOICEMSG(attackinfive) \
450                 _VOICEMSG(coverme) \
451                 _VOICEMSG(defend) \
452                 _VOICEMSG(freelance) \
453                 _VOICEMSG(incoming) \
454                 _VOICEMSG(meet) \
455                 _VOICEMSG(needhelp) \
456                 _VOICEMSG(seenflag) \
457                 _VOICEMSG(taunt) \
458                 _VOICEMSG(teamshoot)
459
460 #define _VOICEMSG(m) .string playersound_##m;
461 ALLPLAYERSOUNDS
462 ALLVOICEMSGS
463 #undef _VOICEMSG
464
465 // reserved sound names for the future (some models lack sounds for them):
466 //              _VOICEMSG(flagcarriertakingdamage) \
467 //              _VOICEMSG(getflag) \
468 // reserved sound names for the future (ALL models lack sounds for them):
469 //              _VOICEMSG(affirmative) \
470 //              _VOICEMSG(attacking) \
471 //              _VOICEMSG(defending) \
472 //              _VOICEMSG(roaming) \
473 //              _VOICEMSG(onmyway) \
474 //              _VOICEMSG(droppedflag) \
475 //              _VOICEMSG(negative) \
476 //              _VOICEMSG(seenenemy) \
477
478 string globalsound_fall;
479 string globalsound_metalfall;
480 string globalsound_step;
481 string globalsound_metalstep;
482
483 #define VOICETYPE_PLAYERSOUND 10
484 #define VOICETYPE_TEAMRADIO 11
485 #define VOICETYPE_LASTATTACKER 12
486 #define VOICETYPE_LASTATTACKER_ONLY 13
487 #define VOICETYPE_AUTOTAUNT 14
488 #define VOICETYPE_TAUNT 15
489
490 void PrecachePlayerSounds(string f);
491 void PrecacheGlobalSound(string samplestring);
492 void UpdatePlayerSounds();
493 void ClearPlayerSounds();
494 void PlayerSound(.string samplefield, float channel, float voicetype);
495 void GlobalSound(string samplestring, float channel, float voicetype);
496 void FakeGlobalSound(string samplestring, float channel, float voicetype);
497 void VoiceMessage(string type, string message);
498 float GetPlayerSoundSampleField_notFound;
499 .string GetVoiceMessageSampleField(string type)
500
501 // autotaunt system
502 .float cvar_cl_autotaunt;
503 .float cvar_cl_voice_directional;
504 .float cvar_cl_voice_directional_taunt_attenuation;
505
506 .float version_mismatch;
507
508 float independent_players;
509 #define INDEPENDENT_PLAYERS (autocvar__independent_players ? (autocvar__independent_players > 0) : independent_players)
510 #define IS_INDEPENDENT_PLAYER(e) ((e).solid == SOLID_TRIGGER)
511 #define MAKE_INDEPENDENT_PLAYER(e) (((e).solid = SOLID_TRIGGER) + ((e).frags = FRAGS_PLAYER_NONSOLID))
512 // we're using + here instead of , because fteqcc sucks
513
514 string clientstuff;
515 .float phase;
516 .float weapons;
517 .float pressedkeys;
518
519 .float porto_forbidden;
520
521 .string fog;
522
523 string cvar_changes;
524 string cvar_purechanges;
525 float cvar_purechanges_count;
526
527 float game_starttime; //point in time when the countdown is over
528 .float stat_game_starttime;
529
530 .float stat_sv_airaccel_qw;
531 .float stat_sv_airstrafeaccel_qw;
532 .float stat_sv_airspeedlimit_nonqw;
533 .float stat_sv_maxspeed;
534
535 void W_Porto_Remove (entity p);
536
537 .float projectiledeathtype;
538
539 .string message2;
540
541 vector railgun_start, railgun_end; // filled by FireRailgunBullet, used by damage code for head shot
542 .float stat_allow_oldnexbeam;
543
544 // reset to 0 on weapon switch
545 // may be useful to all weapons
546 .float bulletcounter;
547
548 void target_voicescript_next(entity pl);
549 void target_voicescript_clear(entity pl);
550
551 .string target2;
552 .string target3;
553 .string target4;
554 .float target_random;
555 .float trigger_reverse;
556
557 // Nexball 
558 .entity ballcarried; // Also used for keepaway
559 .float metertime;
560 float g_nexball_meter_period;
561
562 void SUB_DontUseTargets();
563 void SUB_UseTargets();
564
565 .void() reset; // if set, an entity is reset using this
566 .void() reset2; // if set, an entity is reset using this (after calling ALL the reset functions for other entities)
567
568 void ClientData_Touch(entity e);
569
570 vector debug_shotorg; // if non-zero, overrides the shot origin of all weapons
571
572 .float wasplayer;
573
574 float servertime, serverprevtime, serverframetime;
575
576 .entity soundentity;
577
578 .float ammo_fuel;
579
580 .vector prevorigin;
581
582 //flood fields
583 .float nickspamtime; // time of last nick change
584 .float nickspamcount;
585 .float floodcontrol_chat;
586 .float floodcontrol_chatteam;
587 .float floodcontrol_chattell;
588 .float floodcontrol_voice;
589 .float floodcontrol_voiceteam;
590
591 .float stat_shotorg; // networked stat for trueaim HUD
592
593 string matchid;
594 .float hitplotfh;
595 .string noise4;
596
597 .float last_pickup;
598
599 .float hit_time; 
600 .float typehit_time; 
601
602 .float stat_leadlimit;
603
604 float radar_showennemies;
605
606 #ifdef PROFILING
607 float client_cefc_accumulator;
608 float client_cefc_accumulatortime;
609 #endif
610
611 ..float current_ammo;
612
613 .float weapon_load[WEP_MAXCOUNT];
614 .float ammo_none; // used by the reloading system, must always be 0
615 .float clip_load;
616 .float old_clip_load;
617 .float clip_size;
618 .float minelayer_mines;
619
620 .float grab; // 0 = can't grab, 1 = owner can grab, 2 = owner and team mates can grab, 3 = anyone can grab
621
622 #define PROJECTILE_MAKETRIGGER(e) (e).solid = SOLID_CORPSE; (e).dphitcontentsmask = DPCONTENTS_SOLID | DPCONTENTS_BODY | DPCONTENTS_CORPSE
623 // when doing this, hagar can go through clones
624 // #define PROJECTILE_MAKETRIGGER(e) (e).solid = SOLID_BBOX
625
626 .float spectatee_status;
627 .float zoomstate;
628 .float bloodloss_timer;
629 .float restriction;
630
631 .entity clientdata;
632 .entity personal;
633
634 string deathmessage;
635
636 .float just_joined;
637
638 .float cvar_cl_accuracy_data_share;
639 .float cvar_cl_accuracy_data_receive;
640
641 .float cvar_cl_weaponimpulsemode;
642 .float selectweapon; // last selected weapon of the player
643
644 .float ballistics_density; // wall piercing factor, larger = bullet can pass through more
645
646 #define ACTIVE_NOT              0
647 #define ACTIVE_ACTIVE   1
648 #define ACTIVE_IDLE     2
649 #define ACTIVE_BUSY     2
650 #define ACTIVE_TOGGLE   3
651 .float active;
652 .float (float act_state) setactive;
653 .entity realowner;
654
655 .float nex_charge;
656 .float nex_charge_rottime;
657 .float nex_chargepool_ammo;
658
659 .float hagar_load;
660
661 float allowed_to_spawn; // boolean variable used by the clan arena code to determine if a player can spawn (after the round has ended)
662
663 float serverflags;
664
665 .float team_forced; // can be a team number to force a team, or 0 for default action, or -1 for forced spectator
666
667 .float freezetag_frozen;
668 .float freezetag_revive_progress;
669
670 .entity muzzle_flash;
671 .float misc_bulletcounter;      // replaces uzi & hlac bullet counter.
672
673 void PlayerUseKey();