]> de.git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blob - qcsrc/server/defs.qh
Doxygen: improve
[xonotic/xonotic-data.pk3dir.git] / qcsrc / server / defs.qh
1 #pragma once
2
3 #include <common/weapons/all.qh>
4 #include <common/stats.qh>
5
6 #define INDEPENDENT_ATTACK_FINISHED 1
7
8 // Globals
9
10 float g_footsteps, g_grappling_hook, g_instagib;
11 float g_warmup_limit;
12 float g_warmup_allguns;
13 float g_warmup_allow_timeout;
14 float warmup_stage;
15 PROPERTY(float, g_pickup_respawntime_weapon)
16 PROPERTY(float, g_pickup_respawntime_superweapon)
17 PROPERTY(float, g_pickup_respawntime_ammo)
18 PROPERTY(float, g_pickup_respawntime_short)
19 PROPERTY(float, g_pickup_respawntime_medium)
20 PROPERTY(float, g_pickup_respawntime_long)
21 PROPERTY(float, g_pickup_respawntime_powerup)
22 PROPERTY(float, g_pickup_respawntimejitter_weapon)
23 PROPERTY(float, g_pickup_respawntimejitter_superweapon)
24 PROPERTY(float, g_pickup_respawntimejitter_ammo)
25 PROPERTY(float, g_pickup_respawntimejitter_short)
26 PROPERTY(float, g_pickup_respawntimejitter_medium)
27 PROPERTY(float, g_pickup_respawntimejitter_long)
28 PROPERTY(float, g_pickup_respawntimejitter_powerup)
29 float g_jetpack;
30
31 float sv_clones;
32 float sv_foginterval;
33
34 float player_count;
35 float currentbots;
36 float bots_would_leave;
37
38 void UpdateFrags(entity player, float f);
39 .float totalfrags;
40
41 float team1_score, team2_score, team3_score, team4_score;
42
43 // flag set on worldspawn so that the code knows if it is dedicated or not
44 float server_is_dedicated;
45
46 // Fields
47
48 .void(entity this, entity inflictor, entity attacker, float damage, int deathtype, vector hitloc, vector force) event_damage;
49
50 //.string       wad;
51 //.string       map;
52
53 //.float        worldtype;
54 // Needed for dynamic clientwalls
55 .float inactive; // Clientwall disappears when inactive
56 .float alpha_max, alpha_min;
57 .float fade_start, fade_end, fade_vertical_offset;
58 .float default_solid; // Variable to store default self.solid for clientwalls
59
60 .float  pain_finished;                  //Added by Supajoe
61 .float  pain_frame;                     //"
62 .float  crouch; // Crouching or not?
63
64 .float  strength_finished = _STAT(STRENGTH_FINISHED);
65 .float  invincible_finished = _STAT(INVINCIBLE_FINISHED);
66 .float  superweapons_finished = _STAT(SUPERWEAPONS_FINISHED);
67
68 .float cnt; // used in too many places
69 .float count;
70 //.float cnt2;
71
72 .float play_time;
73 .int respawn_flags;
74 .float respawn_time;
75 .float respawn_time_max;
76 .float death_time;
77 .float fade_time;
78 .float fade_rate;
79
80 void() player_setupanimsformodel;
81
82 .string mdl;
83
84 .string playermodel;
85 .string playerskin;
86
87 .float species;
88
89 .float  scheduledrespawntime;
90 .float  respawntime;
91 .float  respawntimejitter;
92 .float  respawntimestart;
93 //.float        chasecam;
94
95 .float  damageforcescale;
96 const float MIN_DAMAGEEXTRARADIUS = 2;
97 const float MAX_DAMAGEEXTRARADIUS = 16;
98 .float damageextraradius;
99
100 //.float          gravity;
101
102 .float          dmg;
103
104 // for railgun damage (hitting multiple enemies)
105 .float railgunhit;
106 .float railgunhitsolidbackup;
107 .vector railgunhitloc;
108
109 .float          air_finished;
110 .float          dmgtime;
111
112 .float          killcount;
113 .float damage_dealt, typehitsound;
114
115 .float watersound_finished;
116 .float iscreature;
117 .float damagedbycontents;
118 .float damagedbytriggers;
119 .float teleportable;
120 .vector oldvelocity;
121
122 .float pauseregen_finished;
123 .float pauserothealth_finished;
124 .float pauserotarmor_finished;
125 .float pauserotfuel_finished;
126 // string overrides entity
127 .string item_pickupsound;
128 .entity item_pickupsound_ent;
129 .entity item_model_ent;
130
131 // WEAPONTODO
132 .float autoswitch;
133 bool client_hasweapon(entity cl, Weapon wpn, float andammo, bool complain);
134 void w_clear(Weapon thiswep, entity actor, .entity weaponentity, int fire);
135 void w_ready(Weapon thiswep, entity actor, .entity weaponentity, int fire);
136 // VorteX: standalone think for weapons, so normal think on weaponentity can be reserved by weaponflashes (which needs update even player dies)
137 .float weapon_nextthink;
138 .void(Weapon thiswep, entity actor, .entity weaponentity, int fire) weapon_think;
139
140
141 // there is 2 weapon tics that can run in one server frame
142 const int W_TICSPERFRAME = 2;
143
144 void weapon_defaultspawnfunc(entity this, Weapon e);
145
146 float gameover;
147 float intermission_running;
148 float intermission_exittime;
149 float alreadychangedlevel;
150
151 .float version;
152
153 // footstep interval
154 .float nextstep;
155
156 float blockSpectators; //if set, new or existing spectators or observers will be removed unless they become a player within g_maxplayers_spectator_blocktime seconds
157 .float spectatortime; //point in time since the client is spectating or observing
158 void checkSpectatorBlock();
159
160 float game_completion_ratio; // 0 at start, 1 near end
161 .float winning;
162 .float jointime; // time of joining
163 .float alivetime; // time of being alive
164 .float motd_actived_time; // used for both motd and campaign_message
165
166 bool nJoinAllowed(entity this, entity ignore);
167
168 .float spawnshieldtime;
169 .float item_spawnshieldtime;
170
171 .entity flagcarried;
172
173 .int playerid;
174 float playerid_last;
175 .float noalign;         // if set to 1, the item or spawnpoint won't be dropped to the floor
176
177 .vector death_origin;
178 .vector killer_origin;
179
180 float default_player_alpha;
181 float default_weapon_alpha;
182
183 .float() customizeentityforclient;
184 .float cvar_cl_handicap;
185 .float cvar_cl_clippedspectating;
186 .float cvar_cl_autoscreenshot;
187 .float cvar_cl_jetpack_jump;
188 .float cvar_cl_movement_track_canjump = _STAT(MOVEVARS_CL_TRACK_CANJUMP);
189 .float cvar_cl_newusekeysupported;
190
191 .string cvar_g_xonoticversion;
192 .string cvar_cl_weaponpriority;
193 .string cvar_cl_weaponpriorities[10];
194 .float cvar_cl_noantilag;
195
196 .string weaponorder_byimpulse;
197
198 .float cvar_cl_allow_uid2name;
199 .float cvar_cl_allow_uidtracking;
200 .string stored_netname;
201
202 .float version_nagtime;
203
204 string gamemode_name;
205
206 float startitem_failed;
207
208 string W_Apply_Weaponreplace(string in);
209
210 void FixIntermissionClient(entity e);
211 void FixClientCvars(entity e);
212
213 // WEAPONTODO: remove this
214 WepSet weaponsInMap;
215
216 #define weapons _STAT(WEAPONS)
217 #define weaponsinmap _STAT(WEAPONSINMAP)
218
219 .float respawn_countdown; // next number to count
220
221 float bot_waypoints_for_items;
222
223 .float attack_finished_for[Weapons_MAX * MAX_WEAPONSLOTS];
224 .float attack_finished_single[MAX_WEAPONSLOTS];
225 #if INDEPENDENT_ATTACK_FINISHED
226 #define ATTACK_FINISHED_FOR(ent, w, slot) ((ent).(attack_finished_for[((w) - WEP_FIRST) * MAX_WEAPONSLOTS + (slot)]))
227 #else
228 #define ATTACK_FINISHED_FOR(ent, w, slot) ((ent).attack_finished_single[slot])
229 #endif
230 #define ATTACK_FINISHED(ent, slot) ATTACK_FINISHED_FOR(ent, PS(ent).m_weapon.m_id, slot)
231
232 // assault game mode: Which team is attacking in this round?
233 float assault_attacker_team;
234
235 // speedrun: when 1, player auto teleports back when capture timeout happens
236 .float speedrunning;
237
238 // database
239 float ServerProgsDB;
240 float TemporaryDB;
241
242 .float team_saved;
243
244 float some_spawn_has_been_used;
245 float have_team_spawns; // 0 = no team spawns requested, -1 = team spawns requested but none found, 1 = team spawns requested and found
246 float have_team_spawns_forteam[17]; // 0 = this team has no spawns, 1 = this team has spawns; team 0 is the "no-team"
247
248 // set when showing a kill countdown
249 .entity killindicator;
250 .float killindicator_teamchange;
251
252 void Damage (entity targ, entity inflictor, entity attacker, float damage, int deathtype, vector hitloc, vector force);
253
254 float lockteams;
255
256 .float parm_idlesince;
257 float sv_maxidle;
258 float sv_maxidle_spectatorsareidle;
259
260 float tracebox_hits_trigger_hurt(vector start, vector mi, vector ma, vector end);
261
262 float next_pingtime;
263
264 // autotaunt system
265 .float cvar_cl_autotaunt;
266 .float cvar_cl_voice_directional;
267 .float cvar_cl_voice_directional_taunt_attenuation;
268
269 .float version_mismatch;
270
271 int autocvar__independent_players;
272 bool independent_players;
273 #define INDEPENDENT_PLAYERS (autocvar__independent_players ? (autocvar__independent_players > 0) : independent_players)
274 #define IS_INDEPENDENT_PLAYER(e) ((e).solid == SOLID_TRIGGER)
275 #define MAKE_INDEPENDENT_PLAYER(e) (((e).solid = SOLID_TRIGGER), ((e).frags = FRAGS_PLAYER_NONSOLID))
276
277 string clientstuff;
278 .float phase;
279 .int pressedkeys = _STAT(PRESSED_KEYS);
280
281 .string fog;
282
283 string cvar_changes;
284 string cvar_purechanges;
285 float cvar_purechanges_count;
286
287 float game_starttime; //point in time when the countdown to game start is over
288 float round_starttime; //point in time when the countdown to round start is over
289 .float stat_game_starttime = _STAT(GAMESTARTTIME);
290 .float stat_round_starttime = _STAT(ROUNDSTARTTIME);
291
292 void W_Porto_Remove (entity p);
293
294 .int projectiledeathtype;
295
296 .string message2;
297
298 .bool stat_allow_oldvortexbeam = _STAT(ALLOW_OLDVORTEXBEAM);
299
300 // reset to 0 on weapon switch
301 // may be useful to all weapons
302 .float bulletcounter;
303
304 // Nexball
305 .entity ballcarried; // Also used for keepaway
306 float g_nexball_meter_period;
307
308 void SUB_DontUseTargets();
309 void SUB_UseTargets();
310
311 .void(entity this) reset; // if set, an entity is reset using this
312 .void() reset2; // if set, an entity is reset using this (after calling ALL the reset functions for other entities)
313
314 void ClientData_Touch(entity e);
315
316 //vector debug_shotorg; // if non-zero, overrides the shot origin of all weapons
317
318 .float wasplayer;
319
320 float servertime, serverprevtime, serverframetime;
321
322 .float ammo_fuel;
323
324 .vector prevorigin;
325
326 //flood fields
327 .float nickspamtime; // time of last nick change
328 .float nickspamcount;
329 .float floodcontrol_chat;
330 .float floodcontrol_chatteam;
331 .float floodcontrol_chattell;
332 .float floodcontrol_voice;
333 .float floodcontrol_voiceteam;
334
335 .float stat_shotorg = _STAT(SHOTORG); // networked stat for trueaim HUD
336
337 string matchid;
338
339 .float last_pickup = _STAT(LAST_PICKUP);
340
341 .float hit_time = _STAT(HIT_TIME);
342 .float typehit_time = _STAT(TYPEHIT_TIME);
343
344 .float damage_dealt_total = _STAT(DAMAGE_DEALT_TOTAL);
345
346 .float stat_leadlimit = _STAT(LEADLIMIT);
347
348 bool radar_showennemies;
349
350 #ifdef PROFILING
351 float client_cefc_accumulator;
352 float client_cefc_accumulatortime;
353 #endif
354
355 .float weapon_load[Weapons_MAX];
356 .int ammo_none; // used by the reloading system, must always be 0
357 .float clip_load = _STAT(WEAPON_CLIPLOAD);
358 .float old_clip_load;
359 .float clip_size = _STAT(WEAPON_CLIPSIZE);
360
361 .float minelayer_mines = _STAT(LAYED_MINES);
362 .float vortex_charge = _STAT(VORTEX_CHARGE);
363 .float vortex_charge_rottime;
364 .float vortex_chargepool_ammo = _STAT(VORTEX_CHARGEPOOL);
365 .float hagar_load = _STAT(HAGAR_LOAD);
366
367 .int grab; // 0 = can't grab, 1 = owner can grab, 2 = owner and team mates can grab, 3 = anyone can grab
368
369 #define PROJECTILE_MAKETRIGGER(e) (e).solid = SOLID_CORPSE; (e).dphitcontentsmask = DPCONTENTS_SOLID | DPCONTENTS_BODY | DPCONTENTS_CORPSE
370 // when doing this, hagar can go through clones
371 // #define PROJECTILE_MAKETRIGGER(e) (e).solid = SOLID_BBOX
372
373 .float spectatee_status;
374 .float zoomstate;
375 .float restriction;
376
377 .entity clientdata;
378 .entity personal;
379
380 string deathmessage;
381
382 .float just_joined;
383
384 .float cvar_cl_weaponimpulsemode;
385 .float selectweapon; // last selected weapon of the player
386
387 .float ballistics_density; // wall piercing factor, larger = bullet can pass through more
388
389 const float ACTIVE_NOT          = 0;
390 const float ACTIVE_ACTIVE       = 1;
391 const float ACTIVE_IDLE         = 2;
392 const float ACTIVE_BUSY         = 2;
393 const float ACTIVE_TOGGLE       = 3;
394 .float active;
395 .void (float act_state) setactive;
396 .entity realowner;
397
398 //float serverflags;
399
400 .float team_forced; // can be a team number to force a team, or 0 for default action, or -1 for forced spectator
401
402 .float player_blocked;
403 .float weapon_blocked; // weapon use disabled
404
405 .float frozen = _STAT(FROZEN); // for freeze attacks
406 .float revive_progress = _STAT(REVIVE_PROGRESS);
407 .float revival_time; // time at which player was last revived
408 .float revive_speed; // NOTE: multiplier (anything above 1 is instaheal)
409 .entity iceblock;
410 .entity frozen_by; // for ice fields
411
412 .entity muzzle_flash;
413 .float misc_bulletcounter;      // replaces uzi & hlac bullet counter.
414
415 .float stat_respawn_time = _STAT(RESPAWN_TIME); // shows respawn time, and is negative when awaiting respawn
416
417 void PlayerUseKey();
418
419 USING(spawn_evalfunc_t, vector(entity player, entity spot, vector current));
420 .spawn_evalfunc_t spawn_evalfunc;
421
422 string modname;
423
424 .float missile_flags;
425 const int MIF_SPLASH = BIT(1);
426 const int MIF_ARC = BIT(2);
427 const int MIF_PROXY = BIT(3);
428 const int MIF_GUIDED_MANUAL = BIT(4);
429 const int MIF_GUIDED_HEAT = BIT(5);
430 const int MIF_GUIDED_LASER = BIT(6);
431 const int MIF_GUIDED_AI = BIT(7);
432 const int MIF_GUIDED_TAG = BIT(7);
433 const int MIF_GUIDED_ALL = MIF_GUIDED_MANUAL | MIF_GUIDED_HEAT | MIF_GUIDED_LASER | MIF_GUIDED_AI | MIF_GUIDED_TAG;
434 const int MIF_GUIDED_TRACKING = MIF_GUIDED_HEAT | MIF_GUIDED_LASER | MIF_GUIDED_AI | MIF_GUIDED_TAG;
435 const int MIF_GUIDED_CONFUSABLE = MIF_GUIDED_HEAT | MIF_GUIDED_AI;
436
437 #define MISSILE_IS_CONFUSABLE(m) ((m.missile_flags & MIF_GUIDED_CONFUSABLE) ? true : false)
438 #define MISSILE_IS_GUIDED(m) ((m.missile_flags & MIF_GUIDED_ALL) ? true : false)
439 #define MISSILE_IS_TRACKING(m) ((m.missile_flags & MIF_GUIDED_TRACKING) ? true : false)
440
441
442 ////
443
444 .entity player_stats;
445 //.float playerid;
446 .string playernick;
447 .float elos;
448 .float ranks;
449
450 .string cvar_cl_physics;
451
452 .float init_for_player_needed;
453 .void(entity) init_for_player;