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