]> git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blob - qcsrc/server/client.qh
Merge branch 'master' into z411/bai-server
[xonotic/xonotic-data.pk3dir.git] / qcsrc / server / client.qh
1 #pragma once
2
3 #include "utils.qh"
4 #include <server/intermission.qh>
5 #include <common/replicate.qh>
6 #include <common/sounds/all.qh>
7
8 bool autocvar__notarget;
9 int autocvar_g_balance_armor_start;
10 float autocvar_g_balance_pause_armor_rot_spawn;
11 float autocvar_g_balance_pause_fuel_rot_spawn;
12 float autocvar_g_balance_pause_health_regen_spawn;
13 float autocvar_g_balance_pause_health_rot_spawn;
14 bool autocvar_g_botclip_collisions;
15 bool autocvar_g_fullbrightplayers;
16 bool autocvar_g_playerclip_collisions;
17 float autocvar_g_player_alpha;
18 float autocvar_g_player_brightness;
19 float autocvar_g_player_damageforcescale = 2;
20 float autocvar_g_respawn_delay_small;
21 int autocvar_g_respawn_delay_small_count;
22 float autocvar_g_respawn_delay_large;
23 int autocvar_g_respawn_delay_large_count;
24 float autocvar_g_respawn_delay_max;
25 bool autocvar_g_respawn_delay_forced;
26 bool autocvar_g_respawn_ghosts;
27 float autocvar_g_respawn_ghosts_alpha = 1;
28 float autocvar_g_respawn_ghosts_fadetime = 1.5;
29 float autocvar_g_respawn_ghosts_time = 4.5;
30 float autocvar_g_respawn_ghosts_speed;
31 int autocvar_g_respawn_waves;
32 bool autocvar_g_nodepthtestplayers;
33 string autocvar_g_mutatormsg;
34 float autocvar_sv_foginterval;
35 float autocvar_sv_maxidle;
36 bool autocvar_sv_maxidle_spectatorsareidle;
37 int autocvar_sv_maxidle_slots;
38 bool autocvar_sv_maxidle_slots_countbots;
39 bool autocvar_g_forced_respawn;
40 int autocvar_g_maxplayers;
41 float autocvar_g_maxplayers_spectator_blocktime;
42 string autocvar_g_xonoticversion;
43 float autocvar_gameversion;
44 float autocvar_gameversion_min;
45 float autocvar_gameversion_max;
46 string autocvar_hostname;
47 int autocvar_spawn_debug;
48 string autocvar_sv_motd;
49 int autocvar_sv_name_maxlength = 64;
50 bool autocvar_sv_servermodelsonly;
51 int autocvar_sv_spectate;
52 bool autocvar_sv_teamnagger;
53 float autocvar_sv_player_scale;
54 bool autocvar_sv_showspectators;
55
56 // z411
57 string autocvar_hostname_full;
58 string autocvar_g_teamnames_red;
59 string autocvar_g_teamnames_blue;
60 string autocvar_g_teamnames_yellow;
61 string autocvar_g_teamnames_pink;
62
63 // WEAPONTODO
64 .string weaponorder_byimpulse;
65
66 .entity clientdata;
67
68 .float jointime; // time of connecting
69 .float startplaytime; // time of switching from spectator to player
70 .float alivetime; // time of being alive
71 .float motd_actived_time; // used for both motd and campaign_message
72
73 .bool wasplayer;
74
75 .int spectatee_status;
76 .bool zoomstate;
77
78 .bool just_joined;
79
80 .int pressedkeys;
81
82 .int playerid;
83
84 .string playermodel;
85 .string playerskin;
86
87 void ClientState_attach(entity this);
88
89 IntrusiveList g_players;
90 STATIC_INIT(g_players) { g_players = IL_NEW(); }
91
92 CLASS(Client, Object)
93     /** Client name */
94     ATTRIB(Client, netname, string, this.netname);
95     ATTRIB(Client, colormap, int, this.colormap);
96     ATTRIB(Client, team, int, this.team);
97     ATTRIB(Client, clientcolors, int, this.clientcolors);
98         ATTRIB(Client, countrycode, int, this.countrycode);
99     /** Client IP */
100     ATTRIB(Client, netaddress, string, this.netaddress);
101     ATTRIB(Client, playermodel, string, this.playermodel);
102     ATTRIB(Client, playerskin, string, this.playerskin);
103
104     /** fingerprint of CA key the player used to authenticate */
105     ATTRIB(Client, crypto_keyfp, string, this.crypto_keyfp);
106     /** fingerprint of CA key the server used to authenticate to the player */
107     ATTRIB(Client, crypto_mykeyfp, string, this.crypto_mykeyfp);
108     /** fingerprint of ID used by the player entity, or string_null if not identified */
109     ATTRIB(Client, crypto_idfp, string, this.crypto_idfp);
110     /** set if the player's ID has been signed */
111     ATTRIB(Client, crypto_idfp_signed, bool, this.crypto_idfp_signed);
112     /** the string "AES128" if encrypting, and string_null if plaintext */
113     ATTRIB(Client, crypto_encryptmethod, string, this.crypto_encryptmethod);
114     /** the string "HMAC-SHA256" if signing, and string_null if plaintext */
115     ATTRIB(Client, crypto_signmethod, string, this.crypto_signmethod);
116
117     // engine client fields
118     ATTRIB(Client, impulse, int, this.impulse);
119
120     ATTRIB(Client, button0, int, this.button0);
121     ATTRIB(Client, button2, int, this.button2);
122     ATTRIB(Client, button3, int, this.button3);
123     ATTRIB(Client, button4, int, this.button4);
124     ATTRIB(Client, button5, int, this.button5);
125     ATTRIB(Client, button6, int, this.button6);
126     ATTRIB(Client, button7, int, this.button7);
127     ATTRIB(Client, button8, int, this.button8);
128     ATTRIB(Client, button9, int, this.button9);
129     ATTRIB(Client, button10, int, this.button10);
130     ATTRIB(Client, button11, int, this.button11);
131     ATTRIB(Client, button12, int, this.button12);
132     ATTRIB(Client, button13, int, this.button13);
133     ATTRIB(Client, button14, int, this.button14);
134     ATTRIB(Client, button15, int, this.button15);
135     ATTRIB(Client, button16, int, this.button16);
136     ATTRIB(Client, buttonuse, int, this.buttonuse);
137     ATTRIB(Client, buttonchat, int, this.buttonchat);
138
139     ATTRIB(Client, cursor_active, int, this.cursor_active);
140     ATTRIB(Client, cursor_screen, vector, this.cursor_screen);
141     ATTRIB(Client, cursor_trace_start, vector, this.cursor_trace_start);
142     ATTRIB(Client, cursor_trace_endpos, vector, this.cursor_trace_endpos);
143     ATTRIB(Client, cursor_trace_ent, entity, this.cursor_trace_ent);
144
145     ATTRIB(Client, ping, float, this.ping);
146     ATTRIB(Client, ping_packetloss, float, this.ping_packetloss);
147     ATTRIB(Client, ping_movementloss, float, this.ping_movementloss);
148
149     ATTRIB(Client, v_angle, vector, this.v_angle);
150     ATTRIB(Client, movement, vector, this.movement);
151
152     // custom
153
154     ATTRIB(Client, playerid, int, this.playerid);
155
156     ATTRIB(Client, parm_idlesince, int, this.parm_idlesince);
157     ATTRIB(Client, muted, bool, this.muted);
158     ATTRIB(Client, idlekick_lasttimeleft, float, this.idlekick_lasttimeleft);
159     ATTRIB(Client, pm_frametime, float, this.pm_frametime);
160     ATTRIB(Client, pressedkeys, int, this.pressedkeys);
161     ATTRIB(Client, movement_old, vector, this.movement_old);
162     ATTRIB(Client, buttons_old, int, this.buttons_old);
163     ATTRIB(Client, teamkill_complain, float, this.teamkill_complain);
164     ATTRIB(Client, teamkill_soundtime, float, this.teamkill_soundtime);
165     ATTRIB(Client, teamkill_soundsource, entity, this.teamkill_soundsource);
166     ATTRIB(Client, usekeypressed, bool, this.usekeypressed);
167     ATTRIB(Client, motd_actived_time, float, this.motd_actived_time);
168     ATTRIB(Client, jointime, float, this.jointime);
169     ATTRIB(Client, spectatortime, float, this.spectatortime);
170     ATTRIB(Client, startplaytime, float, this.startplaytime);
171     ATTRIB(Client, version_nagtime, float, this.version_nagtime);
172     ATTRIB(Client, netname_previous, string, this.netname_previous);
173     ATTRIB(Client, allowed_timeouts, int, this.allowed_timeouts);
174     ATTRIB(Client, active_minigame, entity, this.active_minigame);
175     ATTRIB(Client, taunt_soundtime, float, this.taunt_soundtime);
176     ATTRIB(Client, killcount, int, this.killcount);
177     ATTRIB(Client, version_mismatch, bool, this.version_mismatch);
178     ATTRIB(Client, version, int, this.version);
179     ATTRIB(Client, spectatee_status, int, this.spectatee_status);
180     ATTRIB(Client, zoomstate, bool, this.zoomstate);
181     ATTRIB(Client, just_joined, bool, this.just_joined);
182     ATTRIB(Client, race_completed, bool, this.race_completed);
183     ATTRIBARRAY(Client, msg_choice_choices, int, 20); // TODO: actually NOTIF_CHOICE_MAX
184     ATTRIB(Client, latency_sum, float, this.latency_sum);
185     ATTRIB(Client, latency_cnt, int, this.latency_cnt);
186     ATTRIB(Client, latency_time, float, this.latency_time);
187     ATTRIB(Client, v_angle_old, vector, this.v_angle_old);
188     ATTRIB(Client, model_randomizer, float, this.model_randomizer);
189     ATTRIB(Client, accuracy, entity, this.accuracy);
190     ATTRIB(Client, hasweapon_complain_spam, float, this.hasweapon_complain_spam);
191     ATTRIB(Client, scorekeeper, entity, this.scorekeeper);
192     ATTRIB(Client, specialcommand_pos, int, this.specialcommand_pos);
193     ATTRIB(Client, hitplotfh, int, this.hitplotfh);
194     ATTRIB(Client, clientdata, entity, this.clientdata);
195     ATTRIB(Client, cmd_floodcount, int, this.cmd_floodcount);
196     ATTRIB(Client, cmd_floodtime, float, this.cmd_floodtime);
197     ATTRIB(Client, wasplayer, bool, this.wasplayer);
198     ATTRIB(Client, weaponorder_byimpulse, string, this.weaponorder_byimpulse);
199     ATTRIB(Client, autojoin_checked, int, this.wasplayer);
200
201     // networked cvars
202
203     ATTRIB(Client, cvar_cl_allow_uid2name, int, this.cvar_cl_allow_uid2name);
204     ATTRIB(Client, cvar_cl_allow_uidtracking, int, this.cvar_cl_allow_uidtracking);
205     ATTRIB(Client, cvar_cl_autotaunt, float, this.cvar_cl_autotaunt);
206     ATTRIB(Client, cvar_cl_voice_directional, int, this.cvar_cl_voice_directional);
207     ATTRIB(Client, cvar_cl_voice_directional_taunt_attenuation, float, this.cvar_cl_voice_directional_taunt_attenuation);
208     ATTRIB(Client, cvar_cl_physics, string, this.cvar_cl_physics);
209     ATTRIB(Client, cvar_cl_buffs_autoreplace, bool, this.cvar_cl_buffs_autoreplace);
210     ATTRIB(Client, cvar_cl_nade_type, int, this.cvar_cl_nade_type);
211     ATTRIB(Client, cvar_cl_pokenade_type, string, this.cvar_cl_pokenade_type);
212     ATTRIB(Client, cvar_cl_spawn_near_teammate, bool, this.cvar_cl_spawn_near_teammate);
213     ATTRIB(Client, cvar_cl_gunalign, int, this.cvar_cl_gunalign);
214         ATTRIB(Client, cvar_cl_chat_sounds, bool, this.cvar_cl_chat_sounds);
215     ATTRIB(Client, cvar_cl_handicap, float, this.cvar_cl_handicap);
216     ATTRIB(Client, cvar_cl_clippedspectating, bool, this.cvar_cl_clippedspectating);
217     ATTRIB(Client, cvar_cl_autoscreenshot, int, this.cvar_cl_autoscreenshot);
218     ATTRIB(Client, cvar_cl_jetpack_jump, bool, this.cvar_cl_jetpack_jump);
219     ATTRIB(Client, cvar_cl_newusekeysupported, bool, this.cvar_cl_newusekeysupported);
220     ATTRIB(Client, cvar_cl_noantilag, bool, this.cvar_cl_noantilag);
221     ATTRIB(Client, cvar_cl_movement_track_canjump, bool, this.cvar_cl_movement_track_canjump);
222     ATTRIB(Client, cvar_cl_weaponimpulsemode, int, this.cvar_cl_weaponimpulsemode);
223     ATTRIB(Client, cvar_g_xonoticversion, string, this.cvar_g_xonoticversion);
224     ATTRIB(Client, autoswitch, bool, this.autoswitch);
225     ATTRIB(Client, cvar_cl_casings, bool, this.cvar_cl_casings);
226     ATTRIB(Client, cvar_cl_dodging_timeout, float, this.cvar_cl_dodging_timeout);
227     ATTRIB(Client, cvar_cl_dodging, float, this.cvar_cl_dodging);
228     ATTRIB(Client, cvar_cl_multijump, bool, this.cvar_cl_multijump);
229     ATTRIB(Client, cvar_cl_accuracy_data_share, bool, this.cvar_cl_accuracy_data_share);
230     ATTRIB(Client, cvar_cl_accuracy_data_receive, bool, this.cvar_cl_accuracy_data_receive);
231     ATTRIBARRAY(Client, cvar_cl_weaponpriorities, string, 10);
232     ATTRIB(Client, cvar_cl_weaponpriority, string, this.cvar_cl_weaponpriority);
233     ATTRIB(Client, cvar_cl_cts_noautoswitch, bool, this.cvar_cl_cts_noautoswitch);
234     ATTRIB(Client, cvar_cl_weapon_switch_reload, bool, this.cvar_cl_weapon_switch_reload);
235     ATTRIB(Client, cvar_cl_weapon_switch_fallback_to_impulse, bool, this.cvar_cl_weapon_switch_fallback_to_impulse);
236
237     METHOD(Client, m_unwind, bool(Client this));
238
239     STATIC_METHOD(Client, Add, void(Client this, int _team));
240     STATIC_METHOD(Client, Remove, void(Client this));
241
242     INIT(Client) {
243         if (this.m_unwind(this)) return this;
244         make_impure(this);
245         this.classname = "player_joining";
246         static int playerid_last;
247         this.playerid = ++playerid_last;
248         ClientState_attach(this);
249     }
250     DESTRUCTOR(Client) {
251         Client_Remove(this);
252     }
253     CONSTRUCTOR(Client, string name) {
254         CONSTRUCT(Client);
255         this.netname = name;
256         this.netaddress = "local";
257         this.playermodel = cvar_defstring("sv_defaultplayermodel");
258     }
259 ENDCLASS(Client)
260
261 CLASS(Observer, Client)
262     INIT(Observer) {
263         this.classname = STR_OBSERVER;
264     }
265     DESTRUCTOR(Observer) { }
266 ENDCLASS(Observer)
267
268 CLASS(Spectator, Client)
269     INIT(Spectator) {
270         this.classname = STR_SPECTATOR;
271     }
272     DESTRUCTOR(Spectator) { }
273 ENDCLASS(Spectator)
274
275 CLASS(Player, Client)
276
277     // custom
278
279     ATTRIB(Player, dual_weapons, vector, this.dual_weapons); // TODO: actually WepSet!
280     ATTRIB(Player, itemkeys, int, this.itemkeys);
281     ATTRIB(Player, ballistics_density, float, this.ballistics_density);
282     ATTRIB(Player, prevstrengthsound, float, this.prevstrengthsound);
283     ATTRIB(Player, prevstrengthsoundattempt, float, this.prevstrengthsoundattempt);
284     ATTRIB(Player, buff_shield, float, this.buff_shield);
285
286     INIT(Player) {
287         this.classname = STR_PLAYER;
288         IL_PUSH(g_players, this);
289     }
290     DESTRUCTOR(Player) {
291         IL_REMOVE(g_players, this);
292     }
293 ENDCLASS(Player)
294
295 METHOD(Client, m_unwind, bool(Client this))
296 {
297     TC(Client, this);
298     #define UNWIND(class) MACRO_BEGIN if (this.instanceOf##class) { METHOD_REFERENCE(class, dtorimpl)(this); } MACRO_END
299     switch (this.classname) {
300         case "Observer":
301             UNWIND(Spectator);
302             UNWIND(Player);
303             return true;
304         case "Spectator":
305             UNWIND(Observer);
306             UNWIND(Player);
307             return true;
308         case "Player":
309             UNWIND(Observer);
310             UNWIND(Spectator);
311             return true;
312     }
313     #undef UNWIND
314     return false;
315 }
316
317 int autocvar__independent_players;
318 bool independent_players;
319 #define INDEPENDENT_PLAYERS (autocvar__independent_players ? (autocvar__independent_players > 0) : independent_players)
320 #define IS_INDEPENDENT_PLAYER(e) ((e).solid == SOLID_TRIGGER)
321 #define MAKE_INDEPENDENT_PLAYER(e) (((e).solid = SOLID_TRIGGER), ((e).frags = FRAGS_PLAYER_OUT_OF_GAME))
322
323 .float lastkill;
324 .int countrycode;
325 .int killcount;
326
327 //flood fields
328 .float nickspamtime; // time of last nick change
329 .float nickspamcount;
330
331 // respawning
332 .int respawn_flags;
333 .float respawn_time;
334 .float respawn_time_max;
335
336 .float respawn_countdown; // next number to count
337
338 const int RESPAWN_FORCE = BIT(0);
339 const int RESPAWN_SILENT = BIT(1);
340 const int RESPAWN_DENY = BIT(2);
341
342 float blockSpectators; // if set, new or existing spectators or observers will be removed unless they become a player within g_maxplayers_spectator_blocktime seconds
343 .float spectatortime; // point in time since the client is spectating or observing
344
345 .bool player_blocked;
346
347 const int SVC_SETVIEW = 5; // TODO: move to dpdefs where this belongs!
348
349 // TODO: standardise resource regeneration
350 .float pauseregen_finished;
351 .float pauserothealth_finished;
352 .float pauserotarmor_finished;
353 .float pauserotfuel_finished;
354
355 // g_<gametype>_str:
356 // If 0, default is used.
357 // If <0, 0 is used.
358 // Otherwise, g_str (default value) is used.
359 // For consistency, negative values there are mapped to zero too.
360 #define GAMETYPE_DEFAULTED_SETTING(str) \
361     ((gametype_setting_tmp = cvar(strcat("g_", GetGametype(), "_" #str))), \
362     (gametype_setting_tmp < 0) ? 0 \
363     : (gametype_setting_tmp == 0 || autocvar_g_respawn_delay_forced) ? max(0, autocvar_g_##str) \
364     : gametype_setting_tmp)
365
366 void calculate_player_respawn_time(entity this);
367
368 bool PlayerInList(entity player, string list);
369
370 void ClientData_Touch(entity e);
371
372 int nJoinAllowed(entity this, entity ignore);
373
374 void checkSpectatorBlock(entity this);
375
376 void PlayerUseKey(entity this);
377
378 void FixClientCvars(entity e);
379
380 // called when a client connects, useful for updating sounds and such of static objects
381 .void(entity this, entity player) init_for_player;
382
383 IntrusiveList g_initforplayer;
384 STATIC_INIT(g_initforplayer) { g_initforplayer = IL_NEW(); }
385
386 void play_countdown(entity this, float finished, Sound samp);
387
388 void RotRegen(entity this, float current, float regenstable, float regenfactor, float regenlinear, float regenframetime, float rotstable, float rotfactor, float rotlinear, float rotframetime, float limit_mod);
389
390 bool Spectate(entity this, entity pl);
391
392 void ClientInit_Spawn();
393
394 void PutObserverInServer(entity this);
395
396 void SetSpectatee(entity this, entity spectatee);
397 void SetSpectatee_status(entity this, int spectatee_num);
398
399 void FixPlayermodel(entity player);
400
401 void ClientInit_misc(entity this);
402
403 int GetPlayerLimit();
404
405 const int MIN_SPEC_TIME = 1;
406 bool joinAllowed(entity this);
407 void Join(entity this);
408
409 #define SPECTATE_COPY() ACCUMULATE void SpectateCopy(entity this, entity spectatee)
410 #define SPECTATE_COPYFIELD(fld) SPECTATE_COPY() { this.(fld) = spectatee.(fld); }
411
412 const int MAX_SPECTATORS = 7;
413
414 float _medal_times;
415 #define Give_Medal(entity,medalname) \
416         _medal_times = GameRules_scoring_add(entity, MEDAL_##medalname, 1); \
417         Send_Notification(NOTIF_ONE, entity, MSG_MEDAL, MEDAL_##medalname, _medal_times);