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