Register the ranking cvar in CSQC so it has a default value on older clients
[xonotic/xonotic-data.pk3dir.git] / qcsrc / client / main.qc
1 #include "main.qh"
2
3 #include "defs.qh"
4 #include <common/ent_cs.qh>
5 #include "miscfunctions.qh"
6 #include <common/effects/effect.qh>
7 #include <common/effects/qc/_mod.qh>
8 #include <common/effects/all.qh>
9 #include <common/effects/all.inc>
10 #include "hud/_mod.qh"
11 #include "commands/cl_cmd.qh"
12 #include "mapvoting.qh"
13 #include <client/mutators/_mod.qh>
14 #include "hud/panel/scoreboard.qh"
15 #include "hud/panel/quickmenu.qh"
16 #include "shownames.qh"
17 #include "view.qh"
18 #include <common/t_items.qh>
19 #include "weapons/projectile.qh"
20 #include <common/deathtypes/all.qh>
21 #include <common/items/_mod.qh>
22 #include <common/mapinfo.qh>
23 #include <common/minigames/cl_minigames.qh>
24 #include <common/minigames/cl_minigames_hud.qh>
25 #include <common/net_linked.qh>
26 #include <common/net_notice.qh>
27 #include <common/scores.qh>
28 #include <common/mapobjects/_mod.qh>
29 #include <common/vehicles/all.qh>
30 #include <lib/csqcmodel/cl_model.qh>
31 #include <lib/csqcmodel/interpolate.qh>
32 #include <lib/warpzone/client.qh>
33
34 // --------------------------------------------------------------------------
35 // BEGIN REQUIRED CSQC FUNCTIONS
36 //include "main.qh"
37
38 #define DP_CSQC_ENTITY_REMOVE_IS_B0RKED
39
40 void draw_cursor(vector pos, vector ofs, string img, vector col, float a)
41 {
42         ofs = vec2(ofs.x * SIZE_CURSOR.x, ofs.y * SIZE_CURSOR.y);
43         drawpic(pos - ofs, strcat(draw_currentSkin, img), SIZE_CURSOR, col, a, DRAWFLAG_NORMAL);
44 }
45
46 void draw_cursor_normal(vector pos, vector col, float a)
47 {
48         draw_cursor(pos, OFFSET_CURSOR, "/cursor", col, a);
49 }
50
51 void LoadMenuSkinValues()
52 {
53         int fh = -1;
54         if(cvar_string("menu_skin") != "")
55         {
56                 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
57                 fh = fopen(strcat(draw_currentSkin, "/skinvalues.txt"), FILE_READ);
58         }
59         if(fh < 0 && cvar_defstring("menu_skin") != "")
60         {
61                 cvar_set("menu_skin", cvar_defstring("menu_skin"));
62                 draw_currentSkin = strcat("gfx/menu/", cvar_string("menu_skin"));
63                 fh = fopen(strcat(draw_currentSkin, "/skinvalues.txt"), FILE_READ);
64         }
65         if(fh < 0)
66         {
67                 draw_currentSkin = "gfx/menu/default";
68                 fh = fopen(strcat(draw_currentSkin, "/skinvalues.txt"), FILE_READ);
69         }
70
71         draw_currentSkin = strzone(draw_currentSkin);
72
73         if(fh >= 0)
74         {
75                 string s;
76                 while((s = fgets(fh)))
77                 {
78                         int n = tokenize_console(s);
79                         if (n < 2)
80                                 continue;
81                         if(substring(argv(0), 0, 2) == "//")
82                                 continue;
83                         if(argv(0) == "SIZE_CURSOR")
84                                 SIZE_CURSOR = stov(substring(s, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
85                         else if(argv(0) == "OFFSET_CURSOR")
86                                 OFFSET_CURSOR = stov(substring(s, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
87                 }
88                 fclose(fh);
89         }
90 }
91
92 // CSQC_Init : Called every time the CSQC code is initialized (essentially at map load)
93 // Useful for precaching things
94
95 void CSQC_Init()
96 {
97         prvm_language = strzone(cvar_string("prvm_language"));
98
99 #ifdef WATERMARK
100         LOG_INFOF("^4CSQC Build information: ^1%s", WATERMARK);
101 #endif
102
103         {
104                 int i = 0;
105                 for ( ; i < 255; ++i)
106                         if (getplayerkeyvalue(i, "viewentity") == "")
107                                 break;
108                 maxclients = i;
109         }
110
111         // needs to be done so early because of the constants they create
112         static_init();
113         static_init_late();
114         static_init_precache();
115
116         binddb = db_create();
117         tempdb = db_create();
118         ClientProgsDB = db_load("client.db");
119
120         draw_endBoldFont();
121
122         //registercommand("hud_configure");
123         //registercommand("hud_save");
124         //registercommand("menu_action");
125
126         ConsoleCommand_macro_init();
127
128         registercvar("hud_usecsqc", "1");
129         registercvar("scoreboard_columns", "default");
130
131         registercvar("cl_nade_type", "3");
132         registercvar("cl_pokenade_type", "zombie");
133
134         registercvar("cl_jumpspeedcap_min", "");
135         registercvar("cl_jumpspeedcap_max", "");
136
137         registercvar("cl_shootfromfixedorigin", "");
138
139         registercvar("cl_multijump", "1");
140
141         registercvar("cl_spawn_near_teammate", "1");
142
143         registercvar("cl_weapon_switch_reload", "1");
144         registercvar("cl_weapon_switch_fallback_to_impulse", "1");
145
146         registercvar("cl_allow_uidranking", "1");
147
148         if(autocvar_cl_lockview)
149                 cvar_set("cl_lockview", "0");
150
151         gametype = NULL;
152
153         postinit = false;
154
155         calledhooks = 0;
156
157         teams = Sort_Spawn();
158         players = Sort_Spawn();
159
160         GetTeam(NUM_SPECTATOR, true); // add specs first
161
162         for (int w = 0; w <= WEP_LAST - WEP_FIRST; ++w)
163                 weapon_accuracy[w] = -1;
164
165         // precaches
166
167         if(autocvar_cl_reticle)
168         {
169                 precache_pic("gfx/reticle_normal");
170                 // weapon reticles are precached in weapon files
171         }
172
173         {
174                 get_mi_min_max_texcoords(1); // try the CLEVER way first
175                 minimapname = strcat("gfx/", mi_shortname, "_radar.tga");
176                 shortmapname = mi_shortname;
177
178                 if (precache_pic(minimapname) == "")
179                 {
180                         // but maybe we have a non-clever minimap
181                         minimapname = strcat("gfx/", mi_shortname, "_mini.tga");
182                         if (precache_pic(minimapname) == "")
183                                 minimapname = ""; // FAIL
184                         else
185                                 get_mi_min_max_texcoords(0); // load new texcoords
186                 }
187
188                 mi_center = (mi_min + mi_max) * 0.5;
189                 mi_scale = mi_max - mi_min;
190                 minimapname = strzone(minimapname);
191         }
192
193         hud_skin_path = strzone(strcat("gfx/hud/", autocvar_hud_skin));
194         LoadMenuSkinValues();
195 }
196
197 // CSQC_Shutdown : Called every time the CSQC code is shutdown (changing maps, quitting, etc)
198 void Shutdown()
199 {
200         WarpZone_Shutdown();
201
202         delete(teams);
203         delete(players);
204         db_close(binddb);
205         db_close(tempdb);
206         if(autocvar_cl_db_saveasdump)
207                 db_dump(ClientProgsDB, "client.db");
208         else
209                 db_save(ClientProgsDB, "client.db");
210         db_close(ClientProgsDB);
211
212         if(camera_active)
213                 cvar_set("chase_active",ftos(chase_active_backup));
214
215         // unset the event chasecam's chase_active
216         if(autocvar_chase_active < 0)
217                 cvar_set("chase_active", "0");
218
219         cvar_set("slowmo", cvar_defstring("slowmo")); // reset it back to 'default'
220
221         if (!isdemo())
222         {
223                 if (!(calledhooks & HOOK_START))
224                         localcmd("\n_cl_hook_gamestart nop\n");
225                 if (!(calledhooks & HOOK_END))
226                         localcmd("\ncl_hook_gameend\n");
227         }
228
229         localcmd("\ncl_hook_shutdown\n");
230
231         localcmd("\n-button12\n");
232
233         deactivate_minigame();
234         HUD_MinigameMenu_Close(NULL, NULL, NULL);
235
236         ReplicateVars(true); // destroy
237 }
238
239 .float has_team;
240 bool SetTeam(entity o, int Team)
241 {
242         TC(int, Team);
243         devassert_once(Team);
244         entity tm;
245         if(teamplay)
246         {
247                 switch(Team)
248                 {
249                         case -1:
250                         case NUM_TEAM_1:
251                         case NUM_TEAM_2:
252                         case NUM_TEAM_3:
253                         case NUM_TEAM_4:
254                                 break;
255                         default:
256                                 if(GetTeam(Team, false) == NULL)
257                                 {
258                                         LOG_TRACEF("trying to switch to unsupported team %d", Team);
259                                         Team = NUM_SPECTATOR;
260                                 }
261                                 break;
262                 }
263         }
264         else
265         {
266                 switch(Team)
267                 {
268                         case -1:
269                         case 0:
270                                 break;
271                         default:
272                                 if(GetTeam(Team, false) == NULL)
273                                 {
274                                         LOG_TRACEF("trying to switch to unsupported team %d", Team);
275                                         Team = NUM_SPECTATOR;
276                                 }
277                                 break;
278                 }
279         }
280         if(Team == -1) // leave
281         {
282                 if(o.has_team)
283                 {
284                         tm = GetTeam(o.team, false);
285                         tm.team_size -= 1;
286                         o.has_team = 0;
287                         return true;
288                 }
289         }
290         else
291         {
292                 if (!o.has_team)
293                 {
294                         o.team = Team;
295                         tm = GetTeam(Team, true);
296                         tm.team_size += 1;
297                         o.has_team = 1;
298                         return true;
299                 }
300                 else if(Team != o.team)
301                 {
302                         tm = GetTeam(o.team, false);
303                         tm.team_size -= 1;
304                         o.team = Team;
305                         tm = GetTeam(Team, true);
306                         tm.team_size += 1;
307                         return true;
308                 }
309         }
310         return false;
311 }
312
313 void Playerchecker_Think(entity this)
314 {
315         int i;
316         entity e;
317         for(i = 0; i < maxclients; ++i)
318         {
319                 e = playerslots[i];
320                 if(entcs_GetName(i) == "")
321                 {
322                         if(e.sort_prev)
323                         {
324                                 // player disconnected
325                                 SetTeam(e, -1);
326                                 RemovePlayer(e);
327                                 e.sort_prev = NULL;
328                                 //e.gotscores = 0;
329                         }
330                 }
331                 else
332                 {
333                         if (!e.sort_prev)
334                         {
335                                 // player connected
336                                 if (!e)
337                                 {
338                                         playerslots[i] = e = new_pure(playerslot);
339                                 }
340                                 e.sv_entnum = i;
341                                 e.ping = 0;
342                                 e.ping_packetloss = 0;
343                                 e.ping_movementloss = 0;
344                                 //e.gotscores = 0; // we might already have the scores...
345                                 int t = entcs_GetScoreTeam(i);
346                                 if (t) SetTeam(e, t); // will not hurt; later updates come with Scoreboard_UpdatePlayerTeams
347                                 RegisterPlayer(e);
348                                 Scoreboard_UpdatePlayerPos(e);
349                         }
350                 }
351         }
352         this.nextthink = time + 0.2;
353 }
354
355 void PostInit()
356 {
357         entity playerchecker = new_pure(playerchecker);
358         setthink(playerchecker, Playerchecker_Think);
359         playerchecker.nextthink = time + 0.2;
360
361         TrueAim_Init();
362
363         postinit = true;
364 }
365
366 // CSQC_InputEvent : Used to perform actions based on any key pressed, key released and mouse on the client.
367 // Return value should be 1 if CSQC handled the input, otherwise return 0 to have the input passed to the engine.
368 // All keys are in ascii.
369 // bInputType = 0 is key pressed, 1 is key released, 2 and 3 are mouse input.
370 // In the case of keyboard input, nPrimary is the ascii code, and nSecondary is 0.
371 // In the case of mouse input, nPrimary is xdelta, nSecondary is ydelta.
372 // In the case of mouse input after a setcursormode(1) call, nPrimary is xpos, nSecondary is ypos.
373 float CSQC_InputEvent(int bInputType, float nPrimary, float nSecondary)
374 {
375         TC(int, bInputType);
376         bool override = false;
377         override |= HUD_Panel_InputEvent(bInputType, nPrimary, nSecondary);
378         if (override)
379                 return true;
380
381         override |= QuickMenu_InputEvent(bInputType, nPrimary, nSecondary);
382
383         override |= HUD_Radar_InputEvent(bInputType, nPrimary, nSecondary);
384
385         override |= MapVote_InputEvent(bInputType, nPrimary, nSecondary);
386
387         override |= HUD_Minigame_InputEvent(bInputType, nPrimary, nSecondary);
388
389         if(override)
390                 return true;
391
392         return false;
393 }
394
395 // END REQUIRED CSQC FUNCTIONS
396 // --------------------------------------------------------------------------
397
398 // --------------------------------------------------------------------------
399 // BEGIN OPTIONAL CSQC FUNCTIONS
400
401 void Ent_RemovePlayerScore(entity this)
402 {
403         if(this.owner) {
404                 SetTeam(this.owner, -1);
405                 this.owner.gotscores = 0;
406                 FOREACH(Scores, true, {
407                         this.owner.(scores(it)) = 0; // clear all scores
408                 });
409         }
410 }
411
412 NET_HANDLE(ENT_CLIENT_SCORES, bool isnew)
413 {
414         make_pure(this);
415         entity o;
416
417         // damnit -.- don't want to go change every single .sv_entnum in hud.qc AGAIN
418         // (no I've never heard of M-x replace-string, sed, or anything like that)
419         bool isNew = !this.owner; // workaround for DP bug
420         int n = ReadByte()-1;
421
422 #ifdef DP_CSQC_ENTITY_REMOVE_IS_B0RKED
423         if(!isNew && n != this.sv_entnum)
424         {
425                 //print("A CSQC entity changed its owner!\n");
426                 LOG_INFOF("A CSQC entity changed its owner! (edict: %d, classname: %s)", etof(this), this.classname);
427                 isNew = true;
428                 Ent_Remove(this);
429         }
430 #endif
431
432         this.sv_entnum = n;
433
434         o = playerslots[this.sv_entnum];
435         if (!o)
436         {
437                 o = playerslots[this.sv_entnum] = new_pure(playerslot);
438         }
439         this.owner = o;
440         o.sv_entnum = this.sv_entnum;
441         o.gotscores = 1;
442
443         //if (!o.sort_prev)
444         //      RegisterPlayer(o);
445         //playerchecker will do this for us later, if it has not already done so
446
447         int sf = ReadShort();
448         int lf = ReadShort();
449         FOREACH(Scores, true, {
450                 int p = 1 << (i % 16);
451                 if (sf & p)
452                 {
453                         if (lf & p)
454                                 o.(scores(it)) = ReadInt24_t();
455                         else
456                                 o.(scores(it)) = ReadChar();
457                 }
458         });
459
460         return = true;
461
462         if(o.sort_prev)
463                 Scoreboard_UpdatePlayerPos(o); // if not registered, we cannot do this yet!
464
465         this.entremove = Ent_RemovePlayerScore;
466 }
467
468 NET_HANDLE(ENT_CLIENT_TEAMSCORES, bool isnew)
469 {
470         make_pure(this);
471         int i;
472
473         this.team = ReadByte();
474         entity o = this.owner = GetTeam(this.team, true); // these team numbers can always be trusted
475
476 #if MAX_TEAMSCORE <= 8
477         int sf = ReadByte();
478         int lf = ReadByte();
479 #else
480         int sf = ReadShort();
481         int lf = ReadShort();
482 #endif
483         for(i = 0; i < MAX_TEAMSCORE; ++i)
484                 if(sf & BIT(i))
485                 {
486                         if(lf & BIT(i))
487                                 o.(teamscores(i)) = ReadInt24_t();
488                         else
489                                 o.(teamscores(i)) = ReadChar();
490                 }
491
492         return = true;
493
494         Scoreboard_UpdateTeamPos(o);
495 }
496
497 NET_HANDLE(ENT_CLIENT_CLIENTDATA, bool isnew)
498 {
499         make_pure(this);
500         float newspectatee_status;
501
502         int f = ReadByte();
503
504         scoreboard_showscores_force = (f & BIT(0));
505
506         if(f & BIT(1))
507         {
508                 newspectatee_status = ReadByte();
509                 if(newspectatee_status == player_localnum + 1)
510                         newspectatee_status = -1; // observing
511         }
512         else
513                 newspectatee_status = 0;
514
515         spectatorbutton_zoom = (f & BIT(2));
516
517         if(f & BIT(4))
518         {
519                 num_spectators = ReadByte();
520
521                 float i, slot;
522
523                 for(i = 0; i < MAX_SPECTATORS; ++i)
524                         spectatorlist[i] = 0; // reset list first
525
526                 for(i = 0; i < num_spectators; ++i)
527                 {
528                         slot = ReadByte();
529                         spectatorlist[i] = slot - 1;
530                 }
531         }
532
533         return = true;
534
535         if(newspectatee_status != spectatee_status)
536         {
537                 // clear race stuff
538                 race_laptime = 0;
539                 race_checkpointtime = 0;
540                 hud_dynamic_shake_factor = -1;
541                 spectatee_status_changed_time = time;
542         }
543         if (autocvar_hud_panel_healtharmor_progressbar_gfx)
544         {
545                 if ( (spectatee_status == -1 && newspectatee_status > 0) //before observing, now spectating
546                   || (spectatee_status > 0 && newspectatee_status > 0 && spectatee_status != newspectatee_status) //changed spectated player
547                 )
548                         prev_p_health = -1;
549                 else if(spectatee_status && !newspectatee_status) //before observing/spectating, now playing
550                         prev_health = -1;
551         }
552         spectatee_status = newspectatee_status;
553
554         // we could get rid of spectatee_status, and derive it from player_localentnum and player_localnum
555 }
556
557 NET_HANDLE(ENT_CLIENT_NAGGER, bool isnew)
558 {
559         make_pure(this);
560         int i, j, b, f;
561
562         int nags = ReadByte(); // NAGS NAGS NAGS NAGS NAGS NAGS NADZ NAGS NAGS NAGS
563
564         if(!(nags & BIT(2)))
565         {
566                 strfree(vote_called_vote);
567                 vote_active = 0;
568         }
569         else
570         {
571                 vote_active = 1;
572         }
573
574         if(nags & BIT(6))
575         {
576                 vote_yescount = ReadByte();
577                 vote_nocount = ReadByte();
578                 vote_needed = ReadByte();
579                 vote_highlighted = ReadChar();
580         }
581
582         if(nags & BIT(7))
583         {
584                 strcpy(vote_called_vote, ReadString());
585         }
586
587         if(nags & 1)
588         {
589                 for(j = 0; j < maxclients; ++j)
590                         if(playerslots[j])
591                                 playerslots[j].ready = true;
592                 for(i = 1; i <= maxclients; i += 8)
593                 {
594                         f = ReadByte();
595                         for(j = i-1, b = BIT(0); b < BIT(8); b <<= 1, ++j)
596                                 if (!(f & b))
597                                         if(playerslots[j])
598                                                 playerslots[j].ready = false;
599                 }
600         }
601
602         return = true;
603
604         ready_waiting = (nags & BIT(0));
605         ready_waiting_for_me = (nags & BIT(1));
606         vote_waiting = (nags & BIT(2));
607         vote_waiting_for_me = (nags & BIT(3));
608         warmup_stage = (nags & BIT(4));
609 }
610
611 NET_HANDLE(ENT_CLIENT_ELIMINATEDPLAYERS, bool isnew)
612 {
613         make_pure(this);
614         int sf = 0;
615         serialize(byte, 0, sf);
616         if (sf & 1) {
617                 for (int j = 0; j < maxclients; ++j) {
618                         if (playerslots[j]) {
619                                 playerslots[j].eliminated = true;
620                         }
621                 }
622                 for (int i = 1; i <= maxclients; i += 8) {
623                         int f = 0;
624                         serialize(byte, 0, f);
625                         for (int b = 0; b < 8; ++b) {
626                                 if (f & BIT(b)) continue;
627                                 int j = i - 1 + b;
628                                 if (playerslots[j]) {
629                                         playerslots[j].eliminated = false;
630                                 }
631                         }
632                 }
633         }
634         return true;
635 }
636
637 NET_HANDLE(ENT_CLIENT_RANDOMSEED, bool isnew)
638 {
639         make_pure(this);
640         prandom_debug();
641         float s = ReadShort();
642         psrandom(s);
643         return true;
644 }
645
646 NET_HANDLE(ENT_CLIENT_ACCURACY, bool isnew)
647 {
648         make_pure(this);
649         int sf = ReadInt24_t();
650         if (sf == 0) {
651                 for (int w = 0; w <= WEP_LAST - WEP_FIRST; ++w)
652                         weapon_accuracy[w] = -1;
653                 return true;
654         }
655
656         int f = 1;
657         for (int w = 0; w <= WEP_LAST - WEP_FIRST; ++w) {
658                 if (sf & f) {
659                         int b = ReadByte();
660                         if (b == 0)
661                                 weapon_accuracy[w] = -1;
662                         else if (b == 255)
663                                 weapon_accuracy[w] = 1.0; // no better error handling yet, sorry
664                         else
665                                 weapon_accuracy[w] = (b - 1.0) / 100.0;
666                 }
667                 f = (f == 0x800000) ? 1 : f * 2;
668         }
669         return true;
670 }
671
672 void Spawn_Draw(entity this)
673 {
674         if(this.alpha <= 0)
675                 return;
676
677         __pointparticles(this.cnt, this.origin + '0 0 28', '0 0 2', bound(0, frametime, 0.1));
678 }
679
680 void Spawn_PreDraw(entity this)
681 {
682         float alph;
683         vector org = getpropertyvec(VF_ORIGIN);
684         if(this.fade_start)
685         {
686                 if(vdist(org - this.origin, >, this.fade_end))
687                         alph = 0; // save on some processing
688                 else if(vdist(org - this.origin, <, this.fade_start))
689                         alph = 1; // more processing saved
690                 else
691                         alph = bound(0, (this.fade_end - vlen(org - this.origin - 0.5 * (this.mins + this.maxs))) / (this.fade_end - this.fade_start), 1);
692         }
693         else
694                 alph = 1;
695         //printf("%v <-> %v\n", view_origin, this.origin + 0.5 * (this.mins + this.maxs));
696         this.alpha = alph;
697         if(alph <= 0)
698                 this.drawmask = 0;
699         else
700                 this.drawmask = MASK_NORMAL;
701 }
702
703 NET_HANDLE(ENT_CLIENT_SPAWNPOINT, bool is_new)
704 {
705         float teamnum = (ReadByte() - 1);
706         vector spn_origin = ReadVector();
707
708         this.team = (teamnum + 1);
709
710         //if(is_new)
711         //{
712                 this.origin = spn_origin;
713                 setsize(this, PL_MIN_CONST, PL_MAX_CONST);
714                 //droptofloor();
715
716                 /*if(autocvar_cl_spawn_point_model) // needs a model first
717                 {
718                         this.mdl = "models/spawnpoint.md3";
719                         this.colormod = Team_ColorRGB(teamnum);
720                         precache_model(this.mdl);
721                         setmodel(this, this.mdl);
722                         this.drawmask = MASK_NORMAL;
723                         //this.move_movetype = MOVETYPE_NOCLIP;
724                         //this.draw = Spawn_Draw;
725                         IL_PUSH(g_drawables, this);
726                 }*/
727                 if(autocvar_cl_spawn_point_particles)
728                 {
729                         if(teamplay)
730                         {
731                                 switch(teamnum)
732                                 {
733                                         case NUM_TEAM_1: this.cnt = particleeffectnum(EFFECT_SPAWNPOINT_RED); break;
734                                         case NUM_TEAM_2: this.cnt = particleeffectnum(EFFECT_SPAWNPOINT_BLUE); break;
735                                         case NUM_TEAM_3: this.cnt = particleeffectnum(EFFECT_SPAWNPOINT_YELLOW); break;
736                                         case NUM_TEAM_4: this.cnt = particleeffectnum(EFFECT_SPAWNPOINT_PINK); break;
737                                         default: this.cnt = particleeffectnum(EFFECT_SPAWNPOINT_NEUTRAL); break;
738                                 }
739                         }
740                         else { this.cnt = particleeffectnum(EFFECT_SPAWNPOINT_NEUTRAL); }
741
742                         this.draw = Spawn_Draw;
743                         if (is_new) IL_PUSH(g_drawables, this);
744                         setpredraw(this, Spawn_PreDraw);
745                         this.fade_start = autocvar_cl_spawn_point_dist_min;
746                         this.fade_end = autocvar_cl_spawn_point_dist_max;
747                 }
748         //}
749
750         //printf("Ent_ReadSpawnPoint(is_new = %d); origin = %s, team = %d, effect = %d\n", is_new, vtos(this.origin), teamnum, this.cnt);
751         return true;
752 }
753
754 NET_HANDLE(ENT_CLIENT_SPAWNEVENT, bool is_new)
755 {
756         // If entnum is 0, ONLY do the local spawn actions
757         // this way the server can disable the sending of
758         // spawn origin or such to clients if wanted.
759         float entnum = ReadByte();
760
761         if(entnum)
762         {
763                 this.origin = ReadVector();
764
765                 if(is_new)
766                 {
767                         float teamnum = entcs_GetTeam(entnum - 1);
768
769                         if(autocvar_cl_spawn_event_particles)
770                         {
771                                 switch(teamnum)
772                                 {
773                                         case NUM_TEAM_1: pointparticles(EFFECT_SPAWN_RED, this.origin, '0 0 0', 1); break;
774                                         case NUM_TEAM_2: pointparticles(EFFECT_SPAWN_BLUE, this.origin, '0 0 0', 1); break;
775                                         case NUM_TEAM_3: pointparticles(EFFECT_SPAWN_YELLOW, this.origin, '0 0 0', 1); break;
776                                         case NUM_TEAM_4: pointparticles(EFFECT_SPAWN_PINK, this.origin, '0 0 0', 1); break;
777                                         default: pointparticles(EFFECT_SPAWN_NEUTRAL, this.origin, '0 0 0', 1); break;
778                                 }
779                         }
780                         if(autocvar_cl_spawn_event_sound)
781                         {
782                                 sound(this, CH_TRIGGER, SND_SPAWN, VOL_BASE, ATTEN_NORM);
783                         }
784                 }
785         }
786         return = true;
787
788         // local spawn actions
789         if(is_new && (!entnum || (entnum == player_localentnum)))
790         {
791                 zoomin_effect = 1;
792                 current_viewzoom = (1 / bound(1, autocvar_cl_spawnzoom_factor, 16));
793
794                 if(autocvar_cl_unpress_zoom_on_spawn)
795                 {
796                         localcmd("-zoom\n");
797                         button_zoom = false;
798                 }
799                 HUD_Radar_Hide_Maximized();
800         }
801         //printf("Ent_ReadSpawnEvent(is_new = %d); origin = %s, entnum = %d, localentnum = %d\n", is_new, vtos(this.origin), entnum, player_localentnum);
802 }
803
804 // CSQC_Ent_Update : Called every frame that the server has indicated an update to the SSQC / CSQC entity has occured.
805 // The only parameter reflects if the entity is "new" to the client, meaning it just came into the client's PVS.
806 void CSQC_Ent_Update(entity this, bool isnew)
807 {
808         this.sourceLoc = __FILE__":"STR(__LINE__);
809         int t = ReadByte();
810
811         // set up the "time" global for received entities to be correct for interpolation purposes
812         float savetime = time;
813         if(servertime)
814         {
815                 time = servertime;
816         }
817         else
818         {
819                 serverprevtime = time;
820                 serverdeltatime = STAT(MOVEVARS_TICRATE) * STAT(MOVEVARS_TIMESCALE);
821                 time = serverprevtime + serverdeltatime;
822         }
823
824 #ifdef DP_CSQC_ENTITY_REMOVE_IS_B0RKED
825         if (this.enttype)
826         {
827                 if (t != this.enttype || isnew)
828                 {
829                         LOG_INFOF("A CSQC entity changed its type! (edict: %d, server: %d, type: %d -> %d)", etof(this), this.entnum, this.enttype, t);
830                         Ent_Remove(this);
831                         clearentity(this);
832                         isnew = true;
833                 }
834         }
835         else
836         {
837                 if (!isnew)
838                 {
839                         LOG_INFOF("A CSQC entity appeared out of nowhere! (edict: %d, server: %d, type: %d)", etof(this), this.entnum, t);
840                         isnew = true;
841                 }
842         }
843 #endif
844         this.enttype = t;
845         bool done = false;
846         FOREACH(LinkedEntities, it.m_id == t, {
847                 if (isnew) this.classname = it.netname;
848                 if (autocvar_developer_csqcentities)
849             LOG_INFOF("CSQC_Ent_Update(%d) at %f with this=%i {.entnum=%d, .enttype=%d} t=%s (%d)", isnew, savetime, this, this.entnum, this.enttype, this.classname, t);
850                 done = it.m_read(this, NULL, isnew);
851                 MUTATOR_CALLHOOK(Ent_Update, this, isnew);
852                 break;
853         });
854         time = savetime;
855         if (!done)
856         {
857                 LOG_FATALF("CSQC_Ent_Update(%d) at %f with this=%i {.entnum=%d, .enttype=%d} t=%s (%d)", isnew, savetime, this, this.entnum, this.enttype, this.classname, t);
858         }
859 }
860
861 // Destructor, but does NOT deallocate the entity by calling remove(). Also
862 // used when an entity changes its type. For an entity that someone interacts
863 // with others, make sure it can no longer do so.
864 void Ent_Remove(entity this)
865 {
866         if(this.entremove) this.entremove(this);
867
868         if(this.skeletonindex)
869         {
870                 skel_delete(this.skeletonindex);
871                 this.skeletonindex = 0;
872         }
873
874         if(this.snd_looping > 0)
875         {
876                 sound(this, this.snd_looping, SND_Null, VOL_BASE, autocvar_cl_jetpack_attenuation);
877                 this.snd_looping = 0;
878         }
879
880         this.enttype = 0;
881         this.classname = "";
882         this.draw = func_null;
883         this.entremove = func_null;
884         // TODO possibly set more stuff to defaults
885 }
886 // CSQC_Ent_Remove : Called when the server requests a SSQC / CSQC entity to be removed.  Essentially call remove(this) as well.
887 void CSQC_Ent_Remove(entity this)
888 {
889         if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Ent_Remove() with this=%i {.entnum=%d, .enttype=%d}", this, this.entnum, this.enttype);
890         if (wasfreed(this))
891         {
892                 LOG_WARN("CSQC_Ent_Remove called for already removed entity. Packet loss?");
893                 return;
894         }
895         if (this.enttype) Ent_Remove(this);
896         delete(this);
897 }
898
899 void Gamemode_Init()
900 {
901         if (!isdemo())
902         {
903                 if(!(calledhooks & HOOK_START))
904                         localcmd("\n_cl_hook_gamestart ", MapInfo_Type_ToString(gametype), "\n");
905                 calledhooks |= HOOK_START;
906         }
907 }
908 // CSQC_Parse_StuffCmd : Provides the stuffcmd string in the first parameter that the server provided.  To execute standard behavior, simply execute localcmd with the string.
909 void CSQC_Parse_StuffCmd(string strMessage)
910 {
911         if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_StuffCmd(\"%s\")", strMessage);
912         localcmd(strMessage);
913 }
914 // CSQC_Parse_Print : Provides the print string in the first parameter that the server provided.  To execute standard behavior, simply execute print with the string.
915 void CSQC_Parse_Print(string strMessage)
916 {
917         if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_Print(\"%s\")", strMessage);
918         print(ColorTranslateRGB(strMessage));
919 }
920
921 // CSQC_Parse_CenterPrint : Provides the centerprint_hud string in the first parameter that the server provided.
922 void CSQC_Parse_CenterPrint(string strMessage)
923 {
924         if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_CenterPrint(\"%s\")", strMessage);
925         centerprint_hud(strMessage);
926 }
927
928 // CSQC_Parse_TempEntity : Handles all temporary entity network data in the CSQC layer.
929 // You must ALWAYS first acquire the temporary ID, which is sent as a byte.
930 // Return value should be 1 if CSQC handled the temporary entity, otherwise return 0 to have the engine process the event.
931 bool CSQC_Parse_TempEntity()
932 {
933         // Acquire TE ID
934         int nTEID = ReadByte();
935
936         FOREACH(TempEntities, it.m_id == nTEID, {
937                 if (autocvar_developer_csqcentities)
938                         LOG_INFOF("CSQC_Parse_TempEntity() nTEID=%s (%d)", it.netname, nTEID);
939                 return it.m_read(NULL, NULL, true);
940         });
941
942         if (autocvar_developer_csqcentities)
943                 LOG_INFOF("CSQC_Parse_TempEntity() with nTEID=%d", nTEID);
944
945         // No special logic for this temporary entity; return 0 so the engine can handle it
946         return false;
947 }
948
949 string forcefog;
950 void Fog_Force()
951 {
952         if (autocvar_cl_orthoview && autocvar_cl_orthoview_nofog)
953                 localcmd("\nr_drawfog 0\n");
954         else if (forcefog != "")
955                 localcmd(sprintf("\nfog %s\nr_fog_exp2 0\nr_drawfog 1\n", forcefog));
956 }
957
958 NET_HANDLE(ENT_CLIENT_SCORES_INFO, bool isnew)
959 {
960         make_pure(this);
961         gametype = ReadRegistered(Gametypes);
962         teamplay = _MapInfo_GetTeamPlayBool(gametype);
963         HUD_ModIcons_SetFunc();
964         FOREACH(Scores, true, {
965                 strcpy(scores_label(it), ReadString());
966                 scores_flags(it) = ReadByte();
967         });
968         for (int i = 0; i < MAX_TEAMSCORE; ++i)
969         {
970                 strcpy(teamscores_label(i), ReadString());
971                 teamscores_flags(i) = ReadByte();
972         }
973         return = true;
974         Scoreboard_InitScores();
975         Gamemode_Init();
976 }
977
978 NET_HANDLE(ENT_CLIENT_INIT, bool isnew)
979 {
980         nb_pb_period = ReadByte() / 32; //Accuracy of 1/32th
981
982         hook_shotorigin[0] = decompressShotOrigin(ReadInt24_t());
983         hook_shotorigin[1] = decompressShotOrigin(ReadInt24_t());
984         hook_shotorigin[2] = decompressShotOrigin(ReadInt24_t());
985         hook_shotorigin[3] = decompressShotOrigin(ReadInt24_t());
986         arc_shotorigin[0] = decompressShotOrigin(ReadInt24_t());
987         arc_shotorigin[1] = decompressShotOrigin(ReadInt24_t());
988         arc_shotorigin[2] = decompressShotOrigin(ReadInt24_t());
989         arc_shotorigin[3] = decompressShotOrigin(ReadInt24_t());
990
991         strcpy(forcefog, ReadString());
992
993         armorblockpercent = ReadByte() / 255.0;
994         damagepush_speedfactor = ReadByte() / 255.0;
995
996         serverflags = ReadByte();
997
998         g_trueaim_minrange = ReadCoord();
999
1000         return = true;
1001
1002         MUTATOR_CALLHOOK(Ent_Init);
1003
1004         if (!postinit) PostInit();
1005 }
1006
1007 float GetSpeedUnitFactor(int speed_unit)
1008 {
1009         switch(speed_unit)
1010         {
1011                 default:
1012                 case 1:
1013                         return 1.0;
1014                 case 2:
1015                         return 0.0254;
1016                 case 3:
1017                         return 0.0254 * 3.6;
1018                 case 4:
1019                         return 0.0254 * 3.6 * 0.6213711922;
1020                 case 5:
1021                         return 0.0254 * 1.943844492; // 1 m/s = 1.943844492 knots, because 1 knot = 1.852 km/h
1022         }
1023 }
1024
1025 string GetSpeedUnit(int speed_unit)
1026 {
1027         switch(speed_unit)
1028         {
1029                 default:
1030                 case 1:
1031                         return _(" qu/s");
1032                 case 2:
1033                         return _(" m/s");
1034                 case 3:
1035                         return _(" km/h");
1036                 case 4:
1037                         return _(" mph");
1038                 case 5:
1039                         return _(" knots");
1040         }
1041 }
1042
1043 NET_HANDLE(TE_CSQC_RACE, bool isNew)
1044 {
1045         int b = ReadByte();
1046
1047         switch (b)
1048         {
1049                 case RACE_NET_CHECKPOINT_HIT_QUALIFYING:
1050                         race_checkpoint = ReadByte();
1051                         race_time = ReadInt24_t();
1052                         race_previousbesttime = ReadInt24_t();
1053                         race_mypreviousbesttime = ReadInt24_t();
1054                         string pbestname = ReadString();
1055                         if(autocvar_cl_race_cptimes_onlyself)
1056                         {
1057                                 race_previousbesttime = race_mypreviousbesttime;
1058                                 race_mypreviousbesttime = 0;
1059                                 strcpy(race_previousbestname, "");
1060                         }
1061                         else
1062                                 strcpy(race_previousbestname, pbestname);
1063
1064                         race_checkpointtime = time;
1065
1066                         if(race_checkpoint == 0 || race_checkpoint == 254)
1067                         {
1068                                 race_penaltyaccumulator = 0;
1069                                 race_laptime = time; // valid
1070                         }
1071                         break;
1072
1073                 case RACE_NET_CHECKPOINT_CLEAR:
1074                         race_laptime = 0;
1075                         race_checkpointtime = 0;
1076                         break;
1077
1078                 case RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING:
1079                         race_laptime = ReadCoord();
1080                         race_checkpointtime = -99999;
1081                         // fall through
1082                 case RACE_NET_CHECKPOINT_NEXT_QUALIFYING:
1083                         race_nextcheckpoint = ReadByte();
1084
1085                         race_nextbesttime = ReadInt24_t();
1086                         if(b != RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING) // not while spectating (matches server)
1087                                 race_mybesttime = ReadInt24_t();
1088                         string newname = ReadString();
1089                         if(autocvar_cl_race_cptimes_onlyself && b != RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING)
1090                         {
1091                                 race_nextbesttime = race_mybesttime;
1092                                 race_mybesttime = 0;
1093                                 strcpy(race_nextbestname, "");
1094                         }
1095                         else
1096                                 strcpy(race_nextbestname, newname);
1097                         break;
1098
1099                 case RACE_NET_CHECKPOINT_HIT_RACE:
1100                         race_mycheckpoint = ReadByte();
1101                         race_mycheckpointtime = time;
1102                         race_mycheckpointdelta = ReadInt24_t();
1103                         race_mycheckpointlapsdelta = ReadByte();
1104                         if(race_mycheckpointlapsdelta >= 128)
1105                                 race_mycheckpointlapsdelta -= 256;
1106                         int who = ReadByte();
1107                         if(who)
1108                                 strcpy(race_mycheckpointenemy, entcs_GetName(who - 1));
1109                         else
1110                                 strcpy(race_mycheckpointenemy, ""); // TODO: maybe string_null works fine here?
1111                         break;
1112
1113                 case RACE_NET_CHECKPOINT_HIT_RACE_BY_OPPONENT:
1114                         race_othercheckpoint = ReadByte();
1115                         race_othercheckpointtime = time;
1116                         race_othercheckpointdelta = ReadInt24_t();
1117                         race_othercheckpointlapsdelta = ReadByte();
1118                         if(race_othercheckpointlapsdelta >= 128)
1119                                 race_othercheckpointlapsdelta -= 256;
1120                         int what = ReadByte();
1121                         if(what)
1122                                 strcpy(race_othercheckpointenemy, entcs_GetName(what - 1));
1123                         else
1124                                 strcpy(race_othercheckpointenemy, ""); // TODO: maybe string_null works fine here?
1125                         break;
1126
1127                 case RACE_NET_PENALTY_RACE:
1128                 case RACE_NET_PENALTY_QUALIFYING:
1129                         race_penaltyeventtime = time;
1130                         race_penaltytime = ReadShort();
1131                         string reason = ReadString();
1132                         if (reason == "missing a checkpoint")
1133                                 reason = _("missing a checkpoint");
1134                         strcpy(race_penaltyreason, reason);
1135                         if (b == RACE_NET_PENALTY_QUALIFYING)
1136                                 race_penaltyaccumulator += race_penaltytime;
1137                         break;
1138
1139                 case RACE_NET_SERVER_RECORD:
1140                         race_server_record = ReadInt24_t();
1141                         break;
1142                 case RACE_NET_SPEED_AWARD:
1143                         race_speedaward = ReadInt24_t() * GetSpeedUnitFactor(autocvar_hud_panel_physics_speed_unit);
1144                         strcpy(race_speedaward_holder, ReadString());
1145                         strcpy(race_speedaward_unit, GetSpeedUnit(autocvar_hud_panel_physics_speed_unit));
1146                         break;
1147                 case RACE_NET_SPEED_AWARD_BEST:
1148                         race_speedaward_alltimebest = ReadInt24_t() * GetSpeedUnitFactor(autocvar_hud_panel_physics_speed_unit);
1149                         strcpy(race_speedaward_alltimebest_holder, ReadString());
1150                         strcpy(race_speedaward_alltimebest_unit, GetSpeedUnit(autocvar_hud_panel_physics_speed_unit));
1151                         break;
1152                 case RACE_NET_RANKINGS_CNT:
1153                         RANKINGS_DISPLAY_CNT = ReadByte();
1154                         break;
1155                 case RACE_NET_SERVER_RANKINGS:
1156                         float prevpos, del;
1157                         int pos = ReadShort();
1158                         prevpos = ReadShort();
1159                         del = ReadShort();
1160
1161                         // move other rankings out of the way
1162                         int i;
1163                         if (prevpos) {
1164                                 int m = min(prevpos, RANKINGS_DISPLAY_CNT);
1165                                 for (i=m-1; i>pos-1; --i) {
1166                                         grecordtime[i] = grecordtime[i-1];
1167                                         strcpy(grecordholder[i], grecordholder[i-1]);
1168                                 }
1169                         } else if (del) { // a record has been deleted by the admin
1170                                 for (i=pos-1; i<= RANKINGS_DISPLAY_CNT-1; ++i) {
1171                                         if (i == RANKINGS_DISPLAY_CNT-1) { // clear out last record
1172                                                 grecordtime[i] = 0;
1173                                                 strfree(grecordholder[i]);
1174                                         }
1175                                         else {
1176                                                 grecordtime[i] = grecordtime[i+1];
1177                                                 strcpy(grecordholder[i], grecordholder[i+1]);
1178                                         }
1179                                 }
1180                         } else { // player has no ranked record yet
1181                                 for (i=RANKINGS_DISPLAY_CNT-1;i>pos-1;--i) {
1182                                         grecordtime[i] = grecordtime[i-1];
1183                                         strcpy(grecordholder[i], grecordholder[i-1]);
1184                                 }
1185                         }
1186
1187                         if (grecordtime[RANKINGS_DISPLAY_CNT]) {
1188                                 // kick off the player who fell from the last displayed position
1189                                 grecordtime[RANKINGS_DISPLAY_CNT] = 0;
1190                                 strfree(grecordholder[RANKINGS_DISPLAY_CNT]);
1191                         }
1192
1193                         // store new ranking
1194                         strcpy(grecordholder[pos-1], ReadString());
1195                         grecordtime[pos-1] = ReadInt24_t();
1196                         if(strdecolorize(grecordholder[pos-1]) == strdecolorize(entcs_GetName(player_localnum)))
1197                                 race_myrank = pos;
1198                         break;
1199                 case RACE_NET_SERVER_STATUS:
1200                         race_status = ReadShort();
1201                         strcpy(race_status_name, ReadString());
1202         }
1203         return true;
1204 }
1205
1206 NET_HANDLE(TE_CSQC_TEAMNAGGER, bool isNew)
1207 {
1208         teamnagger = 1;
1209         return true;
1210 }
1211
1212 NET_HANDLE(TE_CSQC_PINGPLREPORT, bool isNew)
1213 {
1214         int i = ReadByte();
1215         int pi = ReadShort();
1216         int pl = ReadByte();
1217         int ml = ReadByte();
1218         return = true;
1219         entity e = playerslots[i];
1220         if (!e) return;
1221         e.ping = pi;
1222         e.ping_packetloss = pl / 255.0;
1223         e.ping_movementloss = ml / 255.0;
1224 }
1225
1226 NET_HANDLE(TE_CSQC_WEAPONCOMPLAIN, bool isNew)
1227 {
1228         int weapon_id = ReadByte();
1229         complain_weapon = Weapons_from(weapon_id);
1230         complain_weapon_type = ReadByte();
1231         return = true;
1232
1233         complain_weapon_time = time;
1234         weapontime = time; // ping the weapon panel
1235
1236         switch(complain_weapon_type)
1237         {
1238                 case 0: Local_Notification(MSG_MULTI, ITEM_WEAPON_NOAMMO, weapon_id); break;
1239                 case 1: Local_Notification(MSG_MULTI, ITEM_WEAPON_DONTHAVE, weapon_id); break;
1240                 default: Local_Notification(MSG_MULTI, ITEM_WEAPON_UNAVAILABLE, weapon_id); break;
1241         }
1242 }
1243
1244 string _getcommandkey(string cmd_name, string command, bool forcename)
1245 {
1246         string keys;
1247         float n, j, k, l = 0;
1248
1249         if (!autocvar_hud_showbinds)
1250                 return cmd_name;
1251
1252         keys = db_get(binddb, command);
1253         if (keys == "")
1254         {
1255                 bool joy_active = cvar("joy_active");
1256                 n = tokenize(findkeysforcommand(command, 0)); // uses '...' strings
1257                 for(j = 0; j < n; ++j)
1258                 {
1259                         k = stof(argv(j));
1260                         if(k != -1)
1261                         {
1262                                 string key = keynumtostring(k);
1263                                 if(!joy_active && substring(key, 0, 3) == "JOY")
1264                                         continue;
1265
1266                                 key = translate_key(key);
1267
1268                                 if (keys == "")
1269                                         keys = key;
1270                                 else
1271                                         keys = strcat(keys, ", ", key);
1272
1273                                 ++l;
1274                                 if (autocvar_hud_showbinds_limit > 0 && autocvar_hud_showbinds_limit <= l)
1275                                         break;
1276                         }
1277
1278                 }
1279                 if (keys == "")
1280                         keys = "NO_KEY";
1281                 db_put(binddb, command, keys);
1282         }
1283
1284         if (keys == "NO_KEY") {
1285                 if (autocvar_hud_showbinds > 1)
1286                         return sprintf(_("%s (not bound)"), cmd_name);
1287                 else
1288                         return cmd_name;
1289         }
1290         else if (autocvar_hud_showbinds > 1 || forcename)
1291                 return sprintf("%s (%s)", cmd_name, keys);
1292         else
1293                 return keys;
1294 }