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/checkextension.qh>
17 #include <common/deathtypes/all.qh>
18 #include <common/effects/all.inc>
19 #include <common/effects/all.qh>
20 #include <common/effects/effect.qh>
21 #include <common/effects/qc/_mod.qh>
22 #include <common/ent_cs.qh>
23 #include <common/gamemodes/gamemode/nexball/cl_nexball.qh>
24 #include <common/items/_mod.qh>
25 #include <common/mapinfo.qh>
26 #include <common/mapobjects/_mod.qh>
27 #include <common/minigames/cl_minigames.qh>
28 #include <common/minigames/cl_minigames_hud.qh>
29 #include <common/net_linked.qh>
30 #include <common/net_notice.qh>
31 #include <common/scores.qh>
32 #include <common/vehicles/all.qh>
33 #include <lib/csqcmodel/cl_model.qh>
34 #include <lib/csqcmodel/interpolate.qh>
35 #include <lib/warpzone/client.qh>
37 // --------------------------------------------------------------------------
38 // BEGIN REQUIRED CSQC FUNCTIONS
41 #define DP_CSQC_ENTITY_REMOVE_IS_B0RKED
43 // CSQC_Init : Called every time the CSQC code is initialized (essentially at map load)
44 // Useful for precaching things
46 void CSQC_Init(float apilevel, string enginename, float engineversion)
48 prvm_language = strzone(cvar_string("prvm_language"));
51 LOG_TRACEF("^4CSQC Build information: ^1%s", WATERMARK);
54 CheckEngineExtensions();
59 if (getplayerkeyvalue(i, "viewentity") == "")
64 // needs to be done so early because of the constants they create
67 static_init_precache();
71 ClientProgsDB = db_load("client.db");
75 //registercommand("hud_configure");
76 //registercommand("hud_save");
77 //registercommand("menu_action");
79 ConsoleCommand_macro_init();
81 registercvar("hud_usecsqc", "1");
82 registercvar("scoreboard_columns", "default");
84 registercvar("cl_nade_type", "3");
85 registercvar("cl_pokenade_type", "zombie");
87 registercvar("cl_jumpspeedcap_min", "");
88 registercvar("cl_jumpspeedcap_max", "");
90 registercvar("cl_shootfromfixedorigin", "");
92 registercvar("cl_multijump", "-1");
94 registercvar("cl_dodging", "0");
96 registercvar("cl_spawn_near_teammate", "1");
98 registercvar("cl_weapon_switch_reload", "1");
99 registercvar("cl_weapon_switch_fallback_to_impulse", "1");
101 registercvar("cl_allow_uidranking", "1");
103 if(autocvar_cl_lockview)
104 cvar_set("cl_lockview", "0");
106 if (cvar_type("_scoreboard_team_selection_available") & CVAR_TYPEFLAG_EXISTS)
107 cvar_settemp("_scoreboard_team_selection_available", "1");
108 cvar_set("_scoreboard_team_selection", "0"); // in case it has been left set to 1
116 teams = Sort_Spawn();
117 players = Sort_Spawn();
119 GetTeam(NUM_SPECTATOR, true); // add specs first
121 for (int w = 0; w <= WEP_LAST - WEP_FIRST; ++w)
122 weapon_accuracy[w] = -1;
126 if(autocvar_cl_reticle)
128 precache_pic("gfx/reticle_normal");
129 // weapon reticles are precached in weapon files
133 get_mi_min_max_texcoords(1); // try the CLEVER way first
134 minimapname = strcat("gfx/", mi_shortname, "_radar");
136 if (precache_pic(minimapname) == "")
138 // but maybe we have a non-clever minimap
139 minimapname = strcat("gfx/", mi_shortname, "_mini");
140 if (precache_pic(minimapname) == "")
141 minimapname = ""; // FAIL
143 get_mi_min_max_texcoords(0); // load new texcoords
146 mi_center = (mi_min + mi_max) * 0.5;
147 mi_scale = mi_max - mi_min;
148 minimapname = strzone(minimapname);
151 hud_skin_path = strzone(strcat("gfx/hud/", autocvar_hud_skin));
152 LoadMenuSkinValues();
155 // CSQC_Shutdown : Called every time the CSQC code is shutdown (changing maps, quitting, etc)
164 if(autocvar_cl_db_saveasdump)
165 db_dump(ClientProgsDB, "client.db");
167 db_save(ClientProgsDB, "client.db");
168 db_close(ClientProgsDB);
171 cvar_set("chase_active",ftos(chase_active_backup));
173 // unset the event chasecam's chase_active
174 if(autocvar_chase_active < 0)
175 cvar_set("chase_active", "0");
177 if (autocvar_r_drawviewmodel < 0)
178 cvar_set("r_drawviewmodel", "0");
180 cvar_set("slowmo", cvar_defstring("slowmo")); // reset it back to 'default'
184 if (!(calledhooks & HOOK_START))
185 localcmd("\n_cl_hook_gamestart nop\n");
186 if (!(calledhooks & HOOK_END))
188 int gamecount = cvar("cl_matchcount");
189 localcmd("\ncl_hook_gameend\n");
190 // NOTE: using localcmd here to ensure it's executed AFTER cl_hook_gameend
191 // earlier versions of the game abuse the hook to set this cvar
192 localcmd(strcat("cl_matchcount ", itos(gamecount + 1), "\n"));
193 //cvar_set("cl_matchcount", itos(gamecount + 1));
197 localcmd("\ncl_hook_shutdown\n");
199 localcmd("\n-button12\n");
201 strfree(gametype_custom_name);
203 deactivate_minigame();
204 HUD_MinigameMenu_Close(NULL, NULL, NULL);
206 ReplicateVars(REPLICATEVARS_DESTROY);
215 for(e = prev.sort_next; e; prev = e, e = e.sort_next)
217 if(prev != e.sort_prev)
218 error(strcat("sort list chain error\nplease submit the output of 'prvm_edicts client' to the developers"));
222 for(e = prev.sort_next; e; prev = e, e = e.sort_next)
224 if(prev != e.sort_prev)
225 error(strcat("sort list chain error\nplease submit the output of 'prvm_edicts client' to the developers"));
229 float RegisterPlayer(entity player)
233 for(pl = players.sort_next; pl; pl = pl.sort_next)
235 error("Player already registered!");
236 player.sort_next = players.sort_next;
237 player.sort_prev = players;
238 if(players.sort_next)
239 players.sort_next.sort_prev = player;
240 players.sort_next = player;
245 void RemovePlayer(entity player)
250 for(pl = players.sort_next; pl && pl != player; pl = pl.sort_next)
255 error("Trying to remove a player which is not in the playerlist!");
258 parent.sort_next = player.sort_next;
260 player.sort_next.sort_prev = parent;
264 void MoveToLast(entity e)
267 entity ent = e.sort_next;
276 float RegisterTeam(entity Team)
278 assert_once(Team.team, eprint(Team));
281 for(tm = teams.sort_next; tm; tm = tm.sort_next)
283 error("Team already registered!");
284 Team.sort_next = teams.sort_next;
285 Team.sort_prev = teams;
287 teams.sort_next.sort_prev = Team;
288 teams.sort_next = Team;
289 if(Team.team && Team.team != NUM_SPECTATOR)
295 void RemoveTeam(entity Team)
300 for(tm = teams.sort_next; tm && tm != Team; tm = tm.sort_next)
305 LOG_INFO(_("Trying to remove a team which is not in the teamlist!"));
308 parent.sort_next = Team.sort_next;
310 Team.sort_next.sort_prev = parent;
311 if(Team.team && Team.team != NUM_SPECTATOR)
316 entity GetTeam(int Team, bool add)
318 TC(int, Team); TC(bool, add);
319 int num = (Team == NUM_SPECTATOR) ? 16 : Team;
321 return teamslots[num];
324 entity tm = new_pure(team);
332 bool SetTeam(entity o, int Team)
335 //devassert_once(Team);
348 if(GetTeam(Team, false) == NULL)
350 LOG_TRACEF("trying to switch to unsupported team %d", Team);
351 Team = NUM_SPECTATOR;
364 if(GetTeam(Team, false) == NULL)
366 LOG_TRACEF("trying to switch to unsupported team %d", Team);
367 Team = NUM_SPECTATOR;
372 if(Team == -1) // leave
376 tm = GetTeam(o.team, false);
387 tm = GetTeam(Team, true);
392 else if(Team != o.team)
394 tm = GetTeam(o.team, false);
397 tm = GetTeam(Team, true);
405 void Playerchecker_Think(entity this)
409 for(i = 0; i < maxclients; ++i)
412 if(entcs_GetName(i) == "")
416 // player disconnected
430 playerslots[i] = e = new_pure(playerslot);
434 e.ping_packetloss = 0;
435 e.ping_movementloss = 0;
436 //e.gotscores = 0; // we might already have the scores...
437 int t = entcs_GetScoreTeam(i);
438 if (t) SetTeam(e, t); // will not hurt; later updates come with Scoreboard_UpdatePlayerTeams
440 Scoreboard_UpdatePlayerPos(e);
444 this.nextthink = time + 0.2;
449 entity playerchecker = new_pure(playerchecker);
450 setthink(playerchecker, Playerchecker_Think);
451 playerchecker.nextthink = time + 0.2;
455 // this can't be called in CSQC_Init as it'd send cvars too early
456 ReplicateVars_Start();
461 void Release_Common_Keys()
464 localcmd("-fire2\n");
468 localcmd("-forward\n");
470 localcmd("-moveleft\n");
471 localcmd("-moveright\n");
474 // CSQC_InputEvent : Used to perform actions based on any key pressed, key released and mouse on the client.
475 // Return value should be 1 if CSQC handled the input, otherwise return 0 to have the input passed to the engine.
476 // All keys are in ascii.
477 // bInputType = 0 is key pressed, 1 is key released, 2 and 3 are mouse input.
478 // In the case of keyboard input, nPrimary is the ascii code, and nSecondary is 0.
479 // In the case of mouse input, nPrimary is xdelta, nSecondary is ydelta.
480 // In the case of mouse input after a setcursormode(1) call, nPrimary is xpos, nSecondary is ypos.
481 float CSQC_InputEvent(int bInputType, float nPrimary, float nSecondary)
484 bool override = false;
486 override |= HUD_Scoreboard_InputEvent(bInputType, nPrimary, nSecondary);
490 override |= HUD_Panel_InputEvent(bInputType, nPrimary, nSecondary);
494 override |= HUD_Panel_Chat_InputEvent(bInputType, nPrimary, nSecondary);
496 override |= QuickMenu_InputEvent(bInputType, nPrimary, nSecondary);
498 override |= HUD_Radar_InputEvent(bInputType, nPrimary, nSecondary);
500 override |= MapVote_InputEvent(bInputType, nPrimary, nSecondary);
502 override |= HUD_Minigame_InputEvent(bInputType, nPrimary, nSecondary);
507 if(bInputType == 3 || bInputType == 2)
510 // at this point bInputType can only be 0 or 1 (key pressed or released)
511 bool key_pressed = (bInputType == 0);
514 if(nPrimary == K_ALT) hudShiftState |= S_ALT;
515 if(nPrimary == K_CTRL) hudShiftState |= S_CTRL;
516 if(nPrimary == K_SHIFT) hudShiftState |= S_SHIFT;
517 if(nPrimary == K_TAB) hudShiftState |= S_TAB;
520 if(nPrimary == K_ALT) hudShiftState -= (hudShiftState & S_ALT);
521 if(nPrimary == K_CTRL) hudShiftState -= (hudShiftState & S_CTRL);
522 if(nPrimary == K_SHIFT) hudShiftState -= (hudShiftState & S_SHIFT);
523 if(nPrimary == K_TAB) hudShiftState -= (hudShiftState & S_TAB);
526 // NOTE: Shift-Escape must be filtered out because it's the hardcoded console shortcut
527 if (nPrimary == K_ESCAPE && !(hudShiftState & S_SHIFT) && key_pressed)
529 if (hudShiftState & S_TAB)
531 Scoreboard_UI_Enable(0);
534 if (autocvar_menu_gamemenu && !isdemo() && cvar("_menu_gamemenu_dialog_available"))
536 localcmd("\nmenu_showgamemenudialog\n");
544 // END REQUIRED CSQC FUNCTIONS
545 // --------------------------------------------------------------------------
547 // --------------------------------------------------------------------------
548 // BEGIN OPTIONAL CSQC FUNCTIONS
549 .int survival_status;
550 void Ent_RemovePlayerScore(entity this)
553 SetTeam(this.owner, -1);
554 this.owner.gotscores = 0;
555 FOREACH(Scores, true, {
556 this.owner.(scores(it)) = 0; // clear all scores
558 this.owner.ready = 0;
559 this.owner.eliminated = 0;
560 this.owner.colormap = 0;
561 // TODO add a hook to reset this Survival field
562 this.owner.survival_status = 0;
566 NET_HANDLE(ENT_CLIENT_SCORES, bool isnew)
571 // damnit -.- don't want to go change every single .sv_entnum in hud.qc AGAIN
572 // (no I've never heard of M-x replace-string, sed, or anything like that)
573 bool isNew = !this.owner; // workaround for DP bug
574 int n = ReadByte()-1;
576 #ifdef DP_CSQC_ENTITY_REMOVE_IS_B0RKED
577 if(!isNew && n != this.sv_entnum)
579 //print("A CSQC entity changed its owner!\n");
580 LOG_INFOF("A CSQC entity changed its owner! (edict: %d, classname: %s)", etof(this), this.classname);
588 o = playerslots[this.sv_entnum];
591 o = playerslots[this.sv_entnum] = new_pure(playerslot);
594 o.sv_entnum = this.sv_entnum;
598 // RegisterPlayer(o);
599 //playerchecker will do this for us later, if it has not already done so
601 int sf = ReadShort();
602 int lf = ReadShort();
603 FOREACH(Scores, true, {
604 int p = 1 << (i % 16);
608 o.(scores(it)) = ReadInt24_t();
610 o.(scores(it)) = ReadChar();
617 Scoreboard_UpdatePlayerPos(o); // if not registered, we cannot do this yet!
619 this.entremove = Ent_RemovePlayerScore;
622 NET_HANDLE(ENT_CLIENT_TEAMSCORES, bool isnew)
627 this.team = ReadByte();
628 entity o = this.owner = GetTeam(this.team, true); // these team numbers can always be trusted
630 #if MAX_TEAMSCORE <= 8
634 int sf = ReadShort();
635 int lf = ReadShort();
637 for(i = 0; i < MAX_TEAMSCORE; ++i)
641 o.(teamscores(i)) = ReadInt24_t();
643 o.(teamscores(i)) = ReadChar();
648 Scoreboard_UpdateTeamPos(o);
651 NET_HANDLE(ENT_CLIENT_CLIENTDATA, bool isnew)
654 float newspectatee_status;
658 scoreboard_showscores_force = (f & BIT(0));
662 newspectatee_status = ReadByte();
663 if(newspectatee_status == player_localnum + 1)
664 newspectatee_status = -1; // observing
667 newspectatee_status = 0;
669 spectatorbutton_zoom = (f & BIT(2));
670 observe_blocked = (f & BIT(3));
674 num_spectators = ReadByte();
678 for(i = 0; i < MAX_SPECTATORS; ++i)
679 spectatorlist[i] = 0; // reset list first
681 int limit = min(num_spectators, MAX_SPECTATORS);
682 for(i = 0; i < limit; ++i)
685 spectatorlist[i] = slot - 1;
690 for(int j = 0; j < MAX_SPECTATORS; ++j)
691 spectatorlist[j] = 0; // reset list if showspectators has been turned off
697 if(newspectatee_status != spectatee_status)
701 race_checkpointtime = 0;
702 hud_dynamic_shake_factor = -1;
703 spectatee_status_changed_time = time;
705 if (autocvar_hud_panel_healtharmor_progressbar_gfx)
707 if ( (spectatee_status == -1 && newspectatee_status > 0) //before observing, now spectating
708 || (spectatee_status > 0 && newspectatee_status > 0 && spectatee_status != newspectatee_status) //changed spectated player
711 else if(spectatee_status && !newspectatee_status) //before observing/spectating, now playing
714 spectatee_status = newspectatee_status;
716 // we could get rid of spectatee_status, and derive it from player_localentnum and player_localnum
719 NET_HANDLE(ENT_CLIENT_NAGGER, bool isnew)
723 int nags = ReadByte(); // NAGS NAGS NAGS NAGS NAGS NAGS NADZ NAGS NAGS NAGS
727 strfree(vote_called_vote);
737 vote_yescount = ReadByte();
738 vote_nocount = ReadByte();
739 vote_needed = ReadByte();
740 vote_highlighted = ReadChar();
745 strcpy(vote_called_vote, ReadString());
749 for(int i = 0; i < maxclients;)
750 for(int f = ReadByte(), b = 0; b < 8 && i < maxclients; ++b, ++i)
752 playerslots[i].ready = f & BIT(b);
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();
880 int particlesAndOrSound = ReadByte();
884 float teamnum = entcs_GetTeam(entnum - 1);
886 if(autocvar_cl_spawn_event_particles && (particlesAndOrSound & BIT(0)))
890 case NUM_TEAM_1: pointparticles(EFFECT_SPAWN_RED, this.origin, '0 0 0', 1); break;
891 case NUM_TEAM_2: pointparticles(EFFECT_SPAWN_BLUE, this.origin, '0 0 0', 1); break;
892 case NUM_TEAM_3: pointparticles(EFFECT_SPAWN_YELLOW, this.origin, '0 0 0', 1); break;
893 case NUM_TEAM_4: pointparticles(EFFECT_SPAWN_PINK, this.origin, '0 0 0', 1); break;
894 default: pointparticles(EFFECT_SPAWN_NEUTRAL, this.origin, '0 0 0', 1); break;
898 if(autocvar_cl_spawn_event_sound && (particlesAndOrSound & BIT(1)))
900 sound(this, CH_TRIGGER, SND_SPAWN, VOL_BASE, ATTEN_NORM);
906 // local spawn actions
907 if(is_new && (!entnum || (entnum == player_localentnum)))
909 if(autocvar_cl_spawnzoom && !autocvar_cl_lockview)
912 current_viewzoom = (1 / bound(1, autocvar_cl_spawnzoom_factor, 16));
915 if(autocvar_cl_unpress_zoom_on_spawn)
920 HUD_Radar_Hide_Maximized();
922 //printf("Ent_ReadSpawnEvent(is_new = %d); origin = %s, entnum = %d, localentnum = %d\n", is_new, vtos(this.origin), entnum, player_localentnum);
925 // CSQC_Ent_Update : Called every frame that the server has indicated an update to the SSQC / CSQC entity has occured.
926 // The parameter isnew reflects if the entity is "new" to the client, meaning it just came into the client's PVS.
927 void CSQC_Ent_Update(entity this, bool isnew)
929 this.sourceLoc = __FILE__":"STR(__LINE__);
932 // set up the "time" global for received entities to be correct for interpolation purposes
933 float savetime = time;
940 serverprevtime = time;
941 serverdeltatime = STAT(MOVEVARS_TICRATE) * STAT(MOVEVARS_TIMESCALE);
942 time = serverprevtime + serverdeltatime;
945 #ifdef DP_CSQC_ENTITY_REMOVE_IS_B0RKED
948 if (t != this.enttype || isnew)
950 LOG_INFOF("A CSQC entity changed its type! (edict: %d, server: %d, type: %d -> %d)", etof(this), this.entnum, this.enttype, t);
961 LOG_INFOF("A CSQC entity appeared out of nowhere! (edict: %d, server: %d, type: %d)", etof(this), this.entnum, t);
968 FOREACH(LinkedEntities, it.m_id == t, {
969 if (isnew) this.classname = it.netname;
970 if (autocvar_developer_csqcentities)
971 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);
972 done = it.m_read(this, NULL, isnew);
973 MUTATOR_CALLHOOK(Ent_Update, this, isnew);
979 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);
983 // Destructor, but does NOT deallocate the entity by calling remove(). Also
984 // used when an entity changes its type. For an entity that someone interacts
985 // with others, make sure it can no longer do so.
986 void Ent_Remove(entity this)
988 if(this.entremove) this.entremove(this);
990 if(this.skeletonindex)
992 skel_delete(this.skeletonindex);
993 this.skeletonindex = 0;
996 if(this.snd_looping > 0)
998 sound(this, this.snd_looping, SND_Null, VOL_BASE, autocvar_cl_jetpack_attenuation);
999 this.snd_looping = 0;
1003 this.classname = "";
1004 this.draw = func_null;
1005 this.entremove = func_null;
1006 // TODO possibly set more stuff to defaults
1008 // CSQC_Ent_Remove : Called when the server requests a SSQC / CSQC entity to be removed. Essentially call remove(this) as well.
1009 void CSQC_Ent_Remove(entity this)
1011 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Ent_Remove() with this=%i {.entnum=%d, .enttype=%d}", this, this.entnum, this.enttype);
1014 LOG_WARN("CSQC_Ent_Remove called for already removed entity. Packet loss?");
1017 if (this.enttype) Ent_Remove(this);
1021 void Gamemode_Init()
1025 if(!(calledhooks & HOOK_START))
1026 localcmd("\n_cl_hook_gamestart ", MapInfo_Type_ToString(gametype), "\n");
1027 calledhooks |= HOOK_START;
1030 // 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.
1031 void CSQC_Parse_StuffCmd(string strMessage)
1033 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_StuffCmd(\"%s\")", strMessage);
1034 localcmd(strMessage);
1036 // 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.
1037 void CSQC_Parse_Print(string strMessage)
1039 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_Print(\"%s\")", strMessage);
1040 print(ColorTranslateRGB(strMessage));
1043 // CSQC_Parse_CenterPrint : Provides the centerprint_AddStandard string in the first parameter that the server provided.
1044 void CSQC_Parse_CenterPrint(string strMessage)
1046 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_CenterPrint(\"%s\")", strMessage);
1047 centerprint_AddStandard(strMessage);
1050 // CSQC_Parse_TempEntity : Handles all temporary entity network data in the CSQC layer.
1051 // You must ALWAYS first acquire the temporary ID, which is sent as a byte.
1052 // Return value should be 1 if CSQC handled the temporary entity, otherwise return 0 to have the engine process the event.
1053 bool CSQC_Parse_TempEntity()
1056 int nTEID = ReadByte();
1058 FOREACH(TempEntities, it.m_id == nTEID, {
1059 if (autocvar_developer_csqcentities)
1060 LOG_INFOF("CSQC_Parse_TempEntity() nTEID=%s (%d)", it.netname, nTEID);
1061 return it.m_read(NULL, NULL, true);
1064 if (autocvar_developer_csqcentities)
1065 LOG_INFOF("CSQC_Parse_TempEntity() with nTEID=%d", nTEID);
1067 // No special logic for this temporary entity; return 0 so the engine can handle it
1071 bool autocvar_r_drawfog;
1072 bool autocvar_r_fog_exp2;
1076 if (autocvar_cl_orthoview && autocvar_cl_orthoview_nofog)
1078 if (autocvar_r_drawfog)
1079 cvar_set("r_drawfog", "0");
1081 else if (forcefog != "")
1083 // using cvar_set as it's faster and safer than a command
1084 if (!autocvar_r_drawfog)
1085 cvar_set("r_drawfog", "1");
1086 if (autocvar_r_fog_exp2)
1087 cvar_set("r_fog_exp2", "0");
1088 localcmd(sprintf("\nfog %s\n", forcefog));
1092 bool net_handle_ServerWelcome();
1093 NET_HANDLE(ENT_CLIENT_SCORES_INFO, bool isnew)
1096 gametype = ReadRegistered(Gametypes);
1097 strcpy(gametype_custom_name, ReadString());
1098 teamplay = _MapInfo_GetTeamPlayBool(gametype);
1099 HUD_ModIcons_SetFunc();
1100 FOREACH(Scores, true, {
1101 strcpy(scores_label(it), ReadString());
1102 scores_flags(it) = ReadByte();
1104 for (int i = 0; i < MAX_TEAMSCORE; ++i)
1106 strcpy(teamscores_label(i), ReadString());
1107 teamscores_flags(i) = ReadByte();
1109 bool welcome_msg_too = ReadByte();
1110 if (welcome_msg_too)
1111 net_handle_ServerWelcome();
1113 Scoreboard_InitScores();
1117 NET_HANDLE(ENT_CLIENT_INIT, bool isnew)
1119 nb_pb_period = ReadByte() / 32; //Accuracy of 1/32th
1121 hook_shotorigin[0] = decompressShotOrigin(ReadInt24_t());
1122 hook_shotorigin[1] = decompressShotOrigin(ReadInt24_t());
1123 hook_shotorigin[2] = decompressShotOrigin(ReadInt24_t());
1124 hook_shotorigin[3] = decompressShotOrigin(ReadInt24_t());
1125 arc_shotorigin[0] = decompressShotOrigin(ReadInt24_t());
1126 arc_shotorigin[1] = decompressShotOrigin(ReadInt24_t());
1127 arc_shotorigin[2] = decompressShotOrigin(ReadInt24_t());
1128 arc_shotorigin[3] = decompressShotOrigin(ReadInt24_t());
1130 strcpy(forcefog, ReadString());
1132 armorblockpercent = ReadByte() / 255.0;
1133 damagepush_speedfactor = ReadByte() / 255.0;
1135 serverflags = ReadByte();
1137 g_trueaim_minrange = ReadCoord();
1141 MUTATOR_CALLHOOK(Ent_Init);
1143 if (!postinit) PostInit();
1146 float GetSpeedUnitFactor(int speed_unit)
1152 case 2: return 0.0254;
1153 case 3: return 0.0254 * 3.6;
1154 case 4: return 0.0254 * 3.6 * 0.6213711922;
1155 case 5: return 0.0254 * 1.943844492; // 1 m/s = 1.943844492 knots, because 1 knot = 1.852 km/h
1159 string GetSpeedUnit(int speed_unit)
1163 // translator-friendly strings without the initial space
1165 case 1: return strcat(" ", _("qu/s"));
1166 case 2: return strcat(" ", _("m/s"));
1167 case 3: return strcat(" ", _("km/h"));
1168 case 4: return strcat(" ", _("mph"));
1169 case 5: return strcat(" ", _("knots"));
1173 NET_HANDLE(TE_CSQC_RACE, bool isNew)
1179 case RACE_NET_CHECKPOINT_HIT_QUALIFYING:
1180 race_checkpoint = ReadByte();
1181 race_time = ReadInt24_t();
1182 race_previousbesttime = ReadInt24_t();
1183 race_mypreviousbesttime = ReadInt24_t();
1184 string pbestname = ReadString();
1185 if(autocvar_cl_race_cptimes_onlyself)
1187 race_previousbesttime = race_mypreviousbesttime;
1188 race_mypreviousbesttime = 0;
1189 strcpy(race_previousbestname, "");
1192 strcpy(race_previousbestname, pbestname);
1194 race_checkpointtime = time;
1196 if(race_checkpoint == 0 || race_checkpoint == 254)
1198 race_penaltyaccumulator = 0;
1199 race_laptime = time; // valid
1203 case RACE_NET_CHECKPOINT_CLEAR:
1205 race_checkpointtime = 0;
1208 case RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING:
1209 race_laptime = ReadCoord();
1210 race_checkpointtime = -99999;
1212 case RACE_NET_CHECKPOINT_NEXT_QUALIFYING:
1213 race_nextcheckpoint = ReadByte();
1215 race_nextbesttime = ReadInt24_t();
1216 if(b != RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING) // not while spectating (matches server)
1217 race_mybesttime = ReadInt24_t();
1218 string newname = ReadString();
1219 if(autocvar_cl_race_cptimes_onlyself && b != RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING)
1221 race_nextbesttime = race_mybesttime;
1222 race_mybesttime = 0;
1223 strcpy(race_nextbestname, "");
1226 strcpy(race_nextbestname, newname);
1229 case RACE_NET_CHECKPOINT_HIT_RACE:
1230 race_mycheckpoint = ReadByte();
1231 race_mycheckpointtime = time;
1232 race_mycheckpointdelta = ReadInt24_t();
1233 race_mycheckpointlapsdelta = ReadByte();
1234 if(race_mycheckpointlapsdelta >= 128)
1235 race_mycheckpointlapsdelta -= 256;
1236 int who = ReadByte();
1238 strcpy(race_mycheckpointenemy, entcs_GetName(who - 1));
1240 strcpy(race_mycheckpointenemy, ""); // TODO: maybe string_null works fine here?
1243 case RACE_NET_CHECKPOINT_HIT_RACE_BY_OPPONENT:
1244 race_othercheckpoint = ReadByte();
1245 race_othercheckpointtime = time;
1246 race_othercheckpointdelta = ReadInt24_t();
1247 race_othercheckpointlapsdelta = ReadByte();
1248 if(race_othercheckpointlapsdelta >= 128)
1249 race_othercheckpointlapsdelta -= 256;
1250 int what = ReadByte();
1252 strcpy(race_othercheckpointenemy, entcs_GetName(what - 1));
1254 strcpy(race_othercheckpointenemy, ""); // TODO: maybe string_null works fine here?
1257 case RACE_NET_PENALTY_RACE:
1258 case RACE_NET_PENALTY_QUALIFYING:
1259 race_penaltyeventtime = time;
1260 race_penaltytime = ReadShort();
1261 string reason = ReadString();
1262 if (reason == "missing a checkpoint")
1263 reason = _("missing a checkpoint");
1264 strcpy(race_penaltyreason, reason);
1265 if (b == RACE_NET_PENALTY_QUALIFYING)
1266 race_penaltyaccumulator += race_penaltytime;
1269 case RACE_NET_SERVER_RECORD:
1270 race_server_record = ReadInt24_t();
1272 case RACE_NET_SPEED_AWARD:
1273 race_speedaward = ReadInt24_t();
1274 strcpy(race_speedaward_holder, ReadString());
1276 case RACE_NET_SPEED_AWARD_BEST:
1277 race_speedaward_alltimebest = ReadInt24_t();
1278 strcpy(race_speedaward_alltimebest_holder, ReadString());
1280 case RACE_NET_RANKINGS_CNT:
1281 RANKINGS_DISPLAY_CNT = ReadByte();
1283 case RACE_NET_SERVER_RANKINGS:
1285 int pos = ReadShort();
1286 prevpos = ReadShort();
1289 // move other rankings out of the way
1292 int m = min(prevpos, RANKINGS_DISPLAY_CNT);
1293 for (i=m-1; i>pos-1; --i) {
1294 grecordtime[i] = grecordtime[i-1];
1295 strcpy(grecordholder[i], grecordholder[i-1]);
1297 } else if (del) { // a record has been deleted by the admin
1298 for (i=pos-1; i<= RANKINGS_DISPLAY_CNT-1; ++i) {
1299 if (i == RANKINGS_DISPLAY_CNT-1) { // clear out last record
1301 strfree(grecordholder[i]);
1304 grecordtime[i] = grecordtime[i+1];
1305 strcpy(grecordholder[i], grecordholder[i+1]);
1308 } else { // player has no ranked record yet
1309 for (i=RANKINGS_DISPLAY_CNT-1;i>pos-1;--i) {
1310 grecordtime[i] = grecordtime[i-1];
1311 strcpy(grecordholder[i], grecordholder[i-1]);
1315 if (grecordtime[RANKINGS_DISPLAY_CNT]) {
1316 // kick off the player who fell from the last displayed position
1317 grecordtime[RANKINGS_DISPLAY_CNT] = 0;
1318 strfree(grecordholder[RANKINGS_DISPLAY_CNT]);
1321 // store new ranking
1322 strcpy(grecordholder[pos-1], ReadString());
1323 grecordtime[pos-1] = ReadInt24_t();
1324 if(strdecolorize(grecordholder[pos-1]) == strdecolorize(entcs_GetName(player_localnum)))
1327 case RACE_NET_SERVER_STATUS:
1328 race_status = ReadShort();
1329 strcpy(race_status_name, ReadString());
1334 NET_HANDLE(TE_CSQC_TEAMNAGGER, bool isNew)
1340 NET_HANDLE(TE_CSQC_PINGPLREPORT, bool isNew)
1343 int pi = ReadShort();
1344 int pl = ReadByte();
1345 int ml = ReadByte();
1347 entity e = playerslots[i];
1350 e.ping_packetloss = pl / 255.0;
1351 e.ping_movementloss = ml / 255.0;
1354 NET_HANDLE(TE_CSQC_WEAPONCOMPLAIN, bool isNew)
1356 int weapon_id = ReadByte();
1357 complain_weapon = REGISTRY_GET(Weapons, weapon_id);
1358 complain_weapon_type = ReadByte();
1361 complain_weapon_time = time;
1362 weapontime = time; // ping the weapon panel
1364 switch(complain_weapon_type)
1366 case 0: Local_Notification(MSG_MULTI, ITEM_WEAPON_NOAMMO, weapon_id); break;
1367 case 1: Local_Notification(MSG_MULTI, ITEM_WEAPON_DONTHAVE, weapon_id); break;
1368 default: Local_Notification(MSG_MULTI, ITEM_WEAPON_UNAVAILABLE, weapon_id); break;
1372 string translate_modifications(string s)
1374 return build_mutator_list(s);
1377 string translate_weaponarena(string s)
1379 if (s == "") return s;
1380 if (s == "All Weapons Arena") return _("All Weapons Arena");
1381 if (s == "All Available Weapons Arena") return _("All Available Weapons Arena");
1382 if (s == "Most Weapons Arena") return _("Most Weapons Arena");
1383 if (s == "Most Available Weapons Arena") return _("Most Available Weapons Arena");
1384 if (s == "Dev All Weapons Arena") return s; // development option, do not translate
1385 if (s == "Dev All Available Weapons Arena") return s; // development option, do not translate
1386 if (s == "No Weapons Arena") return _("No Weapons Arena");
1388 int n = tokenizebyseparator(s, " & ");
1389 string wpn_list = "";
1390 for (int i = 0; i < n; ++i)
1392 Weapon wep = Weapon_from_name(argv(i));
1393 if (wep == WEP_Null)
1394 LOG_INFO("^3Warning: ^7server sent an invalid weapon name\n");
1395 wpn_list = cons_mid(wpn_list, " & ", wep.m_name);
1398 return sprintf(_("%s Arena"), wpn_list);
1400 return _("No Weapons Arena");
1403 string GetVersionMessage(string hostversion, bool version_mismatch, bool version_check)
1405 string xonotic_hostversion = strcat("Xonotic ", hostversion);
1406 if (version_mismatch)
1409 return strcat(sprintf(_("This is %s"), xonotic_hostversion), "\n^3",
1410 _("Your client version is outdated."), "\n\n\n",
1411 _("### YOU WON'T BE ABLE TO PLAY ON THIS SERVER ###"), "\n\n\n",
1412 _("Please update!"));
1414 return strcat(sprintf(_("This is %s"), xonotic_hostversion), "\n^3",
1415 _("This server is using an outdated Xonotic version."), "\n\n\n",
1416 _("### THIS SERVER IS INCOMPATIBLE AND THUS YOU CANNOT JOIN ###"));
1418 return sprintf(_("Welcome to %s"), xonotic_hostversion);
1421 bool net_handle_ServerWelcome()
1423 int flags = ReadByte();
1425 campaign = flags & 1;
1428 int campaign_level = ReadByte();
1429 // Menu can't build the whole campaign message because it lacks getcommandkey and CCR
1430 // so we build part of the message here and let the menu insert the level description
1431 // (that client doesn't know) by replacing the keyword _LEVEL_DESC
1432 string key = getcommandkey(_("jump"), "+jump");
1433 string msg = strcat(
1434 CCR("^F1"), sprintf(_("Level %d:"), campaign_level),
1435 sprintf(CCR(" ^BG%s\n\n"), "_LEVEL_DESC"),
1436 sprintf(CCR(_("^BGPress ^F2%s^BG to enter the game")), key));
1437 msg = MakeConsoleSafe(strreplace("\n", "\\n", msg));
1438 string welcomedialog_args = strcat("CAMPAIGN ", itos(campaign_level), " \"", msg, "\"");
1440 localcmd("\nmenu_cmd directmenu Welcome ", welcomedialog_args, "\n");
1444 strcpy(hostname, ReadString());
1445 string hostversion = ReadString();
1446 bool version_mismatch = flags & 2;
1447 bool version_check = flags & 4;
1448 MapInfo_Map_titlestring = ReadString();
1449 MapInfo_Map_author = flags & 8 ? ReadString() : "";
1450 srv_minplayers = ReadByte();
1451 srv_maxplayers = ReadByte();
1452 string modifications = translate_modifications(ReadString());
1453 string weaponarena_list = translate_weaponarena(ReadString());
1454 string cache_mutatormsg = ReadString();
1455 string motd = ReadString();
1457 string msg = GetVersionMessage(hostversion, version_mismatch, version_check);
1459 msg = strcat(msg, "\n\n", _("Gametype:"), " ^1", MapInfo_Type_ToText(gametype), "\n");
1461 msg = strcat(msg, "\n", _("Map:"), " ", MapInfo_Map_titlestring, "\n");
1463 msg = strcat(msg, "^9", _("by:"), " ", MapInfo_Map_author, "\n");
1465 if (srv_minplayers || srv_maxplayers)
1467 msg = strcat(msg, "\n", _("This match supports"), " ^5");
1468 if (srv_minplayers == srv_maxplayers)
1469 msg = strcat(msg, sprintf(_("%d players"), srv_maxplayers), "\n");
1470 else if (srv_minplayers && srv_maxplayers)
1471 msg = strcat(msg, sprintf(_("%d to %d players"), srv_minplayers, srv_maxplayers), "\n");
1472 else if (srv_maxplayers)
1473 msg = strcat(msg, sprintf(_("%d players maximum"), srv_maxplayers), "\n");
1475 msg = strcat(msg, sprintf(_("%d players minimum"), srv_minplayers), "\n");
1478 modifications = cons_mid(modifications, ", ", weaponarena_list);
1479 if(modifications != "")
1480 msg = strcat(msg, "\n", _("Active modifications:"), " ^3", modifications, "\n");
1482 if (cache_mutatormsg != "")
1483 msg = strcat(msg, "\n", _("Special gameplay tips:"), " ^7", cache_mutatormsg, "\n");
1484 string mutator_msg = "";
1485 MUTATOR_CALLHOOK(BuildGameplayTipsString, mutator_msg);
1486 mutator_msg = M_ARGV(0, string);
1487 msg = strcat(msg, mutator_msg); // trust that the mutator will do proper formatting
1490 msg = strcat(msg, "\n^9↓ ", _("Server's message"), " ↓\n", motd);
1492 strcpy(welcome_msg, msg);
1493 welcome_msg_menu_check_maxtime = time + 1; // wait for menu to load before showing the welcome dialog
1497 void Welcome_Message_Show_Try()
1499 if (!welcome_msg_menu_check_maxtime)
1502 // if want dialog check if menu is initialized but for a short time
1503 if (cvar("_menu_initialized") == 2 || time > welcome_msg_menu_check_maxtime)
1505 if (cvar("_menu_welcome_dialog_available"))
1507 string welcomedialog_args = strcat("HOSTNAME \"", hostname, "\"");
1508 string msg = MakeConsoleSafe(strreplace("\n", "\\n", welcome_msg));
1509 welcomedialog_args = strcat(welcomedialog_args, " WELCOME \"", msg, "\"");
1511 if (intermission || isdemo() || !autocvar_cl_welcome)
1513 if (cvar("_menu_cmd_closemenu_available"))
1515 // initialize the dialog without opening it
1516 localcmd("\nmenu_cmd closemenu Welcome ", welcomedialog_args, "\n");
1520 // legacy code for clients with old menus
1521 // since togglemenu 0 doesn't close the dialog but only hides it,
1522 // playing back a demo the Welcome dialog will pop up on the first ESC press
1523 localcmd("\nmenu_cmd directmenu Welcome ", welcomedialog_args, "\n");
1524 // close it after it's been initialized so it can still be opened manually
1525 localcmd("\ntogglemenu 0\n");
1529 localcmd("\nmenu_cmd directmenu Welcome ", welcomedialog_args, "\n");
1532 strfree(welcome_msg);
1533 welcome_msg_menu_check_maxtime = 0;
1537 NET_HANDLE(TE_CSQC_SERVERWELCOME, bool isNew)
1539 return net_handle_ServerWelcome();
1542 string _getcommandkey(string cmd_name, string command, bool forcename)
1545 float n, j, k, l = 0;
1547 if (!autocvar_hud_showbinds)
1550 keys = db_get(binddb, command);
1553 bool joy_active = cvar("joy_active");
1554 n = tokenize(findkeysforcommand(command, 0)); // uses '...' strings
1555 for(j = 0; j < n; ++j)
1560 string key = keynumtostring(k);
1561 if(!joy_active && substring(key, 0, 3) == "JOY")
1564 key = translate_key(key);
1569 keys = strcat(keys, ", ", key);
1572 if (autocvar_hud_showbinds_limit > 0 && autocvar_hud_showbinds_limit <= l)
1579 db_put(binddb, command, keys);
1582 if (keys == "NO_KEY") {
1583 if (autocvar_hud_showbinds > 1)
1584 return sprintf(_("%s (not bound)"), cmd_name);
1588 else if (autocvar_hud_showbinds > 1 || forcename)
1589 return sprintf("%s (%s)", cmd_name, keys);
1594 /** engine callback */
1595 void URI_Get_Callback(int id, int status, string data)
1597 TC(int, id); TC(int, status);
1598 if(url_URI_Get_Callback(id, status, data))
1602 else if (id == URI_GET_DISCARD)
1606 else if (id >= URI_GET_CURL && id <= URI_GET_CURL_END)
1609 Curl_URI_Get_Callback(id, status, data);
1613 LOG_INFOF("Received HTTP request data for an invalid id %d.", id);