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