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
544 .int survival_status;
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
553 this.owner.colormap = 0;
554 // TODO add a hook to reset this Survival field
555 this.owner.survival_status = 0;
559 NET_HANDLE(ENT_CLIENT_SCORES, bool isnew)
564 // damnit -.- don't want to go change every single .sv_entnum in hud.qc AGAIN
565 // (no I've never heard of M-x replace-string, sed, or anything like that)
566 bool isNew = !this.owner; // workaround for DP bug
567 int n = ReadByte()-1;
569 #ifdef DP_CSQC_ENTITY_REMOVE_IS_B0RKED
570 if(!isNew && n != this.sv_entnum)
572 //print("A CSQC entity changed its owner!\n");
573 LOG_INFOF("A CSQC entity changed its owner! (edict: %d, classname: %s)", etof(this), this.classname);
581 o = playerslots[this.sv_entnum];
584 o = playerslots[this.sv_entnum] = new_pure(playerslot);
587 o.sv_entnum = this.sv_entnum;
591 // RegisterPlayer(o);
592 //playerchecker will do this for us later, if it has not already done so
594 int sf = ReadShort();
595 int lf = ReadShort();
596 FOREACH(Scores, true, {
597 int p = 1 << (i % 16);
601 o.(scores(it)) = ReadInt24_t();
603 o.(scores(it)) = ReadChar();
610 Scoreboard_UpdatePlayerPos(o); // if not registered, we cannot do this yet!
612 this.entremove = Ent_RemovePlayerScore;
615 NET_HANDLE(ENT_CLIENT_TEAMSCORES, bool isnew)
620 this.team = ReadByte();
621 entity o = this.owner = GetTeam(this.team, true); // these team numbers can always be trusted
623 #if MAX_TEAMSCORE <= 8
627 int sf = ReadShort();
628 int lf = ReadShort();
630 for(i = 0; i < MAX_TEAMSCORE; ++i)
634 o.(teamscores(i)) = ReadInt24_t();
636 o.(teamscores(i)) = ReadChar();
641 Scoreboard_UpdateTeamPos(o);
644 NET_HANDLE(ENT_CLIENT_CLIENTDATA, bool isnew)
647 float newspectatee_status;
651 scoreboard_showscores_force = (f & BIT(0));
655 newspectatee_status = ReadByte();
656 if(newspectatee_status == player_localnum + 1)
657 newspectatee_status = -1; // observing
660 newspectatee_status = 0;
662 spectatorbutton_zoom = (f & BIT(2));
663 observe_blocked = (f & BIT(3));
667 num_spectators = ReadByte();
671 for(i = 0; i < MAX_SPECTATORS; ++i)
672 spectatorlist[i] = 0; // reset list first
674 int limit = min(num_spectators, MAX_SPECTATORS);
675 for(i = 0; i < limit; ++i)
678 spectatorlist[i] = slot - 1;
683 for(int j = 0; j < MAX_SPECTATORS; ++j)
684 spectatorlist[j] = 0; // reset list if showspectators has been turned off
690 if(newspectatee_status != spectatee_status)
694 race_checkpointtime = 0;
695 hud_dynamic_shake_factor = -1;
696 spectatee_status_changed_time = time;
698 if (autocvar_hud_panel_healtharmor_progressbar_gfx)
700 if ( (spectatee_status == -1 && newspectatee_status > 0) //before observing, now spectating
701 || (spectatee_status > 0 && newspectatee_status > 0 && spectatee_status != newspectatee_status) //changed spectated player
704 else if(spectatee_status && !newspectatee_status) //before observing/spectating, now playing
707 spectatee_status = newspectatee_status;
709 // we could get rid of spectatee_status, and derive it from player_localentnum and player_localnum
712 NET_HANDLE(ENT_CLIENT_NAGGER, bool isnew)
716 int nags = ReadByte(); // NAGS NAGS NAGS NAGS NAGS NAGS NADZ NAGS NAGS NAGS
720 strfree(vote_called_vote);
730 vote_yescount = ReadByte();
731 vote_nocount = ReadByte();
732 vote_needed = ReadByte();
733 vote_highlighted = ReadChar();
738 strcpy(vote_called_vote, ReadString());
742 for(int i = 0; i < maxclients;)
743 for(int f = ReadByte(), b = 0; b < 8 && i < maxclients; ++b, ++i)
745 playerslots[i].ready = f & BIT(b);
749 ready_waiting = (nags & BIT(0));
750 ready_waiting_for_me = (nags & BIT(1));
751 vote_waiting = (nags & BIT(2));
752 vote_waiting_for_me = (nags & BIT(3));
753 warmup_stage = (nags & BIT(4));
756 NET_HANDLE(ENT_CLIENT_ELIMINATEDPLAYERS, bool isnew)
760 serialize(byte, 0, sf);
762 for (int j = 0; j < maxclients; ++j) {
763 if (playerslots[j]) {
764 playerslots[j].eliminated = true;
767 for (int i = 1; i <= maxclients; i += 8) {
769 serialize(byte, 0, f);
770 for (int b = 0; b < 8; ++b) {
771 if (f & BIT(b)) continue;
773 if (playerslots[j]) {
774 playerslots[j].eliminated = false;
782 NET_HANDLE(ENT_CLIENT_RANDOMSEED, bool isnew)
786 float s = ReadShort();
791 NET_HANDLE(ENT_CLIENT_ACCURACY, bool isnew)
794 int sf = ReadInt24_t();
796 for (int w = 0; w <= WEP_LAST - WEP_FIRST; ++w)
797 weapon_accuracy[w] = -1;
802 for (int w = 0; w <= WEP_LAST - WEP_FIRST; ++w) {
806 weapon_accuracy[w] = -1;
808 weapon_accuracy[w] = 1.0; // no better error handling yet, sorry
810 weapon_accuracy[w] = (b - 1.0) / 100.0;
812 f = (f == 0x800000) ? 1 : f * 2;
817 void Spawn_Draw(entity this)
819 bool dodraw = autocvar_cl_spawn_point_particles;
820 if(dodraw && autocvar_cl_spawn_point_dist_max)
822 vector org = getpropertyvec(VF_ORIGIN);
823 dodraw = vdist(org - this.origin, <, autocvar_cl_spawn_point_dist_max);
827 pointparticles(((!teamplay) ? EFFECT_SPAWNPOINT_NEUTRAL : EFFECT_SPAWNPOINT(this.team - 1)), this.origin + '0 0 28', '0 0 2', bound(0, frametime, 0.1));
830 NET_HANDLE(ENT_CLIENT_SPAWNPOINT, bool is_new)
832 float teamnum = (ReadByte() - 1);
833 vector spn_origin = ReadVector();
835 this.team = (teamnum + 1);
839 this.origin = spn_origin;
840 setsize(this, PL_MIN_CONST, PL_MAX_CONST);
843 /*if(autocvar_cl_spawn_point_model) // needs a model first
845 this.mdl = "models/spawnpoint.md3";
846 this.colormod = Team_ColorRGB(teamnum);
847 precache_model(this.mdl);
848 setmodel(this, this.mdl);
849 this.drawmask = MASK_NORMAL;
850 //this.move_movetype = MOVETYPE_NOCLIP;
851 //this.draw = Spawn_Draw;
852 IL_PUSH(g_drawables, this);
854 this.draw = Spawn_Draw;
855 if (is_new) IL_PUSH(g_drawables, this);
858 //printf("Ent_ReadSpawnPoint(is_new = %d); origin = %s, team = %d, effect = %d\n", is_new, vtos(this.origin), teamnum, this.cnt);
862 NET_HANDLE(ENT_CLIENT_SPAWNEVENT, bool is_new)
864 // If entnum is 0, ONLY do the local spawn actions
865 // this way the server can disable the sending of
866 // spawn origin or such to clients if wanted.
867 float entnum = ReadByte();
871 this.origin = ReadVector();
875 float teamnum = entcs_GetTeam(entnum - 1);
877 if(autocvar_cl_spawn_event_particles)
881 case NUM_TEAM_1: pointparticles(EFFECT_SPAWN_RED, this.origin, '0 0 0', 1); break;
882 case NUM_TEAM_2: pointparticles(EFFECT_SPAWN_BLUE, this.origin, '0 0 0', 1); break;
883 case NUM_TEAM_3: pointparticles(EFFECT_SPAWN_YELLOW, this.origin, '0 0 0', 1); break;
884 case NUM_TEAM_4: pointparticles(EFFECT_SPAWN_PINK, this.origin, '0 0 0', 1); break;
885 default: pointparticles(EFFECT_SPAWN_NEUTRAL, this.origin, '0 0 0', 1); break;
888 if(autocvar_cl_spawn_event_sound)
890 sound(this, CH_TRIGGER, SND_SPAWN, VOL_BASE, ATTEN_NORM);
896 // local spawn actions
897 if(is_new && (!entnum || (entnum == player_localentnum)))
899 if(autocvar_cl_spawnzoom && !autocvar_cl_lockview)
902 current_viewzoom = (1 / bound(1, autocvar_cl_spawnzoom_factor, 16));
905 if(autocvar_cl_unpress_zoom_on_spawn)
910 HUD_Radar_Hide_Maximized();
912 //printf("Ent_ReadSpawnEvent(is_new = %d); origin = %s, entnum = %d, localentnum = %d\n", is_new, vtos(this.origin), entnum, player_localentnum);
915 // CSQC_Ent_Update : Called every frame that the server has indicated an update to the SSQC / CSQC entity has occured.
916 // The parameter isnew reflects if the entity is "new" to the client, meaning it just came into the client's PVS.
917 void CSQC_Ent_Update(entity this, bool isnew)
919 this.sourceLoc = __FILE__":"STR(__LINE__);
922 // set up the "time" global for received entities to be correct for interpolation purposes
923 float savetime = time;
930 serverprevtime = time;
931 serverdeltatime = STAT(MOVEVARS_TICRATE) * STAT(MOVEVARS_TIMESCALE);
932 time = serverprevtime + serverdeltatime;
935 #ifdef DP_CSQC_ENTITY_REMOVE_IS_B0RKED
938 if (t != this.enttype || isnew)
940 LOG_INFOF("A CSQC entity changed its type! (edict: %d, server: %d, type: %d -> %d)", etof(this), this.entnum, this.enttype, t);
951 LOG_INFOF("A CSQC entity appeared out of nowhere! (edict: %d, server: %d, type: %d)", etof(this), this.entnum, t);
958 FOREACH(LinkedEntities, it.m_id == t, {
959 if (isnew) this.classname = it.netname;
960 if (autocvar_developer_csqcentities)
961 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);
962 done = it.m_read(this, NULL, isnew);
963 MUTATOR_CALLHOOK(Ent_Update, this, isnew);
969 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);
973 // Destructor, but does NOT deallocate the entity by calling remove(). Also
974 // used when an entity changes its type. For an entity that someone interacts
975 // with others, make sure it can no longer do so.
976 void Ent_Remove(entity this)
978 if(this.entremove) this.entremove(this);
980 if(this.skeletonindex)
982 skel_delete(this.skeletonindex);
983 this.skeletonindex = 0;
986 if(this.snd_looping > 0)
988 sound(this, this.snd_looping, SND_Null, VOL_BASE, autocvar_cl_jetpack_attenuation);
989 this.snd_looping = 0;
994 this.draw = func_null;
995 this.entremove = func_null;
996 // TODO possibly set more stuff to defaults
998 // CSQC_Ent_Remove : Called when the server requests a SSQC / CSQC entity to be removed. Essentially call remove(this) as well.
999 void CSQC_Ent_Remove(entity this)
1001 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Ent_Remove() with this=%i {.entnum=%d, .enttype=%d}", this, this.entnum, this.enttype);
1004 LOG_WARN("CSQC_Ent_Remove called for already removed entity. Packet loss?");
1007 if (this.enttype) Ent_Remove(this);
1011 void Gamemode_Init()
1015 if(!(calledhooks & HOOK_START))
1016 localcmd("\n_cl_hook_gamestart ", MapInfo_Type_ToString(gametype), "\n");
1017 calledhooks |= HOOK_START;
1020 // 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.
1021 void CSQC_Parse_StuffCmd(string strMessage)
1023 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_StuffCmd(\"%s\")", strMessage);
1024 localcmd(strMessage);
1026 // 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.
1027 void CSQC_Parse_Print(string strMessage)
1029 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_Print(\"%s\")", strMessage);
1030 print(ColorTranslateRGB(strMessage));
1033 // CSQC_Parse_CenterPrint : Provides the centerprint_AddStandard string in the first parameter that the server provided.
1034 void CSQC_Parse_CenterPrint(string strMessage)
1036 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_CenterPrint(\"%s\")", strMessage);
1037 centerprint_AddStandard(strMessage);
1040 // CSQC_Parse_TempEntity : Handles all temporary entity network data in the CSQC layer.
1041 // You must ALWAYS first acquire the temporary ID, which is sent as a byte.
1042 // Return value should be 1 if CSQC handled the temporary entity, otherwise return 0 to have the engine process the event.
1043 bool CSQC_Parse_TempEntity()
1046 int nTEID = ReadByte();
1048 FOREACH(TempEntities, it.m_id == nTEID, {
1049 if (autocvar_developer_csqcentities)
1050 LOG_INFOF("CSQC_Parse_TempEntity() nTEID=%s (%d)", it.netname, nTEID);
1051 return it.m_read(NULL, NULL, true);
1054 if (autocvar_developer_csqcentities)
1055 LOG_INFOF("CSQC_Parse_TempEntity() with nTEID=%d", nTEID);
1057 // No special logic for this temporary entity; return 0 so the engine can handle it
1064 if (autocvar_cl_orthoview && autocvar_cl_orthoview_nofog)
1065 localcmd("\nr_drawfog 0\n");
1066 else if (forcefog != "")
1067 localcmd(sprintf("\nfog %s\nr_fog_exp2 0\nr_drawfog 1\n", forcefog));
1070 bool net_handle_ServerWelcome();
1071 NET_HANDLE(ENT_CLIENT_SCORES_INFO, bool isnew)
1074 gametype = ReadRegistered(Gametypes);
1075 teamplay = _MapInfo_GetTeamPlayBool(gametype);
1076 HUD_ModIcons_SetFunc();
1077 FOREACH(Scores, true, {
1078 strcpy(scores_label(it), ReadString());
1079 scores_flags(it) = ReadByte();
1081 for (int i = 0; i < MAX_TEAMSCORE; ++i)
1083 strcpy(teamscores_label(i), ReadString());
1084 teamscores_flags(i) = ReadByte();
1086 bool welcome_msg_too = ReadByte();
1087 if (welcome_msg_too)
1088 net_handle_ServerWelcome();
1090 Scoreboard_InitScores();
1094 NET_HANDLE(ENT_CLIENT_INIT, bool isnew)
1096 nb_pb_period = ReadByte() / 32; //Accuracy of 1/32th
1098 hook_shotorigin[0] = decompressShotOrigin(ReadInt24_t());
1099 hook_shotorigin[1] = decompressShotOrigin(ReadInt24_t());
1100 hook_shotorigin[2] = decompressShotOrigin(ReadInt24_t());
1101 hook_shotorigin[3] = decompressShotOrigin(ReadInt24_t());
1102 arc_shotorigin[0] = decompressShotOrigin(ReadInt24_t());
1103 arc_shotorigin[1] = decompressShotOrigin(ReadInt24_t());
1104 arc_shotorigin[2] = decompressShotOrigin(ReadInt24_t());
1105 arc_shotorigin[3] = decompressShotOrigin(ReadInt24_t());
1107 strcpy(forcefog, ReadString());
1109 armorblockpercent = ReadByte() / 255.0;
1110 damagepush_speedfactor = ReadByte() / 255.0;
1112 serverflags = ReadByte();
1114 g_trueaim_minrange = ReadCoord();
1118 MUTATOR_CALLHOOK(Ent_Init);
1120 if (!postinit) PostInit();
1123 float GetSpeedUnitFactor(int speed_unit)
1129 case 2: return 0.0254;
1130 case 3: return 0.0254 * 3.6;
1131 case 4: return 0.0254 * 3.6 * 0.6213711922;
1132 case 5: return 0.0254 * 1.943844492; // 1 m/s = 1.943844492 knots, because 1 knot = 1.852 km/h
1136 string GetSpeedUnit(int speed_unit)
1140 // translator-friendly strings without the initial space
1142 case 1: return strcat(" ", _("qu/s"));
1143 case 2: return strcat(" ", _("m/s"));
1144 case 3: return strcat(" ", _("km/h"));
1145 case 4: return strcat(" ", _("mph"));
1146 case 5: return strcat(" ", _("knots"));
1150 NET_HANDLE(TE_CSQC_RACE, bool isNew)
1156 case RACE_NET_CHECKPOINT_HIT_QUALIFYING:
1157 race_checkpoint = ReadByte();
1158 race_time = ReadInt24_t();
1159 race_previousbesttime = ReadInt24_t();
1160 race_mypreviousbesttime = ReadInt24_t();
1161 string pbestname = ReadString();
1162 if(autocvar_cl_race_cptimes_onlyself)
1164 race_previousbesttime = race_mypreviousbesttime;
1165 race_mypreviousbesttime = 0;
1166 strcpy(race_previousbestname, "");
1169 strcpy(race_previousbestname, pbestname);
1171 race_checkpointtime = time;
1173 if(race_checkpoint == 0 || race_checkpoint == 254)
1175 race_penaltyaccumulator = 0;
1176 race_laptime = time; // valid
1180 case RACE_NET_CHECKPOINT_CLEAR:
1182 race_checkpointtime = 0;
1185 case RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING:
1186 race_laptime = ReadCoord();
1187 race_checkpointtime = -99999;
1189 case RACE_NET_CHECKPOINT_NEXT_QUALIFYING:
1190 race_nextcheckpoint = ReadByte();
1192 race_nextbesttime = ReadInt24_t();
1193 if(b != RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING) // not while spectating (matches server)
1194 race_mybesttime = ReadInt24_t();
1195 string newname = ReadString();
1196 if(autocvar_cl_race_cptimes_onlyself && b != RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING)
1198 race_nextbesttime = race_mybesttime;
1199 race_mybesttime = 0;
1200 strcpy(race_nextbestname, "");
1203 strcpy(race_nextbestname, newname);
1206 case RACE_NET_CHECKPOINT_HIT_RACE:
1207 race_mycheckpoint = ReadByte();
1208 race_mycheckpointtime = time;
1209 race_mycheckpointdelta = ReadInt24_t();
1210 race_mycheckpointlapsdelta = ReadByte();
1211 if(race_mycheckpointlapsdelta >= 128)
1212 race_mycheckpointlapsdelta -= 256;
1213 int who = ReadByte();
1215 strcpy(race_mycheckpointenemy, entcs_GetName(who - 1));
1217 strcpy(race_mycheckpointenemy, ""); // TODO: maybe string_null works fine here?
1220 case RACE_NET_CHECKPOINT_HIT_RACE_BY_OPPONENT:
1221 race_othercheckpoint = ReadByte();
1222 race_othercheckpointtime = time;
1223 race_othercheckpointdelta = ReadInt24_t();
1224 race_othercheckpointlapsdelta = ReadByte();
1225 if(race_othercheckpointlapsdelta >= 128)
1226 race_othercheckpointlapsdelta -= 256;
1227 int what = ReadByte();
1229 strcpy(race_othercheckpointenemy, entcs_GetName(what - 1));
1231 strcpy(race_othercheckpointenemy, ""); // TODO: maybe string_null works fine here?
1234 case RACE_NET_PENALTY_RACE:
1235 case RACE_NET_PENALTY_QUALIFYING:
1236 race_penaltyeventtime = time;
1237 race_penaltytime = ReadShort();
1238 string reason = ReadString();
1239 if (reason == "missing a checkpoint")
1240 reason = _("missing a checkpoint");
1241 strcpy(race_penaltyreason, reason);
1242 if (b == RACE_NET_PENALTY_QUALIFYING)
1243 race_penaltyaccumulator += race_penaltytime;
1246 case RACE_NET_SERVER_RECORD:
1247 race_server_record = ReadInt24_t();
1249 case RACE_NET_SPEED_AWARD:
1250 race_speedaward = ReadInt24_t();
1251 strcpy(race_speedaward_holder, ReadString());
1253 case RACE_NET_SPEED_AWARD_BEST:
1254 race_speedaward_alltimebest = ReadInt24_t();
1255 strcpy(race_speedaward_alltimebest_holder, ReadString());
1257 case RACE_NET_RANKINGS_CNT:
1258 RANKINGS_DISPLAY_CNT = ReadByte();
1260 case RACE_NET_SERVER_RANKINGS:
1262 int pos = ReadShort();
1263 prevpos = ReadShort();
1266 // move other rankings out of the way
1269 int m = min(prevpos, RANKINGS_DISPLAY_CNT);
1270 for (i=m-1; i>pos-1; --i) {
1271 grecordtime[i] = grecordtime[i-1];
1272 strcpy(grecordholder[i], grecordholder[i-1]);
1274 } else if (del) { // a record has been deleted by the admin
1275 for (i=pos-1; i<= RANKINGS_DISPLAY_CNT-1; ++i) {
1276 if (i == RANKINGS_DISPLAY_CNT-1) { // clear out last record
1278 strfree(grecordholder[i]);
1281 grecordtime[i] = grecordtime[i+1];
1282 strcpy(grecordholder[i], grecordholder[i+1]);
1285 } else { // player has no ranked record yet
1286 for (i=RANKINGS_DISPLAY_CNT-1;i>pos-1;--i) {
1287 grecordtime[i] = grecordtime[i-1];
1288 strcpy(grecordholder[i], grecordholder[i-1]);
1292 if (grecordtime[RANKINGS_DISPLAY_CNT]) {
1293 // kick off the player who fell from the last displayed position
1294 grecordtime[RANKINGS_DISPLAY_CNT] = 0;
1295 strfree(grecordholder[RANKINGS_DISPLAY_CNT]);
1298 // store new ranking
1299 strcpy(grecordholder[pos-1], ReadString());
1300 grecordtime[pos-1] = ReadInt24_t();
1301 if(strdecolorize(grecordholder[pos-1]) == strdecolorize(entcs_GetName(player_localnum)))
1304 case RACE_NET_SERVER_STATUS:
1305 race_status = ReadShort();
1306 strcpy(race_status_name, ReadString());
1311 NET_HANDLE(TE_CSQC_TEAMNAGGER, bool isNew)
1317 NET_HANDLE(TE_CSQC_PINGPLREPORT, bool isNew)
1320 int pi = ReadShort();
1321 int pl = ReadByte();
1322 int ml = ReadByte();
1324 entity e = playerslots[i];
1327 e.ping_packetloss = pl / 255.0;
1328 e.ping_movementloss = ml / 255.0;
1331 NET_HANDLE(TE_CSQC_WEAPONCOMPLAIN, bool isNew)
1333 int weapon_id = ReadByte();
1334 complain_weapon = REGISTRY_GET(Weapons, weapon_id);
1335 complain_weapon_type = ReadByte();
1338 complain_weapon_time = time;
1339 weapontime = time; // ping the weapon panel
1341 switch(complain_weapon_type)
1343 case 0: Local_Notification(MSG_MULTI, ITEM_WEAPON_NOAMMO, weapon_id); break;
1344 case 1: Local_Notification(MSG_MULTI, ITEM_WEAPON_DONTHAVE, weapon_id); break;
1345 default: Local_Notification(MSG_MULTI, ITEM_WEAPON_UNAVAILABLE, weapon_id); break;
1349 string translate_modifications(string s)
1351 return build_mutator_list(s);
1354 string translate_weaponarena(string s)
1356 if (s == "") return s;
1357 if (s == "All Weapons Arena") return _("All Weapons Arena");
1358 if (s == "All Available Weapons Arena") return _("All Available Weapons Arena");
1359 if (s == "Most Weapons Arena") return _("Most Weapons Arena");
1360 if (s == "Most Available Weapons Arena") return _("Most Available Weapons Arena");
1361 if (s == "Dev All Weapons Arena") return s; // development option, do not translate
1362 if (s == "Dev All Available Weapons Arena") return s; // development option, do not translate
1363 if (s == "No Weapons Arena") return _("No Weapons Arena");
1365 int n = tokenizebyseparator(s, " & ");
1366 string wpn_list = "";
1367 for (int i = 0; i < n; i++)
1369 Weapon wep = Weapon_from_name(argv(i));
1370 if (wep == WEP_Null)
1371 LOG_INFO("^3Warning: ^7server sent an invalid weapon name\n");
1372 wpn_list = cons_mid(wpn_list, " & ", wep.m_name);
1375 return sprintf(_("%s Arena"), wpn_list);
1377 return _("No Weapons Arena");
1380 string GetVersionMessage(string hostversion, bool version_mismatch, bool version_check)
1382 string xonotic_hostversion = strcat("Xonotic ", hostversion);
1383 if (version_mismatch)
1386 return strcat(sprintf(_("This is %s"), xonotic_hostversion), "\n^3",
1387 _("Your client version is outdated."), "\n\n\n",
1388 _("### YOU WON'T BE ABLE TO PLAY ON THIS SERVER ###"), "\n\n\n",
1389 _("Please update!"));
1391 return strcat(sprintf(_("This is %s"), xonotic_hostversion), "\n^3",
1392 _("This server is using an outdated Xonotic version."), "\n\n\n",
1393 _("### THIS SERVER IS INCOMPATIBLE AND THUS YOU CANNOT JOIN ###"));
1395 return sprintf(_("Welcome to %s"), xonotic_hostversion);
1398 bool net_handle_ServerWelcome()
1400 campaign = ReadByte();
1403 string campaign_title = ReadString();
1404 int campaign_level = ReadByte();
1405 string campaign_msg = ReadString();
1406 string welcomedialog_args;
1407 welcomedialog_args = strcat("HOSTNAME \"", campaign_title, "\"");
1408 string key = getcommandkey(_("jump"), "+jump");
1409 string msg = strcat(
1410 CCR("^F1"), sprintf(_("Level %d:"), campaign_level),
1411 sprintf(CCR(" ^BG%s\n^3\n"), campaign_msg),
1412 sprintf(CCR(_("^BGPress ^F2%s^BG to enter the game")), key));
1413 msg = MakeConsoleSafe(strreplace("\n", "\\n", msg));
1414 welcomedialog_args = strcat(welcomedialog_args, " WELCOME \"", msg, "\"");
1415 localcmd("\nmenu_cmd directmenu Welcome ", welcomedialog_args, "\n");
1419 strcpy(hostname, ReadString());
1420 string hostversion = ReadString();
1421 bool version_mismatch = ReadByte();
1422 bool version_check = ReadByte();
1423 srv_minplayers = ReadByte();
1424 srv_maxplayers = ReadByte();
1425 string modifications = translate_modifications(ReadString());
1426 string weaponarena_list = translate_weaponarena(ReadString());
1427 string cache_mutatormsg = ReadString();
1428 string motd = ReadString();
1430 string msg = GetVersionMessage(hostversion, version_mismatch, version_check);
1432 msg = strcat(msg, "\n\n", _("Gametype:"), " ^1", MapInfo_Type_ToText(gametype), "\n");
1434 msg = strcat(msg, "\n", _("Map:"), " ^2");
1435 if (world.message == "")
1436 msg = strcat(msg, mi_shortname, "\n");
1439 int i = strstrofs(world.message, " by ", 0); // matches _MapInfo_Generate()
1440 string longname = i >= 0 ? substring(world.message, 0, i) : world.message;
1441 msg = strcat(msg, (strcasecmp(longname, mi_shortname) ? strcat(mi_shortname, " ^7// ^2") : ""), longname, "\n");
1444 if (srv_minplayers || srv_maxplayers)
1446 msg = strcat(msg, "\n", _("This match supports"), " ^5");
1447 if (srv_minplayers == srv_maxplayers)
1448 msg = strcat(msg, sprintf(_("%d players"), srv_maxplayers), "\n");
1449 else if (srv_minplayers && srv_maxplayers)
1450 msg = strcat(msg, sprintf(_("%d to %d players"), srv_minplayers, srv_maxplayers), "\n");
1451 else if (srv_maxplayers)
1452 msg = strcat(msg, sprintf(_("%d players maximum"), srv_maxplayers), "\n");
1454 msg = strcat(msg, sprintf(_("%d players minimum"), srv_minplayers), "\n");
1457 modifications = cons_mid(modifications, ", ", weaponarena_list);
1458 if(modifications != "")
1459 msg = strcat(msg, "\n", _("Active modifications:"), " ^3", modifications, "\n");
1461 if (cache_mutatormsg != "")
1462 msg = strcat(msg, "\n", _("Special gameplay tips:"), " ^7", cache_mutatormsg, "\n");
1463 string mutator_msg = "";
1464 MUTATOR_CALLHOOK(BuildGameplayTipsString, mutator_msg);
1465 mutator_msg = M_ARGV(0, string);
1466 msg = strcat(msg, mutator_msg); // trust that the mutator will do proper formatting
1469 msg = strcat(msg, "\n^9↓ ", _("Server's message"), " ↓\n", motd);
1471 strcpy(welcome_msg, msg);
1472 welcome_msg_menu_check_maxtime = time + 1; // wait for menu to load before showing the welcome dialog
1476 void Welcome_Message_Show_Try()
1478 if (!welcome_msg_menu_check_maxtime)
1481 // if want dialog check if menu is initialized but for a short time
1482 if (cvar("_menu_initialized") == 2 || time > welcome_msg_menu_check_maxtime)
1484 if (cvar("_menu_welcome_dialog_available"))
1486 string welcomedialog_args = strcat("HOSTNAME \"", hostname, "\"");
1487 string msg = MakeConsoleSafe(strreplace("\n", "\\n", welcome_msg));
1488 welcomedialog_args = strcat(welcomedialog_args, " WELCOME \"", msg, "\"");
1490 if (intermission || isdemo() || !autocvar_cl_welcome)
1492 if (cvar("_menu_cmd_closemenu_available"))
1494 // initialize the dialog without opening it
1495 localcmd("\nmenu_cmd closemenu Welcome ", welcomedialog_args, "\n");
1499 // legacy code for clients with old menus
1500 // since togglemenu 0 doesn't close the dialog but only hides it,
1501 // playing back a demo the Welcome dialog will pop up on the first ESC press
1502 localcmd("\nmenu_cmd directmenu Welcome ", welcomedialog_args, "\n");
1503 // close it after it's been initialized so it can still be opened manually
1504 localcmd("\ntogglemenu 0\n");
1508 localcmd("\nmenu_cmd directmenu Welcome ", welcomedialog_args, "\n");
1511 strfree(welcome_msg);
1512 welcome_msg_menu_check_maxtime = 0;
1516 NET_HANDLE(TE_CSQC_SERVERWELCOME, bool isNew)
1518 return net_handle_ServerWelcome();
1521 string _getcommandkey(string cmd_name, string command, bool forcename)
1524 float n, j, k, l = 0;
1526 if (!autocvar_hud_showbinds)
1529 keys = db_get(binddb, command);
1532 bool joy_active = cvar("joy_active");
1533 n = tokenize(findkeysforcommand(command, 0)); // uses '...' strings
1534 for(j = 0; j < n; ++j)
1539 string key = keynumtostring(k);
1540 if(!joy_active && substring(key, 0, 3) == "JOY")
1543 key = translate_key(key);
1548 keys = strcat(keys, ", ", key);
1551 if (autocvar_hud_showbinds_limit > 0 && autocvar_hud_showbinds_limit <= l)
1558 db_put(binddb, command, keys);
1561 if (keys == "NO_KEY") {
1562 if (autocvar_hud_showbinds > 1)
1563 return sprintf(_("%s (not bound)"), cmd_name);
1567 else if (autocvar_hud_showbinds > 1 || forcename)
1568 return sprintf("%s (%s)", cmd_name, keys);
1573 /** engine callback */
1574 void URI_Get_Callback(int id, int status, string data)
1576 TC(int, id); TC(int, status);
1577 if(url_URI_Get_Callback(id, status, data))
1581 else if (id == URI_GET_DISCARD)
1585 else if (id >= URI_GET_CURL && id <= URI_GET_CURL_END)
1588 Curl_URI_Get_Callback(id, status, data);
1592 LOG_INFOF("Received HTTP request data for an invalid id %d.", id);