3 #include <client/command/cl_cmd.qh>
4 #include <client/draw.qh>
5 #include <client/hud/_mod.qh>
6 #include <client/hud/panel/centerprint.qh>
7 #include <client/hud/panel/chat.qh>
8 #include <client/hud/panel/quickmenu.qh>
9 #include <client/hud/panel/scoreboard.qh>
10 #include <client/items/items.qh>
11 #include <client/mapvoting.qh>
12 #include <client/mutators/_mod.qh>
13 #include <client/shownames.qh>
14 #include <client/view.qh>
15 #include <client/weapons/projectile.qh>
16 #include <common/deathtypes/all.qh>
17 #include <common/effects/all.inc>
18 #include <common/effects/all.qh>
19 #include <common/effects/effect.qh>
20 #include <common/effects/qc/_mod.qh>
21 #include <common/ent_cs.qh>
22 #include <common/gamemodes/gamemode/nexball/cl_nexball.qh>
23 #include <common/items/_mod.qh>
24 #include <common/mapinfo.qh>
25 #include <common/mapobjects/_mod.qh>
26 #include <common/minigames/cl_minigames.qh>
27 #include <common/minigames/cl_minigames_hud.qh>
28 #include <common/net_linked.qh>
29 #include <common/net_notice.qh>
30 #include <common/scores.qh>
31 #include <common/vehicles/all.qh>
32 #include <lib/csqcmodel/cl_model.qh>
33 #include <lib/csqcmodel/interpolate.qh>
34 #include <lib/warpzone/client.qh>
36 // --------------------------------------------------------------------------
37 // BEGIN REQUIRED CSQC FUNCTIONS
40 #define DP_CSQC_ENTITY_REMOVE_IS_B0RKED
42 // CSQC_Init : Called every time the CSQC code is initialized (essentially at map load)
43 // Useful for precaching things
47 prvm_language = strzone(cvar_string("prvm_language"));
50 LOG_TRACEF("^4CSQC Build information: ^1%s", WATERMARK);
56 if (getplayerkeyvalue(i, "viewentity") == "")
61 // needs to be done so early because of the constants they create
64 static_init_precache();
68 ClientProgsDB = db_load("client.db");
72 //registercommand("hud_configure");
73 //registercommand("hud_save");
74 //registercommand("menu_action");
76 ConsoleCommand_macro_init();
78 registercvar("hud_usecsqc", "1");
79 registercvar("scoreboard_columns", "default");
81 registercvar("cl_nade_type", "3");
82 registercvar("cl_pokenade_type", "zombie");
84 registercvar("cl_jumpspeedcap_min", "");
85 registercvar("cl_jumpspeedcap_max", "");
87 registercvar("cl_shootfromfixedorigin", "");
89 registercvar("cl_multijump", "-1");
91 registercvar("cl_dodging", "0");
93 registercvar("cl_spawn_near_teammate", "1");
95 registercvar("cl_weapon_switch_reload", "1");
96 registercvar("cl_weapon_switch_fallback_to_impulse", "1");
98 registercvar("cl_allow_uidranking", "1");
100 if(autocvar_cl_lockview)
101 cvar_set("cl_lockview", "0");
103 if (cvar_type("_scoreboard_team_selection_available") & CVAR_TYPEFLAG_EXISTS)
104 cvar_settemp("_scoreboard_team_selection_available", "1");
105 cvar_set("_scoreboard_team_selection", "0"); // in case it has been left set to 1
113 teams = Sort_Spawn();
114 players = Sort_Spawn();
116 GetTeam(NUM_SPECTATOR, true); // add specs first
118 for (int w = 0; w <= WEP_LAST - WEP_FIRST; ++w)
119 weapon_accuracy[w] = -1;
123 if(autocvar_cl_reticle)
125 precache_pic("gfx/reticle_normal");
126 // weapon reticles are precached in weapon files
130 get_mi_min_max_texcoords(1); // try the CLEVER way first
131 minimapname = strcat("gfx/", mi_shortname, "_radar");
133 if (precache_pic(minimapname) == "")
135 // but maybe we have a non-clever minimap
136 minimapname = strcat("gfx/", mi_shortname, "_mini");
137 if (precache_pic(minimapname) == "")
138 minimapname = ""; // FAIL
140 get_mi_min_max_texcoords(0); // load new texcoords
143 mi_center = (mi_min + mi_max) * 0.5;
144 mi_scale = mi_max - mi_min;
145 minimapname = strzone(minimapname);
148 hud_skin_path = strzone(strcat("gfx/hud/", autocvar_hud_skin));
149 LoadMenuSkinValues();
152 // CSQC_Shutdown : Called every time the CSQC code is shutdown (changing maps, quitting, etc)
161 if(autocvar_cl_db_saveasdump)
162 db_dump(ClientProgsDB, "client.db");
164 db_save(ClientProgsDB, "client.db");
165 db_close(ClientProgsDB);
168 cvar_set("chase_active",ftos(chase_active_backup));
170 // unset the event chasecam's chase_active
171 if(autocvar_chase_active < 0)
172 cvar_set("chase_active", "0");
174 if (autocvar_r_drawviewmodel < 0)
175 cvar_set("r_drawviewmodel", "0");
177 cvar_set("slowmo", cvar_defstring("slowmo")); // reset it back to 'default'
181 if (!(calledhooks & HOOK_START))
182 localcmd("\n_cl_hook_gamestart nop\n");
183 if (!(calledhooks & HOOK_END))
185 int gamecount = cvar("cl_matchcount");
186 localcmd("\ncl_hook_gameend\n");
187 // NOTE: using localcmd here to ensure it's executed AFTER cl_hook_gameend
188 // earlier versions of the game abuse the hook to set this cvar
189 localcmd(strcat("cl_matchcount ", itos(gamecount + 1), "\n"));
190 //cvar_set("cl_matchcount", itos(gamecount + 1));
194 localcmd("\ncl_hook_shutdown\n");
196 localcmd("\n-button12\n");
198 deactivate_minigame();
199 HUD_MinigameMenu_Close(NULL, NULL, NULL);
201 ReplicateVars(REPLICATEVARS_DESTROY);
210 for(e = prev.sort_next; e; prev = e, e = e.sort_next)
212 if(prev != e.sort_prev)
213 error(strcat("sort list chain error\nplease submit the output of 'prvm_edicts client' to the developers"));
217 for(e = prev.sort_next; e; prev = e, e = e.sort_next)
219 if(prev != e.sort_prev)
220 error(strcat("sort list chain error\nplease submit the output of 'prvm_edicts client' to the developers"));
224 float RegisterPlayer(entity player)
228 for(pl = players.sort_next; pl; pl = pl.sort_next)
230 error("Player already registered!");
231 player.sort_next = players.sort_next;
232 player.sort_prev = players;
233 if(players.sort_next)
234 players.sort_next.sort_prev = player;
235 players.sort_next = player;
240 void RemovePlayer(entity player)
245 for(pl = players.sort_next; pl && pl != player; pl = pl.sort_next)
250 error("Trying to remove a player which is not in the playerlist!");
253 parent.sort_next = player.sort_next;
255 player.sort_next.sort_prev = parent;
259 void MoveToLast(entity e)
262 entity ent = e.sort_next;
271 float RegisterTeam(entity Team)
273 assert_once(Team.team, eprint(Team));
276 for(tm = teams.sort_next; tm; tm = tm.sort_next)
278 error("Team already registered!");
279 Team.sort_next = teams.sort_next;
280 Team.sort_prev = teams;
282 teams.sort_next.sort_prev = Team;
283 teams.sort_next = Team;
284 if(Team.team && Team.team != NUM_SPECTATOR)
290 void RemoveTeam(entity Team)
295 for(tm = teams.sort_next; tm && tm != Team; tm = tm.sort_next)
300 LOG_INFO(_("Trying to remove a team which is not in the teamlist!"));
303 parent.sort_next = Team.sort_next;
305 Team.sort_next.sort_prev = parent;
306 if(Team.team && Team.team != NUM_SPECTATOR)
311 entity GetTeam(int Team, bool add)
313 TC(int, Team); TC(bool, add);
314 int num = (Team == NUM_SPECTATOR) ? 16 : Team;
316 return teamslots[num];
319 entity tm = new_pure(team);
327 bool SetTeam(entity o, int Team)
330 //devassert_once(Team);
343 if(GetTeam(Team, false) == NULL)
345 LOG_TRACEF("trying to switch to unsupported team %d", Team);
346 Team = NUM_SPECTATOR;
359 if(GetTeam(Team, false) == NULL)
361 LOG_TRACEF("trying to switch to unsupported team %d", Team);
362 Team = NUM_SPECTATOR;
367 if(Team == -1) // leave
371 tm = GetTeam(o.team, false);
382 tm = GetTeam(Team, true);
387 else if(Team != o.team)
389 tm = GetTeam(o.team, false);
392 tm = GetTeam(Team, true);
400 void Playerchecker_Think(entity this)
404 for(i = 0; i < maxclients; ++i)
407 if(entcs_GetName(i) == "")
411 // player disconnected
425 playerslots[i] = e = new_pure(playerslot);
429 e.ping_packetloss = 0;
430 e.ping_movementloss = 0;
431 //e.gotscores = 0; // we might already have the scores...
432 int t = entcs_GetScoreTeam(i);
433 if (t) SetTeam(e, t); // will not hurt; later updates come with Scoreboard_UpdatePlayerTeams
435 Scoreboard_UpdatePlayerPos(e);
439 this.nextthink = time + 0.2;
444 entity playerchecker = new_pure(playerchecker);
445 setthink(playerchecker, Playerchecker_Think);
446 playerchecker.nextthink = time + 0.2;
450 // this can't be called in CSQC_Init as it'd send cvars too early
451 ReplicateVars_Start();
456 void Release_Common_Keys()
459 localcmd("-fire2\n");
463 localcmd("-forward\n");
465 localcmd("-moveleft\n");
466 localcmd("-moveright\n");
469 // CSQC_InputEvent : Used to perform actions based on any key pressed, key released and mouse on the client.
470 // Return value should be 1 if CSQC handled the input, otherwise return 0 to have the input passed to the engine.
471 // All keys are in ascii.
472 // bInputType = 0 is key pressed, 1 is key released, 2 and 3 are mouse input.
473 // In the case of keyboard input, nPrimary is the ascii code, and nSecondary is 0.
474 // In the case of mouse input, nPrimary is xdelta, nSecondary is ydelta.
475 // In the case of mouse input after a setcursormode(1) call, nPrimary is xpos, nSecondary is ypos.
476 float CSQC_InputEvent(int bInputType, float nPrimary, float nSecondary)
479 bool override = false;
481 override |= HUD_Scoreboard_InputEvent(bInputType, nPrimary, nSecondary);
485 override |= HUD_Panel_InputEvent(bInputType, nPrimary, nSecondary);
489 override |= HUD_Panel_Chat_InputEvent(bInputType, nPrimary, nSecondary);
491 override |= QuickMenu_InputEvent(bInputType, nPrimary, nSecondary);
493 override |= HUD_Radar_InputEvent(bInputType, nPrimary, nSecondary);
495 override |= MapVote_InputEvent(bInputType, nPrimary, nSecondary);
497 override |= HUD_Minigame_InputEvent(bInputType, nPrimary, nSecondary);
502 if(bInputType == 3 || bInputType == 2)
505 // at this point bInputType can only be 0 or 1 (key pressed or released)
506 bool key_pressed = (bInputType == 0);
509 if(nPrimary == K_ALT) hudShiftState |= S_ALT;
510 if(nPrimary == K_CTRL) hudShiftState |= S_CTRL;
511 if(nPrimary == K_SHIFT) hudShiftState |= S_SHIFT;
512 if(nPrimary == K_TAB) hudShiftState |= S_TAB;
515 if(nPrimary == K_ALT) hudShiftState -= (hudShiftState & S_ALT);
516 if(nPrimary == K_CTRL) hudShiftState -= (hudShiftState & S_CTRL);
517 if(nPrimary == K_SHIFT) hudShiftState -= (hudShiftState & S_SHIFT);
518 if(nPrimary == K_TAB) hudShiftState -= (hudShiftState & S_TAB);
521 // NOTE: Shift-Escape must be filtered out because it's the hardcoded console shortcut
522 if (nPrimary == K_ESCAPE && !(hudShiftState & S_SHIFT) && key_pressed)
524 if (hudShiftState & S_TAB)
526 Scoreboard_UI_Enable(0);
529 if (autocvar_menu_gamemenu && !isdemo() && cvar("_menu_gamemenu_dialog_available"))
531 localcmd("\nmenu_showgamemenudialog\n");
539 // END REQUIRED CSQC FUNCTIONS
540 // --------------------------------------------------------------------------
542 // --------------------------------------------------------------------------
543 // BEGIN OPTIONAL CSQC FUNCTIONS
545 void Ent_RemovePlayerScore(entity this)
548 SetTeam(this.owner, -1);
549 this.owner.gotscores = 0;
550 FOREACH(Scores, true, {
551 this.owner.(scores(it)) = 0; // clear all scores
556 NET_HANDLE(ENT_CLIENT_SCORES, bool isnew)
561 // damnit -.- don't want to go change every single .sv_entnum in hud.qc AGAIN
562 // (no I've never heard of M-x replace-string, sed, or anything like that)
563 bool isNew = !this.owner; // workaround for DP bug
564 int n = ReadByte()-1;
566 #ifdef DP_CSQC_ENTITY_REMOVE_IS_B0RKED
567 if(!isNew && n != this.sv_entnum)
569 //print("A CSQC entity changed its owner!\n");
570 LOG_INFOF("A CSQC entity changed its owner! (edict: %d, classname: %s)", etof(this), this.classname);
578 o = playerslots[this.sv_entnum];
581 o = playerslots[this.sv_entnum] = new_pure(playerslot);
584 o.sv_entnum = this.sv_entnum;
588 // RegisterPlayer(o);
589 //playerchecker will do this for us later, if it has not already done so
591 int sf = ReadShort();
592 int lf = ReadShort();
593 FOREACH(Scores, true, {
594 int p = 1 << (i % 16);
598 o.(scores(it)) = ReadInt24_t();
600 o.(scores(it)) = ReadChar();
607 Scoreboard_UpdatePlayerPos(o); // if not registered, we cannot do this yet!
609 this.entremove = Ent_RemovePlayerScore;
612 NET_HANDLE(ENT_CLIENT_TEAMSCORES, bool isnew)
617 this.team = ReadByte();
618 entity o = this.owner = GetTeam(this.team, true); // these team numbers can always be trusted
620 #if MAX_TEAMSCORE <= 8
624 int sf = ReadShort();
625 int lf = ReadShort();
627 for(i = 0; i < MAX_TEAMSCORE; ++i)
631 o.(teamscores(i)) = ReadInt24_t();
633 o.(teamscores(i)) = ReadChar();
638 Scoreboard_UpdateTeamPos(o);
641 NET_HANDLE(ENT_CLIENT_CLIENTDATA, bool isnew)
644 float newspectatee_status;
648 scoreboard_showscores_force = (f & BIT(0));
652 newspectatee_status = ReadByte();
653 if(newspectatee_status == player_localnum + 1)
654 newspectatee_status = -1; // observing
657 newspectatee_status = 0;
659 spectatorbutton_zoom = (f & BIT(2));
660 observe_blocked = (f & BIT(3));
664 num_spectators = ReadByte();
668 for(i = 0; i < MAX_SPECTATORS; ++i)
669 spectatorlist[i] = 0; // reset list first
671 int limit = min(num_spectators, MAX_SPECTATORS);
672 for(i = 0; i < limit; ++i)
675 spectatorlist[i] = slot - 1;
680 for(int j = 0; j < MAX_SPECTATORS; ++j)
681 spectatorlist[j] = 0; // reset list if showspectators has been turned off
687 if(newspectatee_status != spectatee_status)
691 race_checkpointtime = 0;
692 hud_dynamic_shake_factor = -1;
693 spectatee_status_changed_time = time;
695 if (autocvar_hud_panel_healtharmor_progressbar_gfx)
697 if ( (spectatee_status == -1 && newspectatee_status > 0) //before observing, now spectating
698 || (spectatee_status > 0 && newspectatee_status > 0 && spectatee_status != newspectatee_status) //changed spectated player
701 else if(spectatee_status && !newspectatee_status) //before observing/spectating, now playing
704 spectatee_status = newspectatee_status;
706 // we could get rid of spectatee_status, and derive it from player_localentnum and player_localnum
709 NET_HANDLE(ENT_CLIENT_NAGGER, bool isnew)
714 int nags = ReadByte(); // NAGS NAGS NAGS NAGS NAGS NAGS NADZ NAGS NAGS NAGS
718 strfree(vote_called_vote);
728 vote_yescount = ReadByte();
729 vote_nocount = ReadByte();
730 vote_needed = ReadByte();
731 vote_highlighted = ReadChar();
736 strcpy(vote_called_vote, ReadString());
741 for(j = 0; j < maxclients; ++j)
743 playerslots[j].ready = true;
744 for(i = 1; i <= maxclients; i += 8)
747 for(j = i-1, b = BIT(0); b < BIT(8); b <<= 1, ++j)
750 playerslots[j].ready = false;
756 ready_waiting = (nags & BIT(0));
757 ready_waiting_for_me = (nags & BIT(1));
758 vote_waiting = (nags & BIT(2));
759 vote_waiting_for_me = (nags & BIT(3));
760 warmup_stage = (nags & BIT(4));
763 NET_HANDLE(ENT_CLIENT_ELIMINATEDPLAYERS, bool isnew)
767 serialize(byte, 0, sf);
769 for (int j = 0; j < maxclients; ++j) {
770 if (playerslots[j]) {
771 playerslots[j].eliminated = true;
774 for (int i = 1; i <= maxclients; i += 8) {
776 serialize(byte, 0, f);
777 for (int b = 0; b < 8; ++b) {
778 if (f & BIT(b)) continue;
780 if (playerslots[j]) {
781 playerslots[j].eliminated = false;
789 NET_HANDLE(ENT_CLIENT_RANDOMSEED, bool isnew)
793 float s = ReadShort();
798 NET_HANDLE(ENT_CLIENT_ACCURACY, bool isnew)
801 int sf = ReadInt24_t();
803 for (int w = 0; w <= WEP_LAST - WEP_FIRST; ++w)
804 weapon_accuracy[w] = -1;
809 for (int w = 0; w <= WEP_LAST - WEP_FIRST; ++w) {
813 weapon_accuracy[w] = -1;
815 weapon_accuracy[w] = 1.0; // no better error handling yet, sorry
817 weapon_accuracy[w] = (b - 1.0) / 100.0;
819 f = (f == 0x800000) ? 1 : f * 2;
824 void Spawn_Draw(entity this)
826 bool dodraw = autocvar_cl_spawn_point_particles;
827 if(dodraw && autocvar_cl_spawn_point_dist_max)
829 vector org = getpropertyvec(VF_ORIGIN);
830 dodraw = vdist(org - this.origin, <, autocvar_cl_spawn_point_dist_max);
834 pointparticles(((!teamplay) ? EFFECT_SPAWNPOINT_NEUTRAL : EFFECT_SPAWNPOINT(this.team - 1)), this.origin + '0 0 28', '0 0 2', bound(0, frametime, 0.1));
837 NET_HANDLE(ENT_CLIENT_SPAWNPOINT, bool is_new)
839 float teamnum = (ReadByte() - 1);
840 vector spn_origin = ReadVector();
842 this.team = (teamnum + 1);
846 this.origin = spn_origin;
847 setsize(this, PL_MIN_CONST, PL_MAX_CONST);
850 /*if(autocvar_cl_spawn_point_model) // needs a model first
852 this.mdl = "models/spawnpoint.md3";
853 this.colormod = Team_ColorRGB(teamnum);
854 precache_model(this.mdl);
855 setmodel(this, this.mdl);
856 this.drawmask = MASK_NORMAL;
857 //this.move_movetype = MOVETYPE_NOCLIP;
858 //this.draw = Spawn_Draw;
859 IL_PUSH(g_drawables, this);
861 this.draw = Spawn_Draw;
862 if (is_new) IL_PUSH(g_drawables, this);
865 //printf("Ent_ReadSpawnPoint(is_new = %d); origin = %s, team = %d, effect = %d\n", is_new, vtos(this.origin), teamnum, this.cnt);
869 NET_HANDLE(ENT_CLIENT_SPAWNEVENT, bool is_new)
871 // If entnum is 0, ONLY do the local spawn actions
872 // this way the server can disable the sending of
873 // spawn origin or such to clients if wanted.
874 float entnum = ReadByte();
878 this.origin = ReadVector();
882 float teamnum = entcs_GetTeam(entnum - 1);
884 if(autocvar_cl_spawn_event_particles)
888 case NUM_TEAM_1: pointparticles(EFFECT_SPAWN_RED, this.origin, '0 0 0', 1); break;
889 case NUM_TEAM_2: pointparticles(EFFECT_SPAWN_BLUE, this.origin, '0 0 0', 1); break;
890 case NUM_TEAM_3: pointparticles(EFFECT_SPAWN_YELLOW, this.origin, '0 0 0', 1); break;
891 case NUM_TEAM_4: pointparticles(EFFECT_SPAWN_PINK, this.origin, '0 0 0', 1); break;
892 default: pointparticles(EFFECT_SPAWN_NEUTRAL, this.origin, '0 0 0', 1); break;
895 if(autocvar_cl_spawn_event_sound)
897 sound(this, CH_TRIGGER, SND_SPAWN, VOL_BASE, ATTEN_NORM);
903 // local spawn actions
904 if(is_new && (!entnum || (entnum == player_localentnum)))
906 if(autocvar_cl_spawnzoom && !autocvar_cl_lockview)
909 current_viewzoom = (1 / bound(1, autocvar_cl_spawnzoom_factor, 16));
912 if(autocvar_cl_unpress_zoom_on_spawn)
917 HUD_Radar_Hide_Maximized();
919 //printf("Ent_ReadSpawnEvent(is_new = %d); origin = %s, entnum = %d, localentnum = %d\n", is_new, vtos(this.origin), entnum, player_localentnum);
922 // CSQC_Ent_Update : Called every frame that the server has indicated an update to the SSQC / CSQC entity has occured.
923 // The parameter isnew reflects if the entity is "new" to the client, meaning it just came into the client's PVS.
924 void CSQC_Ent_Update(entity this, bool isnew)
926 this.sourceLoc = __FILE__":"STR(__LINE__);
929 // set up the "time" global for received entities to be correct for interpolation purposes
930 float savetime = time;
937 serverprevtime = time;
938 serverdeltatime = STAT(MOVEVARS_TICRATE) * STAT(MOVEVARS_TIMESCALE);
939 time = serverprevtime + serverdeltatime;
942 #ifdef DP_CSQC_ENTITY_REMOVE_IS_B0RKED
945 if (t != this.enttype || isnew)
947 LOG_INFOF("A CSQC entity changed its type! (edict: %d, server: %d, type: %d -> %d)", etof(this), this.entnum, this.enttype, t);
958 LOG_INFOF("A CSQC entity appeared out of nowhere! (edict: %d, server: %d, type: %d)", etof(this), this.entnum, t);
965 FOREACH(LinkedEntities, it.m_id == t, {
966 if (isnew) this.classname = it.netname;
967 if (autocvar_developer_csqcentities)
968 LOG_INFOF("CSQC_Ent_Update(%i, %d) at %f {.entnum=%d, .enttype=%d} t=%s (%d)", this, isnew, savetime, this.entnum, this.enttype, this.classname, t);
969 done = it.m_read(this, NULL, isnew);
970 MUTATOR_CALLHOOK(Ent_Update, this, isnew);
976 LOG_FATALF("CSQC_Ent_Update(%i, %d) at %f {.entnum=%d, .enttype=%d} t=%s (%d)", this, isnew, savetime, this.entnum, this.enttype, this.classname, t);
980 // Destructor, but does NOT deallocate the entity by calling remove(). Also
981 // used when an entity changes its type. For an entity that someone interacts
982 // with others, make sure it can no longer do so.
983 void Ent_Remove(entity this)
985 if(this.entremove) this.entremove(this);
987 if(this.skeletonindex)
989 skel_delete(this.skeletonindex);
990 this.skeletonindex = 0;
993 if(this.snd_looping > 0)
995 sound(this, this.snd_looping, SND_Null, VOL_BASE, autocvar_cl_jetpack_attenuation);
996 this.snd_looping = 0;
1000 this.classname = "";
1001 this.draw = func_null;
1002 this.entremove = func_null;
1003 // TODO possibly set more stuff to defaults
1005 // CSQC_Ent_Remove : Called when the server requests a SSQC / CSQC entity to be removed. Essentially call remove(this) as well.
1006 void CSQC_Ent_Remove(entity this)
1008 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Ent_Remove() with this=%i {.entnum=%d, .enttype=%d}", this, this.entnum, this.enttype);
1011 LOG_WARN("CSQC_Ent_Remove called for already removed entity. Packet loss?");
1014 if (this.enttype) Ent_Remove(this);
1018 void Gamemode_Init()
1022 if(!(calledhooks & HOOK_START))
1023 localcmd("\n_cl_hook_gamestart ", MapInfo_Type_ToString(gametype), "\n");
1024 calledhooks |= HOOK_START;
1027 // 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.
1028 void CSQC_Parse_StuffCmd(string strMessage)
1030 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_StuffCmd(\"%s\")", strMessage);
1031 localcmd(strMessage);
1033 // 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.
1034 void CSQC_Parse_Print(string strMessage)
1036 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_Print(\"%s\")", strMessage);
1037 print(ColorTranslateRGB(strMessage));
1040 // CSQC_Parse_CenterPrint : Provides the centerprint_AddStandard string in the first parameter that the server provided.
1041 void CSQC_Parse_CenterPrint(string strMessage)
1043 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_CenterPrint(\"%s\")", strMessage);
1044 centerprint_AddStandard(strMessage);
1047 // CSQC_Parse_TempEntity : Handles all temporary entity network data in the CSQC layer.
1048 // You must ALWAYS first acquire the temporary ID, which is sent as a byte.
1049 // Return value should be 1 if CSQC handled the temporary entity, otherwise return 0 to have the engine process the event.
1050 bool CSQC_Parse_TempEntity()
1053 int nTEID = ReadByte();
1055 FOREACH(TempEntities, it.m_id == nTEID, {
1056 if (autocvar_developer_csqcentities)
1057 LOG_INFOF("CSQC_Parse_TempEntity() nTEID=%s (%d)", it.netname, nTEID);
1058 return it.m_read(NULL, NULL, true);
1061 if (autocvar_developer_csqcentities)
1062 LOG_INFOF("CSQC_Parse_TempEntity() with nTEID=%d", nTEID);
1064 // No special logic for this temporary entity; return 0 so the engine can handle it
1071 if (autocvar_cl_orthoview && autocvar_cl_orthoview_nofog)
1072 localcmd("\nr_drawfog 0\n");
1073 else if (forcefog != "")
1074 localcmd(sprintf("\nfog %s\nr_fog_exp2 0\nr_drawfog 1\n", forcefog));
1077 bool net_handle_ServerWelcome();
1078 NET_HANDLE(ENT_CLIENT_SCORES_INFO, bool isnew)
1081 gametype = ReadRegistered(Gametypes);
1082 teamplay = _MapInfo_GetTeamPlayBool(gametype);
1083 HUD_ModIcons_SetFunc();
1084 FOREACH(Scores, true, {
1085 strcpy(scores_label(it), ReadString());
1086 scores_flags(it) = ReadByte();
1088 for (int i = 0; i < MAX_TEAMSCORE; ++i)
1090 strcpy(teamscores_label(i), ReadString());
1091 teamscores_flags(i) = ReadByte();
1093 bool welcome_msg_too = ReadByte();
1094 if (welcome_msg_too)
1095 net_handle_ServerWelcome();
1097 Scoreboard_InitScores();
1101 NET_HANDLE(ENT_CLIENT_INIT, bool isnew)
1103 nb_pb_period = ReadByte() / 32; //Accuracy of 1/32th
1105 hook_shotorigin[0] = decompressShotOrigin(ReadInt24_t());
1106 hook_shotorigin[1] = decompressShotOrigin(ReadInt24_t());
1107 hook_shotorigin[2] = decompressShotOrigin(ReadInt24_t());
1108 hook_shotorigin[3] = decompressShotOrigin(ReadInt24_t());
1109 arc_shotorigin[0] = decompressShotOrigin(ReadInt24_t());
1110 arc_shotorigin[1] = decompressShotOrigin(ReadInt24_t());
1111 arc_shotorigin[2] = decompressShotOrigin(ReadInt24_t());
1112 arc_shotorigin[3] = decompressShotOrigin(ReadInt24_t());
1114 strcpy(forcefog, ReadString());
1116 armorblockpercent = ReadByte() / 255.0;
1117 damagepush_speedfactor = ReadByte() / 255.0;
1119 serverflags = ReadByte();
1121 g_trueaim_minrange = ReadCoord();
1125 MUTATOR_CALLHOOK(Ent_Init);
1127 if (!postinit) PostInit();
1130 float GetSpeedUnitFactor(int speed_unit)
1136 case 2: return 0.0254;
1137 case 3: return 0.0254 * 3.6;
1138 case 4: return 0.0254 * 3.6 * 0.6213711922;
1139 case 5: return 0.0254 * 1.943844492; // 1 m/s = 1.943844492 knots, because 1 knot = 1.852 km/h
1143 string GetSpeedUnit(int speed_unit)
1147 // translator-friendly strings without the initial space
1149 case 1: return strcat(" ", _("qu/s"));
1150 case 2: return strcat(" ", _("m/s"));
1151 case 3: return strcat(" ", _("km/h"));
1152 case 4: return strcat(" ", _("mph"));
1153 case 5: return strcat(" ", _("knots"));
1157 NET_HANDLE(TE_CSQC_RACE, bool isNew)
1163 case RACE_NET_CHECKPOINT_HIT_QUALIFYING:
1164 race_checkpoint = ReadByte();
1165 race_time = ReadInt24_t();
1166 race_previousbesttime = ReadInt24_t();
1167 race_mypreviousbesttime = ReadInt24_t();
1168 string pbestname = ReadString();
1169 if(autocvar_cl_race_cptimes_onlyself)
1171 race_previousbesttime = race_mypreviousbesttime;
1172 race_mypreviousbesttime = 0;
1173 strcpy(race_previousbestname, "");
1176 strcpy(race_previousbestname, pbestname);
1178 race_checkpointtime = time;
1180 if(race_checkpoint == 0 || race_checkpoint == 254)
1182 race_penaltyaccumulator = 0;
1183 race_laptime = time; // valid
1187 case RACE_NET_CHECKPOINT_CLEAR:
1189 race_checkpointtime = 0;
1192 case RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING:
1193 race_laptime = ReadCoord();
1194 race_checkpointtime = -99999;
1196 case RACE_NET_CHECKPOINT_NEXT_QUALIFYING:
1197 race_nextcheckpoint = ReadByte();
1199 race_nextbesttime = ReadInt24_t();
1200 if(b != RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING) // not while spectating (matches server)
1201 race_mybesttime = ReadInt24_t();
1202 string newname = ReadString();
1203 if(autocvar_cl_race_cptimes_onlyself && b != RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING)
1205 race_nextbesttime = race_mybesttime;
1206 race_mybesttime = 0;
1207 strcpy(race_nextbestname, "");
1210 strcpy(race_nextbestname, newname);
1213 case RACE_NET_CHECKPOINT_HIT_RACE:
1214 race_mycheckpoint = ReadByte();
1215 race_mycheckpointtime = time;
1216 race_mycheckpointdelta = ReadInt24_t();
1217 race_mycheckpointlapsdelta = ReadByte();
1218 if(race_mycheckpointlapsdelta >= 128)
1219 race_mycheckpointlapsdelta -= 256;
1220 int who = ReadByte();
1222 strcpy(race_mycheckpointenemy, entcs_GetName(who - 1));
1224 strcpy(race_mycheckpointenemy, ""); // TODO: maybe string_null works fine here?
1227 case RACE_NET_CHECKPOINT_HIT_RACE_BY_OPPONENT:
1228 race_othercheckpoint = ReadByte();
1229 race_othercheckpointtime = time;
1230 race_othercheckpointdelta = ReadInt24_t();
1231 race_othercheckpointlapsdelta = ReadByte();
1232 if(race_othercheckpointlapsdelta >= 128)
1233 race_othercheckpointlapsdelta -= 256;
1234 int what = ReadByte();
1236 strcpy(race_othercheckpointenemy, entcs_GetName(what - 1));
1238 strcpy(race_othercheckpointenemy, ""); // TODO: maybe string_null works fine here?
1241 case RACE_NET_PENALTY_RACE:
1242 case RACE_NET_PENALTY_QUALIFYING:
1243 race_penaltyeventtime = time;
1244 race_penaltytime = ReadShort();
1245 string reason = ReadString();
1246 if (reason == "missing a checkpoint")
1247 reason = _("missing a checkpoint");
1248 strcpy(race_penaltyreason, reason);
1249 if (b == RACE_NET_PENALTY_QUALIFYING)
1250 race_penaltyaccumulator += race_penaltytime;
1253 case RACE_NET_SERVER_RECORD:
1254 race_server_record = ReadInt24_t();
1256 case RACE_NET_SPEED_AWARD:
1257 race_speedaward = ReadInt24_t() * GetSpeedUnitFactor(autocvar_hud_panel_physics_speed_unit);
1258 strcpy(race_speedaward_holder, ReadString());
1260 case RACE_NET_SPEED_AWARD_BEST:
1261 race_speedaward_alltimebest = ReadInt24_t() * GetSpeedUnitFactor(autocvar_hud_panel_physics_speed_unit);
1262 strcpy(race_speedaward_alltimebest_holder, ReadString());
1264 case RACE_NET_RANKINGS_CNT:
1265 RANKINGS_DISPLAY_CNT = ReadByte();
1267 case RACE_NET_SERVER_RANKINGS:
1269 int pos = ReadShort();
1270 prevpos = ReadShort();
1273 // move other rankings out of the way
1276 int m = min(prevpos, RANKINGS_DISPLAY_CNT);
1277 for (i=m-1; i>pos-1; --i) {
1278 grecordtime[i] = grecordtime[i-1];
1279 strcpy(grecordholder[i], grecordholder[i-1]);
1281 } else if (del) { // a record has been deleted by the admin
1282 for (i=pos-1; i<= RANKINGS_DISPLAY_CNT-1; ++i) {
1283 if (i == RANKINGS_DISPLAY_CNT-1) { // clear out last record
1285 strfree(grecordholder[i]);
1288 grecordtime[i] = grecordtime[i+1];
1289 strcpy(grecordholder[i], grecordholder[i+1]);
1292 } else { // player has no ranked record yet
1293 for (i=RANKINGS_DISPLAY_CNT-1;i>pos-1;--i) {
1294 grecordtime[i] = grecordtime[i-1];
1295 strcpy(grecordholder[i], grecordholder[i-1]);
1299 if (grecordtime[RANKINGS_DISPLAY_CNT]) {
1300 // kick off the player who fell from the last displayed position
1301 grecordtime[RANKINGS_DISPLAY_CNT] = 0;
1302 strfree(grecordholder[RANKINGS_DISPLAY_CNT]);
1305 // store new ranking
1306 strcpy(grecordholder[pos-1], ReadString());
1307 grecordtime[pos-1] = ReadInt24_t();
1308 if(strdecolorize(grecordholder[pos-1]) == strdecolorize(entcs_GetName(player_localnum)))
1311 case RACE_NET_SERVER_STATUS:
1312 race_status = ReadShort();
1313 strcpy(race_status_name, ReadString());
1318 NET_HANDLE(TE_CSQC_TEAMNAGGER, bool isNew)
1324 NET_HANDLE(TE_CSQC_PINGPLREPORT, bool isNew)
1327 int pi = ReadShort();
1328 int pl = ReadByte();
1329 int ml = ReadByte();
1331 entity e = playerslots[i];
1334 e.ping_packetloss = pl / 255.0;
1335 e.ping_movementloss = ml / 255.0;
1338 NET_HANDLE(TE_CSQC_WEAPONCOMPLAIN, bool isNew)
1340 int weapon_id = ReadByte();
1341 complain_weapon = REGISTRY_GET(Weapons, weapon_id);
1342 complain_weapon_type = ReadByte();
1345 complain_weapon_time = time;
1346 weapontime = time; // ping the weapon panel
1348 switch(complain_weapon_type)
1350 case 0: Local_Notification(MSG_MULTI, ITEM_WEAPON_NOAMMO, weapon_id); break;
1351 case 1: Local_Notification(MSG_MULTI, ITEM_WEAPON_DONTHAVE, weapon_id); break;
1352 default: Local_Notification(MSG_MULTI, ITEM_WEAPON_UNAVAILABLE, weapon_id); break;
1356 string translate_modifications(string s)
1358 return build_mutator_list(s);
1361 string translate_weaponarena(string s)
1363 if (s == "") return s;
1364 if (s == "All Weapons Arena") return _("All Weapons Arena");
1365 if (s == "All Available Weapons Arena") return _("All Available Weapons Arena");
1366 if (s == "Most Weapons Arena") return _("Most Weapons Arena");
1367 if (s == "Most Available Weapons Arena") return _("Most Available Weapons Arena");
1368 if (s == "Dev All Weapons Arena") return s; // development option, do not translate
1369 if (s == "Dev All Available Weapons Arena") return s; // development option, do not translate
1370 if (s == "No Weapons Arena") return _("No Weapons Arena");
1372 int n = tokenizebyseparator(s, " & ");
1373 string wpn_list = "";
1374 for (int i = 0; i < n; i++)
1376 Weapon wep = Weapon_from_name(argv(i));
1377 if (wep == WEP_Null)
1378 LOG_INFO("^3Warning: ^7server sent an invalid weapon name\n");
1379 wpn_list = cons_mid(wpn_list, " & ", wep.m_name);
1382 return sprintf(_("%s Arena"), wpn_list);
1384 return _("No Weapons Arena");
1387 string GetVersionMessage(string hostversion, bool version_mismatch, bool version_check)
1389 string xonotic_hostversion = strcat("Xonotic ", hostversion);
1390 if (version_mismatch)
1393 return strcat(sprintf(_("This is %s"), xonotic_hostversion), "\n^3",
1394 _("Your client version is outdated."), "\n\n\n",
1395 _("### YOU WON'T BE ABLE TO PLAY ON THIS SERVER ###"), "\n\n\n",
1396 _("Please update!"));
1398 return strcat(sprintf(_("This is %s"), xonotic_hostversion), "\n^3",
1399 _("This server is using an outdated Xonotic version."), "\n\n\n",
1400 _("### THIS SERVER IS INCOMPATIBLE AND THUS YOU CANNOT JOIN ###"));
1402 return sprintf(_("Welcome to %s"), xonotic_hostversion);
1405 bool net_handle_ServerWelcome()
1407 campaign = ReadByte();
1410 string campaign_title = ReadString();
1411 int campaign_level = ReadByte();
1412 string campaign_msg = ReadString();
1413 string welcomedialog_args;
1414 welcomedialog_args = strcat("HOSTNAME \"", campaign_title, "\"");
1415 string key = getcommandkey(_("jump"), "+jump");
1416 string msg = strcat(
1417 CCR("^F1"), sprintf(_("Level %d:"), campaign_level),
1418 sprintf(CCR(" ^BG%s\n^3\n"), campaign_msg),
1419 sprintf(CCR(_("^BGPress ^F2%s^BG to enter the game")), key));
1420 msg = MakeConsoleSafe(strreplace("\n", "\\n", msg));
1421 welcomedialog_args = strcat(welcomedialog_args, " WELCOME \"", msg, "\"");
1422 localcmd("\nmenu_cmd directmenu Welcome ", welcomedialog_args, "\n");
1426 strcpy(hostname, ReadString());
1427 string hostversion = ReadString();
1428 bool version_mismatch = ReadByte();
1429 bool version_check = ReadByte();
1430 srv_minplayers = ReadByte();
1431 srv_maxplayers = ReadByte();
1432 string modifications = translate_modifications(ReadString());
1433 string weaponarena_list = translate_weaponarena(ReadString());
1434 string cache_mutatormsg = ReadString();
1435 string motd = ReadString();
1437 string msg = GetVersionMessage(hostversion, version_mismatch, version_check);
1439 msg = strcat(msg, "\n\n", _("Gametype:"), " ^1", MapInfo_Type_ToText(gametype), "\n");
1441 msg = strcat(msg, "\n", _("Map:"), " ^2");
1442 if (world.message == "")
1443 msg = strcat(msg, mi_shortname, "\n");
1446 int i = strstrofs(world.message, " by ", 0); // matches _MapInfo_Generate()
1447 string longname = i >= 0 ? substring(world.message, 0, i) : world.message;
1448 msg = strcat(msg, (strcasecmp(longname, mi_shortname) ? strcat(mi_shortname, " ^7// ^2") : ""), longname, "\n");
1451 if (srv_minplayers || srv_maxplayers)
1453 msg = strcat(msg, "\n", _("This match supports"), " ^5");
1454 if (srv_minplayers == srv_maxplayers)
1455 msg = strcat(msg, sprintf(_("%d players"), srv_maxplayers), "\n");
1456 else if (srv_minplayers && srv_maxplayers)
1457 msg = strcat(msg, sprintf(_("%d to %d players"), srv_minplayers, srv_maxplayers), "\n");
1458 else if (srv_maxplayers)
1459 msg = strcat(msg, sprintf(_("%d players maximum"), srv_maxplayers), "\n");
1461 msg = strcat(msg, sprintf(_("%d players minimum"), srv_minplayers), "\n");
1464 modifications = cons_mid(modifications, ", ", weaponarena_list);
1465 if(modifications != "")
1466 msg = strcat(msg, "\n", _("Active modifications:"), " ^3", modifications, "\n");
1468 if (cache_mutatormsg != "")
1469 msg = strcat(msg, "\n", _("Special gameplay tips:"), " ^7", cache_mutatormsg, "\n");
1470 string mutator_msg = "";
1471 MUTATOR_CALLHOOK(BuildGameplayTipsString, mutator_msg);
1472 mutator_msg = M_ARGV(0, string);
1473 msg = strcat(msg, mutator_msg); // trust that the mutator will do proper formatting
1476 msg = strcat(msg, "\n^9↓ ", _("Server's message"), " ↓\n", motd);
1478 strcpy(welcome_msg, msg);
1479 welcome_msg_menu_check_maxtime = time + 1; // wait for menu to load before showing the welcome dialog
1483 void Welcome_Message_Show_Try()
1485 if (!welcome_msg_menu_check_maxtime)
1488 // if want dialog check if menu is initialized but for a short time
1489 if (cvar("_menu_initialized") == 2 || time > welcome_msg_menu_check_maxtime)
1491 if (cvar("_menu_welcome_dialog_available"))
1493 string welcomedialog_args = strcat("HOSTNAME \"", hostname, "\"");
1494 string msg = MakeConsoleSafe(strreplace("\n", "\\n", welcome_msg));
1495 welcomedialog_args = strcat(welcomedialog_args, " WELCOME \"", msg, "\"");
1497 if (intermission || isdemo() || !autocvar_cl_welcome)
1499 if (cvar("_menu_cmd_closemenu_available"))
1501 // initialize the dialog without opening it
1502 localcmd("\nmenu_cmd closemenu Welcome ", welcomedialog_args, "\n");
1506 // legacy code for clients with old menus
1507 // since togglemenu 0 doesn't close the dialog but only hides it,
1508 // playing back a demo the Welcome dialog will pop up on the first ESC press
1509 localcmd("\nmenu_cmd directmenu Welcome ", welcomedialog_args, "\n");
1510 // close it after it's been initialized so it can still be opened manually
1511 localcmd("\ntogglemenu 0\n");
1515 localcmd("\nmenu_cmd directmenu Welcome ", welcomedialog_args, "\n");
1518 strfree(welcome_msg);
1519 welcome_msg_menu_check_maxtime = 0;
1523 NET_HANDLE(TE_CSQC_SERVERWELCOME, bool isNew)
1525 return net_handle_ServerWelcome();
1528 string _getcommandkey(string cmd_name, string command, bool forcename)
1531 float n, j, k, l = 0;
1533 if (!autocvar_hud_showbinds)
1536 keys = db_get(binddb, command);
1539 bool joy_active = cvar("joy_active");
1540 n = tokenize(findkeysforcommand(command, 0)); // uses '...' strings
1541 for(j = 0; j < n; ++j)
1546 string key = keynumtostring(k);
1547 if(!joy_active && substring(key, 0, 3) == "JOY")
1550 key = translate_key(key);
1555 keys = strcat(keys, ", ", key);
1558 if (autocvar_hud_showbinds_limit > 0 && autocvar_hud_showbinds_limit <= l)
1565 db_put(binddb, command, keys);
1568 if (keys == "NO_KEY") {
1569 if (autocvar_hud_showbinds > 1)
1570 return sprintf(_("%s (not bound)"), cmd_name);
1574 else if (autocvar_hud_showbinds > 1 || forcename)
1575 return sprintf("%s (%s)", cmd_name, keys);
1580 /** engine callback */
1581 void URI_Get_Callback(int id, int status, string data)
1583 TC(int, id); TC(int, status);
1584 if(url_URI_Get_Callback(id, status, data))
1588 else if (id == URI_GET_DISCARD)
1592 else if (id >= URI_GET_CURL && id <= URI_GET_CURL_END)
1595 Curl_URI_Get_Callback(id, status, data);
1599 LOG_INFOF("Received HTTP request data for an invalid id %d.", id);