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");
101 registercvar("cl_chat_sounds", "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 deactivate_minigame();
202 HUD_MinigameMenu_Close(NULL, NULL, NULL);
204 ReplicateVars(REPLICATEVARS_DESTROY);
213 for(e = prev.sort_next; e; prev = e, e = e.sort_next)
215 if(prev != e.sort_prev)
216 error(strcat("sort list chain error\nplease submit the output of 'prvm_edicts client' to the developers"));
220 for(e = prev.sort_next; e; prev = e, e = e.sort_next)
222 if(prev != e.sort_prev)
223 error(strcat("sort list chain error\nplease submit the output of 'prvm_edicts client' to the developers"));
227 float RegisterPlayer(entity player)
231 for(pl = players.sort_next; pl; pl = pl.sort_next)
233 error("Player already registered!");
234 player.sort_next = players.sort_next;
235 player.sort_prev = players;
236 if(players.sort_next)
237 players.sort_next.sort_prev = player;
238 players.sort_next = player;
243 void RemovePlayer(entity player)
248 for(pl = players.sort_next; pl && pl != player; pl = pl.sort_next)
253 error("Trying to remove a player which is not in the playerlist!");
256 parent.sort_next = player.sort_next;
258 player.sort_next.sort_prev = parent;
262 void MoveToLast(entity e)
265 entity ent = e.sort_next;
274 float RegisterTeam(entity Team)
276 assert_once(Team.team, eprint(Team));
279 for(tm = teams.sort_next; tm; tm = tm.sort_next)
281 error("Team already registered!");
282 Team.sort_next = teams.sort_next;
283 Team.sort_prev = teams;
285 teams.sort_next.sort_prev = Team;
286 teams.sort_next = Team;
287 if(Team.team && Team.team != NUM_SPECTATOR)
293 void RemoveTeam(entity Team)
298 for(tm = teams.sort_next; tm && tm != Team; tm = tm.sort_next)
303 LOG_INFO(_("Trying to remove a team which is not in the teamlist!"));
306 parent.sort_next = Team.sort_next;
308 Team.sort_next.sort_prev = parent;
309 if(Team.team && Team.team != NUM_SPECTATOR)
314 entity GetTeam(int Team, bool add)
316 TC(int, Team); TC(bool, add);
317 int num = (Team == NUM_SPECTATOR) ? 16 : Team;
319 return teamslots[num];
322 entity tm = new_pure(team);
330 bool SetTeam(entity o, int Team)
333 //devassert_once(Team);
346 if(GetTeam(Team, false) == NULL)
348 LOG_TRACEF("trying to switch to unsupported team %d", Team);
349 Team = NUM_SPECTATOR;
362 if(GetTeam(Team, false) == NULL)
364 LOG_TRACEF("trying to switch to unsupported team %d", Team);
365 Team = NUM_SPECTATOR;
370 if(Team == -1) // leave
374 tm = GetTeam(o.team, false);
385 tm = GetTeam(Team, true);
390 else if(Team != o.team)
392 tm = GetTeam(o.team, false);
395 tm = GetTeam(Team, true);
403 void Playerchecker_Think(entity this)
407 for(i = 0; i < maxclients; ++i)
410 if(entcs_GetName(i) == "")
414 // player disconnected
428 playerslots[i] = e = new_pure(playerslot);
432 e.ping_packetloss = 0;
433 e.ping_movementloss = 0;
434 //e.gotscores = 0; // we might already have the scores...
435 int t = entcs_GetScoreTeam(i);
436 if (t) SetTeam(e, t); // will not hurt; later updates come with Scoreboard_UpdatePlayerTeams
438 Scoreboard_UpdatePlayerPos(e);
442 this.nextthink = time + 0.2;
447 entity playerchecker = new_pure(playerchecker);
448 setthink(playerchecker, Playerchecker_Think);
449 playerchecker.nextthink = time + 0.2;
453 // this can't be called in CSQC_Init as it'd send cvars too early
454 ReplicateVars_Start();
459 void Release_Common_Keys()
462 localcmd("-fire2\n");
468 // CSQC_InputEvent : Used to perform actions based on any key pressed, key released and mouse on the client.
469 // Return value should be 1 if CSQC handled the input, otherwise return 0 to have the input passed to the engine.
470 // All keys are in ascii.
471 // bInputType = 0 is key pressed, 1 is key released, 2 and 3 are mouse input.
472 // In the case of keyboard input, nPrimary is the ascii code, and nSecondary is 0.
473 // In the case of mouse input, nPrimary is xdelta, nSecondary is ydelta.
474 // In the case of mouse input after a setcursormode(1) call, nPrimary is xpos, nSecondary is ypos.
475 float CSQC_InputEvent(int bInputType, float nPrimary, float nSecondary)
478 bool override = false;
480 override |= HUD_Scoreboard_InputEvent(bInputType, nPrimary, nSecondary);
484 override |= HUD_Panel_InputEvent(bInputType, nPrimary, nSecondary);
488 override |= HUD_Panel_Chat_InputEvent(bInputType, nPrimary, nSecondary);
490 override |= QuickMenu_InputEvent(bInputType, nPrimary, nSecondary);
492 override |= HUD_Radar_InputEvent(bInputType, nPrimary, nSecondary);
494 override |= MapVote_InputEvent(bInputType, nPrimary, nSecondary);
496 override |= HUD_Minigame_InputEvent(bInputType, nPrimary, nSecondary);
501 if(bInputType == 3 || bInputType == 2)
504 // at this point bInputType can only be 0 or 1 (key pressed or released)
505 bool key_pressed = (bInputType == 0);
508 if(nPrimary == K_ALT) hudShiftState |= S_ALT;
509 if(nPrimary == K_CTRL) hudShiftState |= S_CTRL;
510 if(nPrimary == K_SHIFT) hudShiftState |= S_SHIFT;
511 if(nPrimary == K_TAB) hudShiftState |= S_TAB;
514 if(nPrimary == K_ALT) hudShiftState -= (hudShiftState & S_ALT);
515 if(nPrimary == K_CTRL) hudShiftState -= (hudShiftState & S_CTRL);
516 if(nPrimary == K_SHIFT) hudShiftState -= (hudShiftState & S_SHIFT);
517 if(nPrimary == K_TAB) hudShiftState -= (hudShiftState & S_TAB);
520 // NOTE: Shift-Escape must be filtered out because it's the hardcoded console shortcut
521 if (nPrimary == K_ESCAPE && !(hudShiftState & S_SHIFT) && key_pressed)
523 if (hudShiftState & S_TAB)
525 Scoreboard_UI_Enable(0);
528 if (!isdemo() && cvar("_menu_gamemenu_dialog_available"))
530 localcmd("\nmenu_showgamemenudialog\n");
538 // END REQUIRED CSQC FUNCTIONS
539 // --------------------------------------------------------------------------
541 // --------------------------------------------------------------------------
542 // BEGIN OPTIONAL CSQC FUNCTIONS
544 void Ent_RemovePlayerScore(entity this)
547 SetTeam(this.owner, -1);
548 this.owner.gotscores = 0;
549 FOREACH(Scores, true, {
550 this.owner.(scores(it)) = 0; // clear all scores
555 NET_HANDLE(ENT_CLIENT_SCORES, bool isnew)
560 // damnit -.- don't want to go change every single .sv_entnum in hud.qc AGAIN
561 // (no I've never heard of M-x replace-string, sed, or anything like that)
562 bool isNew = !this.owner; // workaround for DP bug
563 int n = ReadByte()-1;
565 #ifdef DP_CSQC_ENTITY_REMOVE_IS_B0RKED
566 if(!isNew && n != this.sv_entnum)
568 //print("A CSQC entity changed its owner!\n");
569 LOG_INFOF("A CSQC entity changed its owner! (edict: %d, classname: %s)", etof(this), this.classname);
577 o = playerslots[this.sv_entnum];
580 o = playerslots[this.sv_entnum] = new_pure(playerslot);
583 o.sv_entnum = this.sv_entnum;
587 // RegisterPlayer(o);
588 //playerchecker will do this for us later, if it has not already done so
590 int sf = ReadShort();
591 int lf = ReadShort();
592 FOREACH(Scores, true, {
593 int p = 1 << (i % 16);
597 o.(scores(it)) = ReadInt24_t();
599 o.(scores(it)) = ReadChar();
606 Scoreboard_UpdatePlayerPos(o); // if not registered, we cannot do this yet!
608 this.entremove = Ent_RemovePlayerScore;
611 NET_HANDLE(ENT_CLIENT_TEAMSCORES, bool isnew)
616 this.team = ReadByte();
617 entity o = this.owner = GetTeam(this.team, true); // these team numbers can always be trusted
619 #if MAX_TEAMSCORE <= 8
623 int sf = ReadShort();
624 int lf = ReadShort();
626 for(i = 0; i < MAX_TEAMSCORE; ++i)
630 o.(teamscores(i)) = ReadInt24_t();
632 o.(teamscores(i)) = ReadChar();
637 Scoreboard_UpdateTeamPos(o);
640 NET_HANDLE(ENT_CLIENT_CLIENTDATA, bool isnew)
643 float newspectatee_status;
647 scoreboard_showscores_force = (f & BIT(0));
651 newspectatee_status = ReadByte();
652 if(newspectatee_status == player_localnum + 1)
653 newspectatee_status = -1; // observing
656 newspectatee_status = 0;
658 spectatorbutton_zoom = (f & BIT(2));
659 observe_blocked = (f & BIT(3));
663 num_spectators = ReadByte();
667 for(i = 0; i < MAX_SPECTATORS; ++i)
668 spectatorlist[i] = 0; // reset list first
670 int limit = min(num_spectators, MAX_SPECTATORS);
671 for(i = 0; i < limit; ++i)
674 spectatorlist[i] = slot - 1;
679 for(int j = 0; j < MAX_SPECTATORS; ++j)
680 spectatorlist[j] = 0; // reset list if showspectators has been turned off
686 if(newspectatee_status != spectatee_status)
690 race_checkpointtime = 0;
691 hud_dynamic_shake_factor = -1;
692 spectatee_status_changed_time = time;
694 if (autocvar_hud_panel_healtharmor_progressbar_gfx)
696 if ( (spectatee_status == -1 && newspectatee_status > 0) //before observing, now spectating
697 || (spectatee_status > 0 && newspectatee_status > 0 && spectatee_status != newspectatee_status) //changed spectated player
700 else if(spectatee_status && !newspectatee_status) //before observing/spectating, now playing
703 spectatee_status = newspectatee_status;
705 // we could get rid of spectatee_status, and derive it from player_localentnum and player_localnum
708 NET_HANDLE(ENT_CLIENT_NAGGER, bool isnew)
713 int nags = ReadByte(); // NAGS NAGS NAGS NAGS NAGS NAGS NADZ NAGS NAGS NAGS
717 strfree(vote_called_vote);
727 vote_yescount = ReadByte();
728 vote_nocount = ReadByte();
729 vote_needed = ReadByte();
730 vote_highlighted = ReadChar();
735 strcpy(vote_called_vote, ReadString());
740 for(j = 0; j < maxclients; ++j)
742 playerslots[j].ready = true;
743 for(i = 1; i <= maxclients; i += 8)
746 for(j = i-1, b = BIT(0); b < BIT(8); b <<= 1, ++j)
749 playerslots[j].ready = false;
755 ready_waiting = (nags & BIT(0));
756 ready_waiting_for_me = (nags & BIT(1));
757 vote_waiting = (nags & BIT(2));
758 vote_waiting_for_me = (nags & BIT(3));
759 warmup_stage = (nags & BIT(4));
762 NET_HANDLE(ENT_CLIENT_ELIMINATEDPLAYERS, bool isnew)
766 serialize(byte, 0, sf);
768 for (int j = 0; j < maxclients; ++j) {
769 if (playerslots[j]) {
770 playerslots[j].eliminated = true;
773 for (int i = 1; i <= maxclients; i += 8) {
775 serialize(byte, 0, f);
776 for (int b = 0; b < 8; ++b) {
777 if (f & BIT(b)) continue;
779 if (playerslots[j]) {
780 playerslots[j].eliminated = false;
788 NET_HANDLE(ENT_CLIENT_RANDOMSEED, bool isnew)
792 float s = ReadShort();
797 NET_HANDLE(ENT_CLIENT_ACCURACY, bool isnew)
800 float entnum = ReadByte();
802 int sf = ReadInt24_t();
804 for (int w = 0; w <= WEP_LAST - WEP_FIRST; ++w)
805 weapon_accuracy[w] = -1;
810 for (int w = 0; w <= WEP_LAST - WEP_FIRST; ++w) {
813 playerslots[entnum-1].accuracy_frags[w] = ReadByte();
814 playerslots[entnum-1].accuracy_hit[w] = ReadShort();
815 playerslots[entnum-1].accuracy_cnt_hit[w] = ReadShort();
816 playerslots[entnum-1].accuracy_cnt_fired[w] = ReadShort();
818 //LOG_INFOF("Duel stats ?/%d", playerslots[entnum-1].accuracy_cnt_fired[w]);
822 weapon_accuracy[w] = -1;
824 weapon_accuracy[w] = 1.0; // no better error handling yet, sorry
826 weapon_accuracy[w] = (b - 1.0) / 100.0;
829 f = (f == 0x800000) ? 1 : f * 2;
834 void Spawn_Draw(entity this)
836 bool dodraw = autocvar_cl_spawn_point_particles;
837 if(dodraw && autocvar_cl_spawn_point_dist_max)
839 vector org = getpropertyvec(VF_ORIGIN);
840 dodraw = vdist(org - this.origin, <, autocvar_cl_spawn_point_dist_max);
844 pointparticles(((!teamplay) ? EFFECT_SPAWNPOINT_NEUTRAL : EFFECT_SPAWNPOINT(this.team - 1)), this.origin + '0 0 28', '0 0 2', bound(0, frametime, 0.1));
847 NET_HANDLE(ENT_CLIENT_SPAWNPOINT, bool is_new)
849 float teamnum = (ReadByte() - 1);
850 vector spn_origin = ReadVector();
852 this.team = (teamnum + 1);
856 this.origin = spn_origin;
857 setsize(this, PL_MIN_CONST, PL_MAX_CONST);
860 /*if(autocvar_cl_spawn_point_model) // needs a model first
862 this.mdl = "models/spawnpoint.md3";
863 this.colormod = Team_ColorRGB(teamnum);
864 precache_model(this.mdl);
865 setmodel(this, this.mdl);
866 this.drawmask = MASK_NORMAL;
867 //this.move_movetype = MOVETYPE_NOCLIP;
868 //this.draw = Spawn_Draw;
869 IL_PUSH(g_drawables, this);
871 this.draw = Spawn_Draw;
872 if (is_new) IL_PUSH(g_drawables, this);
875 //printf("Ent_ReadSpawnPoint(is_new = %d); origin = %s, team = %d, effect = %d\n", is_new, vtos(this.origin), teamnum, this.cnt);
879 NET_HANDLE(ENT_CLIENT_SPAWNEVENT, bool is_new)
881 // If entnum is 0, ONLY do the local spawn actions
882 // this way the server can disable the sending of
883 // spawn origin or such to clients if wanted.
884 float entnum = ReadByte();
888 this.origin = ReadVector();
892 float teamnum = entcs_GetTeam(entnum - 1);
894 if(autocvar_cl_spawn_event_particles)
898 case NUM_TEAM_1: pointparticles(EFFECT_SPAWN_RED, this.origin, '0 0 0', 1); break;
899 case NUM_TEAM_2: pointparticles(EFFECT_SPAWN_BLUE, this.origin, '0 0 0', 1); break;
900 case NUM_TEAM_3: pointparticles(EFFECT_SPAWN_YELLOW, this.origin, '0 0 0', 1); break;
901 case NUM_TEAM_4: pointparticles(EFFECT_SPAWN_PINK, this.origin, '0 0 0', 1); break;
902 default: pointparticles(EFFECT_SPAWN_NEUTRAL, this.origin, '0 0 0', 1); break;
905 if(autocvar_cl_spawn_event_sound)
907 sound(this, CH_TRIGGER, SND_SPAWN, VOL_BASE, ATTEN_NORM);
913 // local spawn actions
914 if(is_new && (!entnum || (entnum == player_localentnum)))
916 if(autocvar_cl_spawnzoom && !autocvar_cl_lockview)
919 current_viewzoom = (1 / bound(1, autocvar_cl_spawnzoom_factor, 16));
922 if(autocvar_cl_unpress_zoom_on_spawn)
927 HUD_Radar_Hide_Maximized();
929 //printf("Ent_ReadSpawnEvent(is_new = %d); origin = %s, entnum = %d, localentnum = %d\n", is_new, vtos(this.origin), entnum, player_localentnum);
932 // CSQC_Ent_Update : Called every frame that the server has indicated an update to the SSQC / CSQC entity has occured.
933 // The parameter isnew reflects if the entity is "new" to the client, meaning it just came into the client's PVS.
934 void CSQC_Ent_Update(entity this, bool isnew)
936 this.sourceLoc = __FILE__":"STR(__LINE__);
939 // set up the "time" global for received entities to be correct for interpolation purposes
940 float savetime = time;
947 serverprevtime = time;
948 serverdeltatime = STAT(MOVEVARS_TICRATE) * STAT(MOVEVARS_TIMESCALE);
949 time = serverprevtime + serverdeltatime;
952 #ifdef DP_CSQC_ENTITY_REMOVE_IS_B0RKED
955 if (t != this.enttype || isnew)
957 LOG_INFOF("A CSQC entity changed its type! (edict: %d, server: %d, type: %d -> %d)", etof(this), this.entnum, this.enttype, t);
968 LOG_INFOF("A CSQC entity appeared out of nowhere! (edict: %d, server: %d, type: %d)", etof(this), this.entnum, t);
975 FOREACH(LinkedEntities, it.m_id == t, {
976 if (isnew) this.classname = it.netname;
977 if (autocvar_developer_csqcentities)
978 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);
979 done = it.m_read(this, NULL, isnew);
980 MUTATOR_CALLHOOK(Ent_Update, this, isnew);
986 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);
990 // Destructor, but does NOT deallocate the entity by calling remove(). Also
991 // used when an entity changes its type. For an entity that someone interacts
992 // with others, make sure it can no longer do so.
993 void Ent_Remove(entity this)
995 if(this.entremove) this.entremove(this);
997 if(this.skeletonindex)
999 skel_delete(this.skeletonindex);
1000 this.skeletonindex = 0;
1003 if(this.snd_looping > 0)
1005 sound(this, this.snd_looping, SND_Null, VOL_BASE, autocvar_cl_jetpack_attenuation);
1006 this.snd_looping = 0;
1010 this.classname = "";
1011 this.draw = func_null;
1012 this.entremove = func_null;
1013 // TODO possibly set more stuff to defaults
1015 // CSQC_Ent_Remove : Called when the server requests a SSQC / CSQC entity to be removed. Essentially call remove(this) as well.
1016 void CSQC_Ent_Remove(entity this)
1018 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Ent_Remove() with this=%i {.entnum=%d, .enttype=%d}", this, this.entnum, this.enttype);
1021 LOG_WARN("CSQC_Ent_Remove called for already removed entity. Packet loss?");
1024 if (this.enttype) Ent_Remove(this);
1028 void Gamemode_Init()
1032 if(!(calledhooks & HOOK_START))
1033 localcmd("\n_cl_hook_gamestart ", MapInfo_Type_ToString(gametype), "\n");
1034 calledhooks |= HOOK_START;
1037 // 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.
1038 void CSQC_Parse_StuffCmd(string strMessage)
1040 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_StuffCmd(\"%s\")", strMessage);
1041 localcmd(strMessage);
1043 // 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.
1044 void CSQC_Parse_Print(string strMessage)
1046 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_Print(\"%s\")", strMessage);
1047 print(ColorTranslateRGB(strMessage));
1050 // CSQC_Parse_CenterPrint : Provides the centerprint_AddStandard string in the first parameter that the server provided.
1051 void CSQC_Parse_CenterPrint(string strMessage)
1053 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_CenterPrint(\"%s\")", strMessage);
1054 centerprint_AddStandard(strMessage);
1057 // CSQC_Parse_TempEntity : Handles all temporary entity network data in the CSQC layer.
1058 // You must ALWAYS first acquire the temporary ID, which is sent as a byte.
1059 // Return value should be 1 if CSQC handled the temporary entity, otherwise return 0 to have the engine process the event.
1060 bool CSQC_Parse_TempEntity()
1063 int nTEID = ReadByte();
1065 FOREACH(TempEntities, it.m_id == nTEID, {
1066 if (autocvar_developer_csqcentities)
1067 LOG_INFOF("CSQC_Parse_TempEntity() nTEID=%s (%d)", it.netname, nTEID);
1068 return it.m_read(NULL, NULL, true);
1071 if (autocvar_developer_csqcentities)
1072 LOG_INFOF("CSQC_Parse_TempEntity() with nTEID=%d", nTEID);
1074 // No special logic for this temporary entity; return 0 so the engine can handle it
1081 if (autocvar_cl_orthoview && autocvar_cl_orthoview_nofog)
1082 localcmd("\nr_drawfog 0\n");
1083 else if (forcefog != "")
1084 localcmd(sprintf("\nfog %s\nr_fog_exp2 0\nr_drawfog 1\n", forcefog));
1087 bool net_handle_ServerWelcome();
1088 NET_HANDLE(ENT_CLIENT_SCORES_INFO, bool isnew)
1091 gametype = ReadRegistered(Gametypes);
1092 teamplay = _MapInfo_GetTeamPlayBool(gametype);
1093 HUD_ModIcons_SetFunc();
1094 FOREACH(Scores, true, {
1095 strcpy(scores_label(it), ReadString());
1096 scores_flags(it) = ReadByte();
1098 for (int i = 0; i < MAX_TEAMSCORE; ++i)
1100 strcpy(teamscores_label(i), ReadString());
1101 teamscores_flags(i) = ReadByte();
1103 bool welcome_msg_too = ReadByte();
1104 if (welcome_msg_too)
1105 net_handle_ServerWelcome();
1107 Scoreboard_InitScores();
1111 NET_HANDLE(ENT_CLIENT_INIT, bool isnew)
1113 nb_pb_period = ReadByte() / 32; //Accuracy of 1/32th
1115 hook_shotorigin[0] = decompressShotOrigin(ReadInt24_t());
1116 hook_shotorigin[1] = decompressShotOrigin(ReadInt24_t());
1117 hook_shotorigin[2] = decompressShotOrigin(ReadInt24_t());
1118 hook_shotorigin[3] = decompressShotOrigin(ReadInt24_t());
1119 arc_shotorigin[0] = decompressShotOrigin(ReadInt24_t());
1120 arc_shotorigin[1] = decompressShotOrigin(ReadInt24_t());
1121 arc_shotorigin[2] = decompressShotOrigin(ReadInt24_t());
1122 arc_shotorigin[3] = decompressShotOrigin(ReadInt24_t());
1124 strcpy(forcefog, ReadString());
1126 armorblockpercent = ReadByte() / 255.0;
1127 damagepush_speedfactor = ReadByte() / 255.0;
1129 serverflags = ReadByte();
1131 g_trueaim_minrange = ReadCoord();
1133 strcpy(hostname_full, ReadString());
1134 strcpy(motd_permanent, ReadString());
1136 sv_timer_countdown = ReadByte();
1140 MUTATOR_CALLHOOK(Ent_Init);
1142 if (!postinit) PostInit();
1145 NET_HANDLE(TE_CSQC_TEAMNAMES, bool isNew)
1147 teamname_red = strzone(ReadString());
1148 teamname_blue = strzone(ReadString());
1149 teamname_yellow = strzone(ReadString());
1150 teamname_pink = strzone(ReadString());
1155 NET_HANDLE(TE_CSQC_CHATSOUND, bool isNew)
1157 string snd = ReadString();
1158 snd = strcat("chat/", snd, ".ogg");
1160 precache_sound(snd);
1161 _sound(NULL, CH_INFO, snd, VOL_BASE, ATTN_NONE);
1166 float GetSpeedUnitFactor(int speed_unit)
1172 case 2: return 0.0254;
1173 case 3: return 0.0254 * 3.6;
1174 case 4: return 0.0254 * 3.6 * 0.6213711922;
1175 case 5: return 0.0254 * 1.943844492; // 1 m/s = 1.943844492 knots, because 1 knot = 1.852 km/h
1179 string GetSpeedUnit(int speed_unit)
1183 // translator-friendly strings without the initial space
1185 case 1: return strcat(" ", _("qu/s"));
1186 case 2: return strcat(" ", _("m/s"));
1187 case 3: return strcat(" ", _("km/h"));
1188 case 4: return strcat(" ", _("mph"));
1189 case 5: return strcat(" ", _("knots"));
1193 NET_HANDLE(TE_CSQC_RACE, bool isNew)
1199 case RACE_NET_CHECKPOINT_HIT_QUALIFYING:
1200 race_checkpoint = ReadByte();
1201 race_time = ReadInt24_t();
1202 race_previousbesttime = ReadInt24_t();
1203 race_mypreviousbesttime = ReadInt24_t();
1204 string pbestname = ReadString();
1205 if(autocvar_cl_race_cptimes_onlyself)
1207 race_previousbesttime = race_mypreviousbesttime;
1208 race_mypreviousbesttime = 0;
1209 strcpy(race_previousbestname, "");
1212 strcpy(race_previousbestname, pbestname);
1214 race_checkpointtime = time;
1216 if(race_checkpoint == 0 || race_checkpoint == 254)
1218 race_penaltyaccumulator = 0;
1219 race_laptime = time; // valid
1223 case RACE_NET_CHECKPOINT_CLEAR:
1225 race_checkpointtime = 0;
1228 case RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING:
1229 race_laptime = ReadCoord();
1230 race_checkpointtime = -99999;
1232 case RACE_NET_CHECKPOINT_NEXT_QUALIFYING:
1233 race_nextcheckpoint = ReadByte();
1235 race_nextbesttime = ReadInt24_t();
1236 if(b != RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING) // not while spectating (matches server)
1237 race_mybesttime = ReadInt24_t();
1238 string newname = ReadString();
1239 if(autocvar_cl_race_cptimes_onlyself && b != RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING)
1241 race_nextbesttime = race_mybesttime;
1242 race_mybesttime = 0;
1243 strcpy(race_nextbestname, "");
1246 strcpy(race_nextbestname, newname);
1249 case RACE_NET_CHECKPOINT_HIT_RACE:
1250 race_mycheckpoint = ReadByte();
1251 race_mycheckpointtime = time;
1252 race_mycheckpointdelta = ReadInt24_t();
1253 race_mycheckpointlapsdelta = ReadByte();
1254 if(race_mycheckpointlapsdelta >= 128)
1255 race_mycheckpointlapsdelta -= 256;
1256 int who = ReadByte();
1258 strcpy(race_mycheckpointenemy, entcs_GetName(who - 1));
1260 strcpy(race_mycheckpointenemy, ""); // TODO: maybe string_null works fine here?
1263 case RACE_NET_CHECKPOINT_HIT_RACE_BY_OPPONENT:
1264 race_othercheckpoint = ReadByte();
1265 race_othercheckpointtime = time;
1266 race_othercheckpointdelta = ReadInt24_t();
1267 race_othercheckpointlapsdelta = ReadByte();
1268 if(race_othercheckpointlapsdelta >= 128)
1269 race_othercheckpointlapsdelta -= 256;
1270 int what = ReadByte();
1272 strcpy(race_othercheckpointenemy, entcs_GetName(what - 1));
1274 strcpy(race_othercheckpointenemy, ""); // TODO: maybe string_null works fine here?
1277 case RACE_NET_PENALTY_RACE:
1278 case RACE_NET_PENALTY_QUALIFYING:
1279 race_penaltyeventtime = time;
1280 race_penaltytime = ReadShort();
1281 string reason = ReadString();
1282 if (reason == "missing a checkpoint")
1283 reason = _("missing a checkpoint");
1284 strcpy(race_penaltyreason, reason);
1285 if (b == RACE_NET_PENALTY_QUALIFYING)
1286 race_penaltyaccumulator += race_penaltytime;
1289 case RACE_NET_SERVER_RECORD:
1290 race_server_record = ReadInt24_t();
1292 case RACE_NET_SPEED_AWARD:
1293 race_speedaward = ReadInt24_t() * GetSpeedUnitFactor(autocvar_hud_panel_physics_speed_unit);
1294 strcpy(race_speedaward_holder, ReadString());
1296 case RACE_NET_SPEED_AWARD_BEST:
1297 race_speedaward_alltimebest = ReadInt24_t() * GetSpeedUnitFactor(autocvar_hud_panel_physics_speed_unit);
1298 strcpy(race_speedaward_alltimebest_holder, ReadString());
1300 case RACE_NET_RANKINGS_CNT:
1301 RANKINGS_DISPLAY_CNT = ReadByte();
1303 case RACE_NET_SERVER_RANKINGS:
1305 int pos = ReadShort();
1306 prevpos = ReadShort();
1309 // move other rankings out of the way
1312 int m = min(prevpos, RANKINGS_DISPLAY_CNT);
1313 for (i=m-1; i>pos-1; --i) {
1314 grecordtime[i] = grecordtime[i-1];
1315 strcpy(grecordholder[i], grecordholder[i-1]);
1317 } else if (del) { // a record has been deleted by the admin
1318 for (i=pos-1; i<= RANKINGS_DISPLAY_CNT-1; ++i) {
1319 if (i == RANKINGS_DISPLAY_CNT-1) { // clear out last record
1321 strfree(grecordholder[i]);
1324 grecordtime[i] = grecordtime[i+1];
1325 strcpy(grecordholder[i], grecordholder[i+1]);
1328 } else { // player has no ranked record yet
1329 for (i=RANKINGS_DISPLAY_CNT-1;i>pos-1;--i) {
1330 grecordtime[i] = grecordtime[i-1];
1331 strcpy(grecordholder[i], grecordholder[i-1]);
1335 if (grecordtime[RANKINGS_DISPLAY_CNT]) {
1336 // kick off the player who fell from the last displayed position
1337 grecordtime[RANKINGS_DISPLAY_CNT] = 0;
1338 strfree(grecordholder[RANKINGS_DISPLAY_CNT]);
1341 // store new ranking
1342 strcpy(grecordholder[pos-1], ReadString());
1343 grecordtime[pos-1] = ReadInt24_t();
1344 if(strdecolorize(grecordholder[pos-1]) == strdecolorize(entcs_GetName(player_localnum)))
1347 case RACE_NET_SERVER_STATUS:
1348 race_status = ReadShort();
1349 strcpy(race_status_name, ReadString());
1354 NET_HANDLE(TE_CSQC_TEAMNAGGER, bool isNew)
1360 NET_HANDLE(TE_CSQC_PINGPLREPORT, bool isNew)
1363 int pi = ReadShort();
1364 int pl = ReadByte();
1365 int ml = ReadByte();
1367 entity e = playerslots[i];
1370 e.ping_packetloss = pl / 255.0;
1371 e.ping_movementloss = ml / 255.0;
1374 NET_HANDLE(TE_CSQC_WEAPONCOMPLAIN, bool isNew)
1376 int weapon_id = ReadByte();
1377 complain_weapon = REGISTRY_GET(Weapons, weapon_id);
1378 complain_weapon_type = ReadByte();
1381 complain_weapon_time = time;
1382 weapontime = time; // ping the weapon panel
1384 switch(complain_weapon_type)
1386 case 0: Local_Notification(MSG_MULTI, ITEM_WEAPON_NOAMMO, weapon_id); break;
1387 case 1: Local_Notification(MSG_MULTI, ITEM_WEAPON_DONTHAVE, weapon_id); break;
1388 default: Local_Notification(MSG_MULTI, ITEM_WEAPON_UNAVAILABLE, weapon_id); break;
1392 string translate_modifications(string s)
1394 return build_mutator_list(s);
1397 string translate_weaponarena(string s)
1399 if (s == "") return s;
1400 if (s == "All Weapons Arena") return _("All Weapons Arena");
1401 if (s == "All Available Weapons Arena") return _("All Available Weapons Arena");
1402 if (s == "Most Weapons Arena") return _("Most Weapons Arena");
1403 if (s == "Most Available Weapons Arena") return _("Most Available Weapons Arena");
1404 if (s == "Dev All Weapons Arena") return s; // development option, do not translate
1405 if (s == "Dev All Available Weapons Arena") return s; // development option, do not translate
1406 if (s == "No Weapons Arena") return _("No Weapons Arena");
1408 int n = tokenizebyseparator(s, " & ");
1409 string wpn_list = "";
1410 for (int i = 0; i < n; i++)
1412 Weapon wep = Weapon_from_name(argv(i));
1413 if (wep == WEP_Null)
1414 LOG_INFO("^3Warning: ^7server sent an invalid weapon name\n");
1415 wpn_list = cons_mid(wpn_list, " & ", wep.m_name);
1418 return sprintf(_("%s Arena"), wpn_list);
1420 return _("No Weapons Arena");
1423 string GetVersionMessage(string hostversion, bool version_mismatch, bool version_check)
1425 string xonotic_hostversion = strcat("Xonotic ", hostversion);
1426 if (version_mismatch)
1429 return strcat(sprintf(_("This is %s"), xonotic_hostversion), "\n^3",
1430 _("Your client version is outdated."), "\n\n\n",
1431 _("### YOU WON'T BE ABLE TO PLAY ON THIS SERVER ###"), "\n\n\n",
1432 _("Please update!"));
1434 return strcat(sprintf(_("This is %s"), xonotic_hostversion), "\n^3",
1435 _("This server is using an outdated Xonotic version."), "\n\n\n",
1436 _("### THIS SERVER IS INCOMPATIBLE AND THUS YOU CANNOT JOIN ###"));
1438 return sprintf(_("Welcome to %s"), xonotic_hostversion);
1441 bool net_handle_ServerWelcome()
1443 bool campaign = ReadByte();
1446 string campaign_title = ReadString();
1447 int campaign_level = ReadByte();
1448 string campaign_msg = ReadString();
1449 string welcomedialog_args;
1450 welcomedialog_args = strcat("HOSTNAME \"", campaign_title, "\"");
1451 string key = getcommandkey(_("jump"), "+jump");
1452 string msg = strcat(
1453 CCR("^F1"), sprintf(_("Level %d:"), campaign_level),
1454 sprintf(CCR(" ^BG%s\n^3\n"), campaign_msg),
1455 sprintf(CCR(_("^BGPress ^F2%s^BG to enter the game")), key));
1456 msg = MakeConsoleSafe(strreplace("\n", "\\n", msg));
1457 welcomedialog_args = strcat(welcomedialog_args, " WELCOME \"", msg, "\"");
1458 localcmd("\nmenu_cmd directmenu Welcome ", welcomedialog_args, "\n");
1462 strcpy(hostname, ReadString());
1463 string hostversion = ReadString();
1464 bool version_mismatch = ReadByte();
1465 bool version_check = ReadByte();
1466 srv_minplayers = ReadByte();
1467 srv_maxplayers = ReadByte();
1468 string modifications = translate_modifications(ReadString());
1469 string weaponarena_list = translate_weaponarena(ReadString());
1470 string cache_mutatormsg = ReadString();
1471 string motd = ReadString();
1473 string msg = GetVersionMessage(hostversion, version_mismatch, version_check);
1475 msg = strcat(msg, "\n\n", _("Gametype:"), " ^1", MapInfo_Type_ToText(gametype), "\n");
1477 msg = strcat(msg, "\n", _("Map:"), " ^2");
1478 if (world.message == "")
1479 msg = strcat(msg, mi_shortname, "\n");
1482 int i = strstrofs(world.message, " by ", 0); // matches _MapInfo_Generate()
1483 string longname = i >= 0 ? substring(world.message, 0, i) : world.message;
1484 msg = strcat(msg, (strcasecmp(longname, mi_shortname) ? strcat(mi_shortname, " ^7// ^2") : ""), longname, "\n");
1487 if (srv_minplayers || srv_maxplayers)
1489 msg = strcat(msg, "\n", _("This match supports"), " ^5");
1490 if (srv_minplayers == srv_maxplayers)
1491 msg = strcat(msg, sprintf(_("%d players"), srv_maxplayers), "\n");
1492 else if (srv_minplayers && srv_maxplayers)
1493 msg = strcat(msg, sprintf(_("%d to %d players"), srv_minplayers, srv_maxplayers), "\n");
1494 else if (srv_maxplayers)
1495 msg = strcat(msg, sprintf(_("%d players maximum"), srv_maxplayers), "\n");
1497 msg = strcat(msg, sprintf(_("%d players minimum"), srv_minplayers), "\n");
1500 modifications = cons_mid(modifications, ", ", weaponarena_list);
1501 if(modifications != "")
1502 msg = strcat(msg, "\n", _("Active modifications:"), " ^3", modifications, "\n");
1504 if (cache_mutatormsg != "")
1505 msg = strcat(msg, "\n", _("Special gameplay tips:"), " ^7", cache_mutatormsg, "\n");
1506 string mutator_msg = "";
1507 MUTATOR_CALLHOOK(BuildGameplayTipsString, mutator_msg);
1508 mutator_msg = M_ARGV(0, string);
1509 msg = strcat(msg, mutator_msg); // trust that the mutator will do proper formatting
1512 msg = strcat(msg, "\n^9↓ ", _("Server's message"), " ↓\n", motd);
1514 strcpy(welcome_msg, msg);
1515 welcome_msg_menu_check_maxtime = time + 1; // wait for menu to load before showing the welcome dialog
1519 void Welcome_Message_Show_Try()
1521 if (!welcome_msg_menu_check_maxtime)
1524 // if want dialog check if menu is initialized but for a short time
1525 if (cvar("_menu_initialized") == 2 || time > welcome_msg_menu_check_maxtime)
1527 if (cvar("_menu_welcome_dialog_available"))
1529 string welcomedialog_args = strcat("HOSTNAME \"", hostname, "\"");
1530 string msg = MakeConsoleSafe(strreplace("\n", "\\n", welcome_msg));
1531 welcomedialog_args = strcat(welcomedialog_args, " WELCOME \"", msg, "\"");
1533 if (intermission || isdemo() || !autocvar_cl_welcome)
1535 if (cvar("_menu_cmd_closemenu_available"))
1537 // initialize the dialog without opening it
1538 localcmd("\nmenu_cmd closemenu Welcome ", welcomedialog_args, "\n");
1542 // legacy code for clients with old menus
1543 // since togglemenu 0 doesn't close the dialog but only hides it,
1544 // playing back a demo the Welcome dialog will pop up on the first ESC press
1545 localcmd("\nmenu_cmd directmenu Welcome ", welcomedialog_args, "\n");
1546 // close it after it's been initialized so it can still be opened manually
1547 localcmd("\ntogglemenu 0\n");
1551 localcmd("\nmenu_cmd directmenu Welcome ", welcomedialog_args, "\n");
1554 strfree(welcome_msg);
1555 welcome_msg_menu_check_maxtime = 0;
1559 NET_HANDLE(TE_CSQC_SERVERWELCOME, bool isNew)
1561 return net_handle_ServerWelcome();
1564 string _getcommandkey(string cmd_name, string command, bool forcename)
1567 float n, j, k, l = 0;
1569 if (!autocvar_hud_showbinds)
1572 keys = db_get(binddb, command);
1575 bool joy_active = cvar("joy_active");
1576 n = tokenize(findkeysforcommand(command, 0)); // uses '...' strings
1577 for(j = 0; j < n; ++j)
1582 string key = keynumtostring(k);
1583 if(!joy_active && substring(key, 0, 3) == "JOY")
1586 key = translate_key(key);
1591 keys = strcat(keys, ", ", key);
1594 if (autocvar_hud_showbinds_limit > 0 && autocvar_hud_showbinds_limit <= l)
1601 db_put(binddb, command, keys);
1604 if (keys == "NO_KEY") {
1605 if (autocvar_hud_showbinds > 1)
1606 return sprintf(_("%s (not bound)"), cmd_name);
1610 else if (autocvar_hud_showbinds > 1 || forcename)
1611 return sprintf("%s (%s)", cmd_name, keys);
1616 /** engine callback */
1617 void URI_Get_Callback(int id, int status, string data)
1619 TC(int, id); TC(int, status);
1620 if(url_URI_Get_Callback(id, status, data))
1624 else if (id == URI_GET_DISCARD)
1628 else if (id >= URI_GET_CURL && id <= URI_GET_CURL_END)
1631 Curl_URI_Get_Callback(id, status, data);
1635 LOG_INFOF("Received HTTP request data for an invalid id %d.", id);