Merge remote-tracking branch 'origin/master' into samual/notification_rewrite
[xonotic/xonotic-data.pk3dir.git] / qcsrc / client / Main.qc
1 // --------------------------------------------------------------------------
2 // BEGIN REQUIRED CSQC FUNCTIONS
3 //include "main.qh"
4
5 entity clearentity_ent;
6 void clearentity(entity e)
7 {
8         if not(clearentity_ent)
9         {
10                 clearentity_ent = spawn();
11                 clearentity_ent.classname = "clearentity";
12         }
13         float n = e.entnum;
14         copyentity(clearentity_ent, e);
15         e.entnum = n;
16 }
17
18 #define DP_CSQC_ENTITY_REMOVE_IS_B0RKED
19 void menu_show_error()
20 {
21         drawstring('0 200 0', _("ERROR - MENU IS VISIBLE BUT NO MENU WAS DEFINED!"), '8 8 0', '1 0 0', 1, 0);
22 }
23
24 // CSQC_Init : Called every time the CSQC code is initialized (essentially at map load)
25 // Useful for precaching things
26
27 void menu_sub_null()
28 {
29 }
30
31 #ifdef USE_FTE
32 float __engine_check;
33 #endif
34
35 void precache_playermodel(string m)
36 {
37         string f;
38
39         if(substring(m, -9,5) == "_lod1")
40                 return;
41         if(substring(m, -9,5) == "_lod2")
42                 return;
43         precache_model(m);
44         f = strcat(substring(m, 0, -5), "_lod1", substring(m, -4, -1));
45         if(fexists(f))
46                 precache_model(f);
47         f = strcat(substring(m, 0, -5), "_lod2", substring(m, -4, -1));
48         if(fexists(f))
49                 precache_model(f);
50
51         /*
52         float globhandle, i, n;
53         globhandle = search_begin(strcat(m, "_*.sounds"), TRUE, FALSE);
54         if (globhandle < 0)
55                 return;
56         n = search_getsize(globhandle);
57         for (i = 0; i < n; ++i)
58         {
59                 //print(search_getfilename(globhandle, i), "\n");
60                 f = search_getfilename(globhandle, i);
61                 PrecachePlayerSounds(f);
62         }
63         search_end(globhandle);
64         */
65 }
66 void precache_all_playermodels(string pattern)
67 {
68         float globhandle, i, n;
69         string f;
70
71         globhandle = search_begin(pattern, TRUE, FALSE);
72         if (globhandle < 0)
73                 return;
74         n = search_getsize(globhandle);
75         for (i = 0; i < n; ++i)
76         {
77                 //print(search_getfilename(globhandle, i), "\n");
78                 f = search_getfilename(globhandle, i);
79                 precache_playermodel(f);
80         }
81         search_end(globhandle);
82 }
83
84 string forcefog;
85 void WaypointSprite_Load();
86 void ConsoleCommand_macro_init();
87 void CSQC_Init(void)
88 {
89         prvm_language = cvar_string("prvm_language");
90 #ifdef USE_FTE
91 #pragma target ID
92         __engine_check = checkextension("DP_SV_WRITEPICTURE");
93         if(!__engine_check)
94         {
95                 print(_("^3Your engine build is outdated\n^3This Server uses a newer QC VM. Please update!\n"));
96                 localcmd("\ndisconnect\n");
97                 return;
98         }
99 #pragma target FTE
100 #endif
101
102         check_unacceptable_compiler_bugs();
103
104 #ifdef WATERMARK
105         print(sprintf(_("^4CSQC Build information: ^1%s\n"), WATERMARK));
106 #endif
107
108         float i;
109
110 #ifdef COMPAT_XON050_ENGINE
111         // old engine lacks implementation of player_localnum
112         player_localnum = player_localentnum - 1;
113 #endif
114
115         binddb = db_create();
116         tempdb = db_create();
117         ClientProgsDB = db_load("client.db");
118         compressShortVector_init();
119
120         draw_endBoldFont();
121         menu_visible = FALSE;
122         menu_show = menu_show_error;
123         menu_action = func_null;
124
125         for(i = 0; i < 255; ++i)
126                 if(getplayerkeyvalue(i, "viewentity") == "")
127                         break;
128         maxclients = i;
129
130         //registercommand("hud_configure");
131         //registercommand("hud_save");
132         //registercommand("menu_action");
133         
134         ConsoleCommand_macro_init();
135
136         registercvar("hud_usecsqc", "1");
137         registercvar("scoreboard_columns", "default");
138
139         gametype = 0;
140
141         // hud_fields uses strunzone on the titles!
142         for(i = 0; i < MAX_HUD_FIELDS; ++i)
143                 hud_title[i] = strzone("(null)");
144
145         postinit = false;
146
147         calledhooks = 0;
148
149         teams = Sort_Spawn();
150         players = Sort_Spawn();
151
152         GetTeam(FL_SPECTATOR, true); // add specs first
153
154         // needs to be done so early because of the constants they create
155         CALL_ACCUMULATED_FUNCTION(RegisterWeapons);
156         CALL_ACCUMULATED_FUNCTION(RegisterGametypes);
157         CALL_ACCUMULATED_FUNCTION(RegisterNotifications);
158         CALL_ACCUMULATED_FUNCTION(RegisterDeathtypes);
159         
160         WaypointSprite_Load();
161
162         // precaches
163         precache_model("null");
164         precache_sound("misc/hit.wav");
165         precache_sound("misc/typehit.wav");
166         if (autocvar_cl_precacheplayermodels)
167         {
168                 precache_all_playermodels("models/player/*.zym");
169                 precache_all_playermodels("models/player/*.dpm");
170                 precache_all_playermodels("models/player/*.md3");
171                 precache_all_playermodels("models/player/*.psk");
172                 precache_all_playermodels("models/player/*.iqm");
173         }
174
175         Projectile_Precache();
176         Hook_Precache();
177         GibSplash_Precache();
178         Casings_Precache();
179         DamageInfo_Precache();
180         Vehicles_Precache();
181         turrets_precache();
182     Announcer_Precache();
183         Tuba_Precache();
184         CSQCPlayer_Precache();
185         
186         if(autocvar_cl_reticle)
187         {
188                 if(autocvar_cl_reticle_item_normal) { precache_pic("gfx/reticle_normal"); }
189                 if(autocvar_cl_reticle_item_nex) { precache_pic("gfx/reticle_nex"); }
190         }
191         
192         get_mi_min_max_texcoords(1); // try the CLEVER way first
193         minimapname = strcat("gfx/", mi_shortname, "_radar.tga");
194         shortmapname = mi_shortname;
195
196         if(precache_pic(minimapname) == "")
197         {
198                 // but maybe we have a non-clever minimap
199                 minimapname = strcat("gfx/", mi_shortname, "_mini.tga");
200                 if(precache_pic(minimapname) == "")
201                         minimapname = ""; // FAIL
202                 else
203                         get_mi_min_max_texcoords(0); // load new texcoords
204         }
205
206         mi_center = (mi_min + mi_max) * 0.5;
207         mi_scale = mi_max - mi_min;
208         minimapname = strzone(minimapname);
209
210         WarpZone_Init();
211
212         hud_skin_path = strzone(strcat("gfx/hud/", autocvar_hud_skin));
213         hud_configure_prev = -1;
214         tab_panel = -1;
215
216         draw_currentSkin = strzone(strcat("gfx/menu/", cvar_string("menu_skin")));
217 }
218
219 // CSQC_Shutdown : Called every time the CSQC code is shutdown (changing maps, quitting, etc)
220 void Shutdown(void)
221 {
222 #ifdef USE_FTE
223 #pragma TARGET id
224         if(!__engine_check)
225                 return 0;
226 #pragma TARGET fte
227 #endif
228
229         WarpZone_Shutdown();
230
231         remove(teams);
232         remove(players);
233         db_close(binddb);
234         db_close(tempdb);
235         if(autocvar_cl_db_saveasdump)
236                 db_dump(ClientProgsDB, "client.db");
237         else
238                 db_save(ClientProgsDB, "client.db");
239         db_close(ClientProgsDB);
240
241         if(camera_active)
242                 cvar_set("chase_active",ftos(chase_active_backup));
243
244         // unset the event chasecam's chase_active
245         if(autocvar_chase_active < 0)
246                 cvar_set("chase_active", "0");
247
248         if not(isdemo())
249         {
250                 if not(calledhooks & HOOK_START)
251                         localcmd("\n_cl_hook_gamestart nop\n");
252                 if not(calledhooks & HOOK_END)
253                         localcmd("\ncl_hook_gameend\n");
254         }
255 }
256
257 .float has_team;
258 float SetTeam(entity o, float Team)
259 {
260         entity tm;
261         if(teamplay)
262         {
263                 switch(Team)
264                 {
265                         case -1:
266                         case FL_TEAM_1:
267                         case FL_TEAM_2:
268                         case FL_TEAM_3:
269                         case FL_TEAM_4:
270                                 break;
271                         default:
272                                 if(GetTeam(Team, false) == world)
273                                 {
274                                         print(sprintf(_("trying to switch to unsupported team %d\n"), Team));
275                                         Team = FL_SPECTATOR;
276                                 }
277                                 break;
278                 }
279         }
280         else
281         {
282                 switch(Team)
283                 {
284                         case -1:
285                         case 0:
286                                 break;
287                         default:
288                                 if(GetTeam(Team, false) == world)
289                                 {
290                                         print(sprintf(_("trying to switch to unsupported team %d\n"), Team));
291                                         Team = FL_SPECTATOR;
292                                 }
293                                 break;
294                 }
295         }
296         if(Team == -1) // leave
297         {
298                 if(o.has_team)
299                 {
300                         tm = GetTeam(o.team, false);
301                         tm.team_size -= 1;
302                         o.has_team = 0;
303                         return TRUE;
304                 }
305         }
306         else
307         {
308                 if not(o.has_team)
309                 {
310                         o.team = Team;
311                         tm = GetTeam(Team, true);
312                         tm.team_size += 1;
313                         o.has_team = 1;
314                         return TRUE;
315                 }
316                 else if(Team != o.team)
317                 {
318                         tm = GetTeam(o.team, false);
319                         tm.team_size -= 1;
320                         o.team = Team;
321                         tm = GetTeam(Team, true);
322                         tm.team_size += 1;
323                         return TRUE;
324                 }
325         }
326         return FALSE;
327 }
328
329 void Playerchecker_Think()
330 {
331         float i;
332         entity e;
333         for(i = 0; i < maxclients; ++i)
334         {
335                 e = playerslots[i];
336                 if(GetPlayerName(i) == "")
337                 {
338                         if(e.sort_prev)
339                         {
340                                 // player disconnected
341                                 SetTeam(e, -1);
342                                 RemovePlayer(e);
343                                 e.sort_prev = world;
344                                 //e.gotscores = 0;
345                         }
346                 }
347                 else
348                 {
349                         if not(e.sort_prev)
350                         {
351                                 // player connected
352                                 if not(e)
353                                         playerslots[i] = e = spawn();
354                                 e.sv_entnum = i;
355                                 e.ping = 0;
356                                 e.ping_packetloss = 0;
357                                 e.ping_movementloss = 0;
358                                 //e.gotscores = 0; // we might already have the scores...
359                                 SetTeam(e, GetPlayerColor(i)); // will not hurt; later updates come with HUD_UpdatePlayerTeams
360                                 RegisterPlayer(e);
361                                 HUD_UpdatePlayerPos(e);
362                         }
363                 }
364         }
365         self.nextthink = time + 0.2;
366 }
367
368 void Porto_Init();
369 void TrueAim_Init();
370 void PostInit(void)
371 {
372         localcmd(strcat("\nscoreboard_columns_set ", autocvar_scoreboard_columns, ";\n"));
373
374         entity playerchecker;
375         playerchecker = spawn();
376         playerchecker.think = Playerchecker_Think;
377         playerchecker.nextthink = time + 0.2;
378
379         Porto_Init();
380         TrueAim_Init();
381
382         postinit = true;
383 }
384
385 float button_zoom;
386
387 // CSQC_InputEvent : Used to perform actions based on any key pressed, key released and mouse on the client.
388 // Return value should be 1 if CSQC handled the input, otherwise return 0 to have the input passed to the engine.
389 // All keys are in ascii.
390 // bInputType = 0 is key pressed, 1 is key released, 2 and 3 are mouse input.
391 // In the case of keyboard input, nPrimary is the ascii code, and nSecondary is 0.
392 // In the case of mouse input, nPrimary is xdelta, nSecondary is ydelta.
393 // In the case of mouse input after a setcursormode(1) call, nPrimary is xpos, nSecondary is ypos.
394 float CSQC_InputEvent(float bInputType, float nPrimary, float nSecondary)
395 {
396         float bSkipKey;
397         bSkipKey = false;
398
399         if (HUD_Panel_InputEvent(bInputType, nPrimary, nSecondary))
400                 return true;
401
402         if (MapVote_InputEvent(bInputType, nPrimary, nSecondary))
403                 return true;
404
405         if(menu_visible && menu_action)
406                 if(menu_action(bInputType, nPrimary, nSecondary))
407                         return TRUE;
408
409         return bSkipKey;
410 }
411
412 // END REQUIRED CSQC FUNCTIONS
413 // --------------------------------------------------------------------------
414
415 // --------------------------------------------------------------------------
416 // BEGIN OPTIONAL CSQC FUNCTIONS
417 void Ent_RemoveEntCS()
418 {
419         entcs_receiver[self.sv_entnum] = world;
420 }
421 void Ent_ReadEntCS()
422 {
423         float sf;
424         InterpolateOrigin_Undo();
425
426         self.classname = "entcs_receiver";
427         sf = ReadByte();
428
429         if(sf & 1)
430                 self.sv_entnum = ReadByte();
431         if(sf & 2)
432         {
433                 self.origin_x = ReadShort();
434                 self.origin_y = ReadShort();
435                 self.origin_z = ReadShort();
436                 setorigin(self, self.origin);
437         }
438         if(sf & 4)
439         {
440                 self.angles_y = ReadByte() * 360.0 / 256;
441                 self.angles_x = self.angles_z = 0;
442         }
443         if(sf & 8)
444                 self.healthvalue = ReadByte() * 10;
445         if(sf & 16)
446                 self.armorvalue = ReadByte() * 10;
447
448         entcs_receiver[self.sv_entnum] = self;
449         self.entremove = Ent_RemoveEntCS;
450
451         InterpolateOrigin_Note();
452 }
453
454 void Ent_Remove();
455
456 void Ent_RemovePlayerScore()
457 {
458         float i;
459
460         if(self.owner)
461         {
462                 SetTeam(self.owner, -1);
463                 self.owner.gotscores = 0;
464                 for(i = 0; i < MAX_SCORE; ++i)
465                         self.owner.(scores[i]) = 0; // clear all scores
466         }
467 }
468
469 void Ent_ReadPlayerScore()
470 {
471         float i, n;
472         float isNew;
473         entity o;
474
475         // damnit -.- don't want to go change every single .sv_entnum in hud.qc AGAIN
476         // (no I've never heard of M-x replace-string, sed, or anything like that)
477         isNew = !self.owner; // workaround for DP bug
478         n = ReadByte()-1;
479
480 #ifdef DP_CSQC_ENTITY_REMOVE_IS_B0RKED
481         if(!isNew && n != self.sv_entnum)
482         {
483                 //print(_("A CSQC entity changed its owner!\n"));
484                 print(sprintf(_("A CSQC entity changed its owner! (edict: %d, classname: %s)\n"), num_for_edict(self), self.classname));
485                 isNew = true;
486                 Ent_Remove();
487                 self.enttype = ENT_CLIENT_SCORES;
488         }
489 #endif
490
491         self.sv_entnum = n;
492
493         if not(playerslots[self.sv_entnum])
494                 playerslots[self.sv_entnum] = spawn();
495         o = self.owner = playerslots[self.sv_entnum];
496         o.sv_entnum = self.sv_entnum;
497         o.gotscores = 1;
498
499         //if not(o.sort_prev)
500         //      RegisterPlayer(o);
501         //playerchecker will do this for us later, if it has not already done so
502
503         float sf, lf;
504 #if MAX_SCORE <= 8
505         sf = ReadByte();
506         lf = ReadByte();
507 #else
508         sf = ReadShort();
509         lf = ReadShort();
510 #endif
511         float p;
512         for(i = 0, p = 1; i < MAX_SCORE; ++i, p *= 2)
513                 if(sf & p)
514                 {
515                         if(lf & p)
516                                 o.(scores[i]) = ReadInt24_t();
517                         else
518                                 o.(scores[i]) = ReadChar();
519                 }
520
521         if(o.sort_prev)
522                 HUD_UpdatePlayerPos(o); // if not registered, we cannot do this yet!
523
524         self.entremove = Ent_RemovePlayerScore;
525 }
526
527 void Ent_ReadTeamScore()
528 {
529         float i;
530         entity o;
531
532         self.team = ReadByte();
533         o = self.owner = GetTeam(self.team, true); // these team numbers can always be trusted
534
535         float sf, lf;
536 #if MAX_TEAMSCORE <= 8
537         sf = ReadByte();
538         lf = ReadByte();
539 #else
540         sf = ReadShort();
541         lf = ReadShort();
542 #endif
543         float p;
544         for(i = 0, p = 1; i < MAX_TEAMSCORE; ++i, p *= 2)
545                 if(sf & p)
546                 {
547                         if(lf & p)
548                                 o.(teamscores[i]) = ReadInt24_t();
549                         else
550                                 o.(teamscores[i]) = ReadChar();
551                 }
552
553         HUD_UpdateTeamPos(o);
554 }
555
556 void Ent_ClientData()
557 {
558         float f;
559         float newspectatee_status;
560
561         f = ReadByte();
562
563         scoreboard_showscores_force = (f & 1);
564
565         if(f & 2)
566         {
567                 newspectatee_status = ReadByte();
568                 if(newspectatee_status == player_localnum + 1)
569                         newspectatee_status = -1; // observing
570         }
571         else
572                 newspectatee_status = 0;
573
574         spectatorbutton_zoom = (f & 4);
575
576         if(f & 8)
577         {
578                 angles_held_status = 1;
579                 angles_held_x = ReadAngle();
580                 angles_held_y = ReadAngle();
581                 angles_held_z = 0;
582         }
583         else
584                 angles_held_status = 0;
585
586         if(newspectatee_status != spectatee_status)
587         {
588                 // clear race stuff
589                 race_laptime = 0;
590                 race_checkpointtime = 0;
591         }
592         if (autocvar_hud_panel_healtharmor_progressbar_gfx)
593         {
594                 if ( (spectatee_status == -1 && newspectatee_status > 0) //before observing, now spectating
595                   || (spectatee_status > 0 && newspectatee_status > 0 && spectatee_status != newspectatee_status) //changed spectated player
596                 )
597                         prev_p_health = -1;
598                 else if(spectatee_status && !newspectatee_status) //before observing/spectating, now playing
599                         prev_health = -1;
600         }
601         spectatee_status = newspectatee_status;
602
603         // non-COMPAT_XON050_ENGINE: we could get rid of spectatee_status, and derive it from player_localentnum and player_localnum
604 }
605
606 void Ent_Nagger()
607 {
608         float nags, i, j, b, f;
609
610         nags = ReadByte(); // NAGS NAGS NAGS NAGS NAGS NAGS NADZ NAGS NAGS NAGS
611
612         if(!(nags & 4))
613         {
614                 if(vote_called_vote)
615                         strunzone(vote_called_vote);
616                 vote_called_vote = string_null;
617                 vote_active = 0;
618         }
619         else
620         {
621                 vote_active = 1;
622         }
623
624         if(nags & 64)
625         {
626                 vote_yescount = ReadByte();
627                 vote_nocount = ReadByte();
628                 vote_needed = ReadByte();
629                 vote_highlighted = ReadChar();
630         }
631
632         if(nags & 128)
633         {
634                 if(vote_called_vote)
635                         strunzone(vote_called_vote);
636                 vote_called_vote = strzone(ColorTranslateRGB(ReadString()));
637         }
638
639         if(nags & 1)
640         {
641                 for(j = 0; j < maxclients; ++j)
642                         if(playerslots[j])
643                                 playerslots[j].ready = 1;
644                 for(i = 1; i <= maxclients; i += 8)
645                 {
646                         f = ReadByte();
647                         for(j = i-1, b = 1; b < 256; b *= 2, ++j)
648                                 if not(f & b)
649                                         if(playerslots[j])
650                                                 playerslots[j].ready = 0;
651                 }
652         }
653
654         ready_waiting = (nags & 1);
655         ready_waiting_for_me = (nags & 2);
656         vote_waiting = (nags & 4);
657         vote_waiting_for_me = (nags & 8);
658         warmup_stage = (nags & 16);
659 }
660
661 void Ent_RandomSeed()
662 {
663         float s;
664         prandom_debug();
665         s = ReadShort();
666         psrandom(s);
667 }
668
669 void Ent_ReadAccuracy(void)
670 {
671         float sf, f, w, b;
672         sf = ReadInt24_t();
673         if(sf == 0)
674         {
675                 for(w = 0; w <= WEP_LAST - WEP_FIRST; ++w)
676                         weapon_accuracy[w] = -1;
677                 return;
678         }
679
680         for(w = 0, f = 1; w <= WEP_LAST - WEP_FIRST; ++w)
681         {
682                 if(sf & f)
683                 {
684                         b = ReadByte();
685                         if(b == 0)
686                                 weapon_accuracy[w] = -1;
687                         else if(b == 255)
688                                 weapon_accuracy[w] = 1.0; // no better error handling yet, sorry
689                         else
690                                 weapon_accuracy[w] = (b - 1.0) / 100.0;
691                 }
692                 if(f == 0x800000)
693                         f = 1;
694                 else
695                         f *= 2;
696         }
697 }
698
699 // CSQC_Ent_Update : Called every frame that the server has indicated an update to the SSQC / CSQC entity has occured.
700 // The only parameter reflects if the entity is "new" to the client, meaning it just came into the client's PVS.
701 void Ent_RadarLink();
702 void Ent_Init();
703 void Ent_ScoresInfo();
704 void CSQC_Ent_Update(float bIsNewEntity)
705 {
706         float t;
707         float savetime;
708         t = ReadByte();
709
710         if(autocvar_developer_csqcentities)
711                 print(sprintf("CSQC_Ent_Update(%d) with self=%i self.entnum=%d self.enttype=%d t=%d\n", bIsNewEntity, self, self.entnum, self.enttype, t));
712
713         // set up the "time" global for received entities to be correct for interpolation purposes
714         savetime = time;
715         if(servertime)
716         {
717                 time = servertime;
718         }
719         else
720         {
721                 serverprevtime = time;
722                 serverdeltatime = getstatf(STAT_MOVEVARS_TICRATE) * getstatf(STAT_MOVEVARS_TIMESCALE);
723                 time = serverprevtime + serverdeltatime;
724         }
725
726 #ifdef DP_CSQC_ENTITY_REMOVE_IS_B0RKED
727         if(self.enttype)
728         {
729                 if(t != self.enttype || bIsNewEntity)
730                 {
731                         //print(_("A CSQC entity changed its type!\n"));
732                         print(sprintf(_("A CSQC entity changed its type! (edict: %d, server: %d, type: %d -> %d)\n"), num_for_edict(self), self.entnum, self.enttype, t));
733                         Ent_Remove();
734                         clearentity(self);
735                         bIsNewEntity = 1;
736                 }
737         }
738         else
739         {
740                 if(!bIsNewEntity)
741                 {
742                         print(sprintf(_("A CSQC entity appeared out of nowhere! (edict: %d, server: %d, type: %d)\n"), num_for_edict(self), self.entnum, t));
743                         bIsNewEntity = 1;
744                 }
745         }
746 #endif
747         self.enttype = t;
748         switch(t)
749         {
750                 case ENT_CLIENT_ENTCS: Ent_ReadEntCS(); break;
751                 case ENT_CLIENT_SCORES: Ent_ReadPlayerScore(); break;
752                 case ENT_CLIENT_TEAMSCORES: Ent_ReadTeamScore(); break;
753                 case ENT_CLIENT_POINTPARTICLES: Ent_PointParticles(); break;
754                 case ENT_CLIENT_RAINSNOW: Ent_RainOrSnow(); break;
755                 case ENT_CLIENT_LASER: Ent_Laser(); break;
756                 case ENT_CLIENT_NAGGER: Ent_Nagger(); break;
757                 case ENT_CLIENT_WAYPOINT: Ent_WaypointSprite(); break;
758                 case ENT_CLIENT_RADARLINK: Ent_RadarLink(); break;
759                 case ENT_CLIENT_PROJECTILE: Ent_Projectile(); break;
760                 case ENT_CLIENT_GIBSPLASH: Ent_GibSplash(bIsNewEntity); break;
761                 case ENT_CLIENT_DAMAGEINFO: Ent_DamageInfo(bIsNewEntity); break;
762                 case ENT_CLIENT_CASING: Ent_Casing(bIsNewEntity); break;
763                 case ENT_CLIENT_INIT: Ent_Init(); break;
764                 case ENT_CLIENT_SCORES_INFO: Ent_ScoresInfo(); break;
765                 case ENT_CLIENT_MAPVOTE: Ent_MapVote(); break;
766                 case ENT_CLIENT_CLIENTDATA: Ent_ClientData(); break;
767                 case ENT_CLIENT_RANDOMSEED: Ent_RandomSeed(); break;
768                 case ENT_CLIENT_WALL: Ent_Wall(); break;
769                 case ENT_CLIENT_MODELEFFECT: Ent_ModelEffect(bIsNewEntity); break;
770                 case ENT_CLIENT_TUBANOTE: Ent_TubaNote(bIsNewEntity); break;
771                 case ENT_CLIENT_WARPZONE: WarpZone_Read(bIsNewEntity); break;
772                 case ENT_CLIENT_WARPZONE_CAMERA: WarpZone_Camera_Read(bIsNewEntity); break;
773                 case ENT_CLIENT_WARPZONE_TELEPORTED: WarpZone_Teleported_Read(bIsNewEntity); break;
774                 case ENT_CLIENT_TRIGGER_MUSIC: Ent_ReadTriggerMusic(); break;
775                 case ENT_CLIENT_HOOK: Ent_ReadHook(bIsNewEntity, ENT_CLIENT_HOOK); break;
776                 case ENT_CLIENT_LGBEAM: Ent_ReadHook(bIsNewEntity, ENT_CLIENT_LGBEAM); break;
777                 case ENT_CLIENT_GAUNTLET: Ent_ReadHook(bIsNewEntity, ENT_CLIENT_GAUNTLET); break;
778                 case ENT_CLIENT_ACCURACY: Ent_ReadAccuracy(); break;
779                 case ENT_CLIENT_AUXILIARYXHAIR: Net_AuXair2(bIsNewEntity); break;
780                 case ENT_CLIENT_TURRET: ent_turret(); break; 
781                 case ENT_CLIENT_MODEL: CSQCModel_Read(bIsNewEntity); break;
782                 case ENT_CLIENT_ITEM: ItemRead(bIsNewEntity); break;  
783                 case ENT_CLIENT_BUMBLE_RAYGUN: bumble_raygun_read(bIsNewEntity); break;
784                 case ENT_CLIENT_NOTIFICATION: Read_Notification(bIsNewEntity); break;
785                 default:
786                         //error(strcat(_("unknown entity type in CSQC_Ent_Update: %d\n"), self.enttype));
787                         error(sprintf(_("Unknown entity type in CSQC_Ent_Update (enttype: %d, edict: %d, classname: %s)\n"), self.enttype, num_for_edict(self), self.classname));
788                         break;
789         }
790
791         time = savetime;
792 }
793 // Destructor, but does NOT deallocate the entity by calling remove(). Also
794 // used when an entity changes its type. For an entity that someone interacts
795 // with others, make sure it can no longer do so.
796 void Ent_Remove()
797 {
798         if(self.entremove)
799                 self.entremove();
800
801         if(self.skeletonindex)
802         {
803                 skel_delete(self.skeletonindex);
804                 self.skeletonindex = 0;
805         }
806
807         if(self.snd_looping > 0)
808         {
809                 sound(self, self.snd_looping, "misc/null.wav", VOL_BASE, autocvar_g_jetpack_attenuation);
810                 self.snd_looping = 0;
811         }
812
813         self.enttype = 0;
814         self.classname = "";
815         self.draw = menu_sub_null;
816         self.entremove = menu_sub_null;
817         // TODO possibly set more stuff to defaults
818 }
819 // CSQC_Ent_Remove : Called when the server requests a SSQC / CSQC entity to be removed.  Essentially call remove(self) as well.
820 void CSQC_Ent_Remove()
821 {
822         if(autocvar_developer_csqcentities)
823                 print(sprintf("CSQC_Ent_Remove() with self=%i self.entnum=%d self.enttype=%d\n", self, self.entnum, self.enttype));
824
825         if(wasfreed(self))
826         {
827                 print("WARNING: CSQC_Ent_Remove called for already removed entity. Packet loss?\n");
828                 return;
829         }
830         if(self.enttype)
831                 Ent_Remove();
832         remove(self);
833 }
834
835 void Gamemode_Init()
836 {
837         if not(isdemo())
838         {
839                 if(!(calledhooks & HOOK_START))
840                         localcmd("\n_cl_hook_gamestart ", MapInfo_Type_ToString(gametype), "\n");
841                 calledhooks |= HOOK_START;
842         }
843 }
844 // 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.
845 void CSQC_Parse_StuffCmd(string strMessage)
846 {
847         if(autocvar_developer_csqcentities)
848                 print(sprintf("CSQC_Parse_StuffCmd(\"%s\")\n", strMessage));
849
850         localcmd(strMessage);
851 }
852 // 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.
853 void CSQC_Parse_Print(string strMessage)
854 {
855         if(autocvar_developer_csqcentities)
856                 print(sprintf("CSQC_Parse_Print(\"%s\")\n", strMessage));
857
858         print(ColorTranslateRGB(strMessage));
859 }
860
861 // CSQC_Parse_CenterPrint : Provides the centerprint_hud string in the first parameter that the server provided.
862 void CSQC_Parse_CenterPrint(string strMessage)
863 {
864         if(autocvar_developer_csqcentities)
865                 print(sprintf("CSQC_Parse_CenterPrint(\"%s\")\n", strMessage));
866
867         centerprint_hud(strMessage);
868 }
869
870 string notranslate_fogcmd1 = "\nfog ";
871 string notranslate_fogcmd2 = "\nr_fog_exp2 0\nr_drawfog 1\n";
872 void Fog_Force()
873 {
874         // TODO somehow thwart prvm_globalset client ...
875
876         if(forcefog != "")
877                 localcmd(strcat(notranslate_fogcmd1, forcefog, notranslate_fogcmd2));
878 }
879
880 void Gamemode_Init();
881 void Ent_ScoresInfo()
882 {
883         float i;
884         self.classname = "ent_client_scores_info";
885         gametype = ReadInt24_t();
886         for(i = 0; i < MAX_SCORE; ++i)
887         {
888                 scores_label[i] = strzone(ReadString());
889                 scores_flags[i] = ReadByte();
890         }
891         for(i = 0; i < MAX_TEAMSCORE; ++i)
892         {
893                 teamscores_label[i] = strzone(ReadString());
894                 teamscores_flags[i] = ReadByte();
895         }
896         HUD_InitScores();
897         Gamemode_Init();
898 }
899
900 void Ent_Init()
901 {
902         self.classname = "ent_client_init";
903
904         nb_pb_period = ReadByte() / 32; //Accuracy of 1/32th
905
906         hook_shotorigin[0] = decompressShotOrigin(ReadInt24_t());
907         hook_shotorigin[1] = decompressShotOrigin(ReadInt24_t());
908         hook_shotorigin[2] = decompressShotOrigin(ReadInt24_t());
909         hook_shotorigin[3] = decompressShotOrigin(ReadInt24_t());
910         electro_shotorigin[0] = decompressShotOrigin(ReadInt24_t());
911         electro_shotorigin[1] = decompressShotOrigin(ReadInt24_t());
912         electro_shotorigin[2] = decompressShotOrigin(ReadInt24_t());
913         electro_shotorigin[3] = decompressShotOrigin(ReadInt24_t());
914         gauntlet_shotorigin[0] = decompressShotOrigin(ReadInt24_t());
915         gauntlet_shotorigin[1] = decompressShotOrigin(ReadInt24_t());
916         gauntlet_shotorigin[2] = decompressShotOrigin(ReadInt24_t());
917         gauntlet_shotorigin[3] = decompressShotOrigin(ReadInt24_t());
918
919         if(forcefog)
920                 strunzone(forcefog);
921         forcefog = strzone(ReadString());
922
923         armorblockpercent = ReadByte() / 255.0;
924
925         g_weaponswitchdelay = ReadByte() / 255.0;
926
927         g_balance_grenadelauncher_bouncefactor = ReadCoord();
928         g_balance_grenadelauncher_bouncestop = ReadCoord();
929         g_balance_electro_secondary_bouncefactor = ReadCoord();
930         g_balance_electro_secondary_bouncestop = ReadCoord();
931
932         nex_scope = !ReadByte();
933         rifle_scope = !ReadByte();
934
935         serverflags = ReadByte();
936
937         minelayer_maxmines = ReadByte();
938
939         hagar_maxrockets = ReadByte();
940
941         g_trueaim_minrange = ReadCoord();
942         g_balance_porto_secondary = ReadByte();
943
944         if(!postinit)
945                 PostInit();
946 }
947
948 void Net_ReadRace()
949 {
950         float b;
951
952         b = ReadByte();
953
954         switch(b)
955         {
956                 case RACE_NET_CHECKPOINT_HIT_QUALIFYING:
957                         race_checkpoint = ReadByte();
958                         race_time = ReadInt24_t();
959                         race_previousbesttime = ReadInt24_t();
960                         if(race_previousbestname)
961                                 strunzone(race_previousbestname);
962                         race_previousbestname = strzone(ColorTranslateRGB(ReadString()));
963
964                         race_checkpointtime = time;
965
966                         if(race_checkpoint == 0 || race_checkpoint == 254)
967                         {
968                                 race_penaltyaccumulator = 0;
969                                 race_laptime = time; // valid
970                         }
971
972                         break;
973
974                 case RACE_NET_CHECKPOINT_CLEAR:
975                         race_laptime = 0;
976                         race_checkpointtime = 0;
977                         break;
978
979                 case RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING:
980                         race_laptime = ReadCoord();
981                         race_checkpointtime = -99999;
982                         // fall through
983                 case RACE_NET_CHECKPOINT_NEXT_QUALIFYING:
984                         race_nextcheckpoint = ReadByte();
985
986                         race_nextbesttime = ReadInt24_t();
987                         if(race_nextbestname)
988                                 strunzone(race_nextbestname);
989                         race_nextbestname = strzone(ColorTranslateRGB(ReadString()));
990                         break;
991
992                 case RACE_NET_CHECKPOINT_HIT_RACE:
993                         race_mycheckpoint = ReadByte();
994                         race_mycheckpointtime = time;
995                         race_mycheckpointdelta = ReadInt24_t();
996                         race_mycheckpointlapsdelta = ReadByte();
997                         if(race_mycheckpointlapsdelta >= 128)
998                                 race_mycheckpointlapsdelta -= 256;
999                         if(race_mycheckpointenemy)
1000                                 strunzone(race_mycheckpointenemy);
1001                         race_mycheckpointenemy = strzone(ColorTranslateRGB(ReadString()));
1002                         break;
1003
1004                 case RACE_NET_CHECKPOINT_HIT_RACE_BY_OPPONENT:
1005                         race_othercheckpoint = ReadByte();
1006                         race_othercheckpointtime = time;
1007                         race_othercheckpointdelta = ReadInt24_t();
1008                         race_othercheckpointlapsdelta = ReadByte();
1009                         if(race_othercheckpointlapsdelta >= 128)
1010                                 race_othercheckpointlapsdelta -= 256;
1011                         if(race_othercheckpointenemy)
1012                                 strunzone(race_othercheckpointenemy);
1013                         race_othercheckpointenemy = strzone(ColorTranslateRGB(ReadString()));
1014                         break;
1015
1016                 case RACE_NET_PENALTY_RACE:
1017                         race_penaltyeventtime = time;
1018                         race_penaltytime = ReadShort();
1019                         //race_penaltyaccumulator += race_penaltytime;
1020                         if(race_penaltyreason)
1021                                 strunzone(race_penaltyreason);
1022                         race_penaltyreason = strzone(ReadString());
1023                         break;
1024
1025                 case RACE_NET_PENALTY_QUALIFYING:
1026                         race_penaltyeventtime = time;
1027                         race_penaltytime = ReadShort();
1028                         race_penaltyaccumulator += race_penaltytime;
1029                         if(race_penaltyreason)
1030                                 strunzone(race_penaltyreason);
1031                         race_penaltyreason = strzone(ReadString());
1032                         break;
1033
1034                 case RACE_NET_SERVER_RECORD:
1035                         race_server_record = ReadInt24_t();
1036                         break;
1037                 case RACE_NET_SPEED_AWARD:
1038                         race_speedaward = ReadInt24_t();
1039                         if(race_speedaward_holder)
1040                                 strunzone(race_speedaward_holder);
1041                         race_speedaward_holder = strzone(ReadString());
1042                         break;
1043                 case RACE_NET_SPEED_AWARD_BEST:
1044                         race_speedaward_alltimebest = ReadInt24_t();
1045                         if(race_speedaward_alltimebest_holder)
1046                                 strunzone(race_speedaward_alltimebest_holder);
1047                         race_speedaward_alltimebest_holder = strzone(ReadString());
1048                         break;
1049                 case RACE_NET_SERVER_RANKINGS:
1050                         float pos, prevpos, del;
1051                         pos = ReadShort();
1052                         prevpos = ReadShort();
1053                         del = ReadShort();
1054
1055                         // move other rankings out of the way
1056                         float i;
1057                         if (prevpos) {
1058                                 for (i=prevpos-1;i>pos-1;--i) {
1059                                         grecordtime[i] = grecordtime[i-1];
1060                                         if(grecordholder[i])
1061                                                 strunzone(grecordholder[i]);
1062                                         grecordholder[i] = strzone(grecordholder[i-1]);
1063                                 }
1064                         } else if (del) { // a record has been deleted by the admin
1065                                 for (i=pos-1; i<= RANKINGS_CNT-1; ++i) {
1066                                         if (i == RANKINGS_CNT-1) { // clear out last record
1067                                                 grecordtime[i] = 0;
1068                                                 if (grecordholder[i])
1069                                                         strunzone(grecordholder[i]);
1070                                                 grecordholder[i] = string_null;
1071                                         }
1072                                         else {
1073                                                 grecordtime[i] = grecordtime[i+1];
1074                                                 if (grecordholder[i])
1075                                                         strunzone(grecordholder[i]);
1076                                                 grecordholder[i] = strzone(grecordholder[i+1]);
1077                                         }
1078                                 }
1079                         } else { // player has no ranked record yet
1080                                 for (i=RANKINGS_CNT-1;i>pos-1;--i) {
1081                                         grecordtime[i] = grecordtime[i-1];
1082                                         if(grecordholder[i])
1083                                                 strunzone(grecordholder[i]);
1084                                         grecordholder[i] = strzone(grecordholder[i-1]);
1085                                 }
1086                         }
1087
1088                         // store new ranking
1089                         if(grecordholder[pos-1] != "")
1090                                 strunzone(grecordholder[pos-1]);
1091                         grecordholder[pos-1] = strzone(ReadString());
1092                         grecordtime[pos-1] = ReadInt24_t();
1093                         if(grecordholder[pos-1] == GetPlayerName(player_localnum))
1094                                 race_myrank = pos;
1095                         break;
1096                 case RACE_NET_SERVER_STATUS:
1097                         race_status = ReadShort();
1098                         if(race_status_name)
1099                                 strunzone(race_status_name);
1100                         race_status_name = strzone(ReadString());
1101         }
1102 }
1103
1104 void Net_ReadSpawn()
1105 {
1106         zoomin_effect = 1;
1107         current_viewzoom = (1 / bound(1, autocvar_cl_spawnzoom_factor, 16));
1108 }
1109
1110 void Net_TeamNagger()
1111 {
1112         teamnagger = 1;
1113 }
1114
1115 void Net_ReadPingPLReport()
1116 {
1117         float e, pi, pl, ml;
1118         e = ReadByte();
1119         pi = ReadShort();
1120         pl = ReadByte();
1121         ml = ReadByte();
1122         if not(playerslots[e])
1123                 return;
1124         playerslots[e].ping = pi;
1125         playerslots[e].ping_packetloss = pl / 255.0;
1126         playerslots[e].ping_movementloss = ml / 255.0;
1127 }
1128
1129 void Net_WeaponComplain() {
1130         complain_weapon = ReadByte();
1131
1132         if(complain_weapon_name)
1133                 strunzone(complain_weapon_name);
1134         complain_weapon_name = strzone(ReadString());
1135
1136         complain_weapon_type = ReadByte();
1137
1138         complain_weapon_time = time;
1139         weapontime = time; // ping the weapon panel
1140 }
1141
1142 // CSQC_Parse_TempEntity : Handles all temporary entity network data in the CSQC layer.
1143 // You must ALWAYS first acquire the temporary ID, which is sent as a byte.
1144 // Return value should be 1 if CSQC handled the temporary entity, otherwise return 0 to have the engine process the event.
1145 float CSQC_Parse_TempEntity()
1146 {
1147         float bHandled;
1148                 bHandled  = true;
1149         // Acquire TE ID
1150         float nTEID;
1151                 nTEID = ReadByte();
1152
1153         if(autocvar_developer_csqcentities)
1154                 print(sprintf("CSQC_Parse_TempEntity() with nTEID=%d\n", nTEID));
1155
1156                 // NOTE: Could just do return instead of break...
1157         switch(nTEID)
1158         {
1159                 case TE_CSQC_TARGET_MUSIC:
1160                         Net_TargetMusic();
1161                         bHandled = true;
1162                         break;
1163                 case TE_CSQC_PICTURE:
1164                         Net_MapVote_Picture();
1165                         bHandled = true;
1166                         break;
1167                 case TE_CSQC_RACE:
1168                         Net_ReadRace();
1169                         bHandled = true;
1170                         break;
1171                 case TE_CSQC_SPAWN:
1172                         Net_ReadSpawn();
1173                         bHandled = true;
1174                         break;
1175                 case TE_CSQC_ZCURVEPARTICLES:
1176                         Net_ReadZCurveParticles();
1177                         bHandled = true;
1178                         break;
1179                 case TE_CSQC_NEXGUNBEAMPARTICLE:
1180                         Net_ReadNexgunBeamParticle();
1181                         bHandled = true;
1182                         break;
1183                 case TE_CSQC_TEAMNAGGER:
1184                         Net_TeamNagger();
1185                         bHandled = true;
1186                         break;
1187                 case TE_CSQC_LIGHTNINGARC:
1188                         Net_ReadLightningarc();
1189                         bHandled = true;
1190                         break;
1191                 case TE_CSQC_PINGPLREPORT:
1192                         Net_ReadPingPLReport();
1193                         bHandled = true;
1194                         break;
1195                 case TE_CSQC_ANNOUNCE:
1196                         Announcer_Play(ReadString());
1197                         bHandled = true;
1198                         break;
1199                 case TE_CSQC_KILLNOTIFY:
1200                         HUD_KillNotify(ReadString(), ReadString(), ReadString(), ReadShort(), ReadByte());
1201                         bHandled = true;
1202                         break;
1203                 case TE_CSQC_CENTERPRINT_GENERIC:
1204                         float id;
1205                         string s;
1206                         id = ReadByte();
1207                         s = ReadString();
1208                         if (id != 0 && s != "")
1209                                 centerprint_generic(id, s, ReadByte(), ReadByte());
1210                         else
1211                                 centerprint_generic(id, s, 0, 0);
1212                         bHandled = true;
1213                         break;
1214                 case TE_CSQC_WEAPONCOMPLAIN:
1215                         Net_WeaponComplain();
1216                         bHandled = true;
1217                         break;
1218                 case TE_CSQC_VEHICLESETUP:
1219                         Net_VehicleSetup();
1220                         bHandled = true;
1221                         break;
1222                 case TE_CSQC_SVNOTICE:
1223                         cl_notice_read();
1224                         bHandled = true;
1225                         break;
1226                 default:
1227                         // No special logic for this temporary entity; return 0 so the engine can handle it
1228                         bHandled = false;
1229                         break;
1230         }
1231
1232         return bHandled;
1233 }
1234
1235 string getcommandkey(string text, string command)
1236 {
1237         string keys;
1238         float n, j, k, l = 0;
1239
1240         if (!autocvar_hud_showbinds)
1241                 return text;
1242
1243         keys = db_get(binddb, command);
1244         if (keys == "")
1245         {
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                                 if ("" == keys)
1253                                         keys = keynumtostring(k);
1254                                 else
1255                                         keys = strcat(keys, ", ", keynumtostring(k));
1256
1257                                 ++l;
1258                                 if (autocvar_hud_showbinds_limit > 0 && autocvar_hud_showbinds_limit <= l)
1259                                         break;
1260                         }
1261
1262                 }
1263                 if (keys == "")
1264                         keys = "NO_KEY";
1265                 db_put(binddb, command, keys);
1266         }
1267
1268         if (keys == "NO_KEY") {
1269                 if (autocvar_hud_showbinds > 1)
1270                         return sprintf(_("%s (not bound)"), text);
1271                 else
1272                         return text;
1273         }
1274         else if (autocvar_hud_showbinds > 1)
1275                 return sprintf(_("%s (%s)"), text, keys);
1276         else
1277                 return keys;
1278 }