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