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