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