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