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