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");
109 teams = Sort_Spawn();
110 players = Sort_Spawn();
112 GetTeam(NUM_SPECTATOR, true); // add specs first
114 for (int w = 0; w <= WEP_LAST - WEP_FIRST; ++w)
115 weapon_accuracy[w] = -1;
119 if(autocvar_cl_reticle)
121 precache_pic("gfx/reticle_normal");
122 // weapon reticles are precached in weapon files
126 get_mi_min_max_texcoords(1); // try the CLEVER way first
127 minimapname = strcat("gfx/", mi_shortname, "_radar");
128 shortmapname = mi_shortname;
130 if (precache_pic(minimapname) == "")
132 // but maybe we have a non-clever minimap
133 minimapname = strcat("gfx/", mi_shortname, "_mini");
134 if (precache_pic(minimapname) == "")
135 minimapname = ""; // FAIL
137 get_mi_min_max_texcoords(0); // load new texcoords
140 mi_center = (mi_min + mi_max) * 0.5;
141 mi_scale = mi_max - mi_min;
142 minimapname = strzone(minimapname);
145 hud_skin_path = strzone(strcat("gfx/hud/", autocvar_hud_skin));
146 LoadMenuSkinValues();
149 // CSQC_Shutdown : Called every time the CSQC code is shutdown (changing maps, quitting, etc)
158 if(autocvar_cl_db_saveasdump)
159 db_dump(ClientProgsDB, "client.db");
161 db_save(ClientProgsDB, "client.db");
162 db_close(ClientProgsDB);
165 cvar_set("chase_active",ftos(chase_active_backup));
167 // unset the event chasecam's chase_active
168 if(autocvar_chase_active < 0)
169 cvar_set("chase_active", "0");
171 if (autocvar_r_drawviewmodel < 0)
172 cvar_set("r_drawviewmodel", "0");
174 cvar_set("slowmo", cvar_defstring("slowmo")); // reset it back to 'default'
178 if (!(calledhooks & HOOK_START))
179 localcmd("\n_cl_hook_gamestart nop\n");
180 if (!(calledhooks & HOOK_END))
181 localcmd("\ncl_hook_gameend\n");
184 localcmd("\ncl_hook_shutdown\n");
186 localcmd("\n-button12\n");
188 deactivate_minigame();
189 HUD_MinigameMenu_Close(NULL, NULL, NULL);
191 ReplicateVars(REPLICATEVARS_DESTROY);
200 for(e = prev.sort_next; e; prev = e, e = e.sort_next)
202 if(prev != e.sort_prev)
203 error(strcat("sort list chain error\nplease submit the output of 'prvm_edicts client' to the developers"));
207 for(e = prev.sort_next; e; prev = e, e = e.sort_next)
209 if(prev != e.sort_prev)
210 error(strcat("sort list chain error\nplease submit the output of 'prvm_edicts client' to the developers"));
214 float RegisterPlayer(entity player)
218 for(pl = players.sort_next; pl; pl = pl.sort_next)
220 error("Player already registered!");
221 player.sort_next = players.sort_next;
222 player.sort_prev = players;
223 if(players.sort_next)
224 players.sort_next.sort_prev = player;
225 players.sort_next = player;
230 void RemovePlayer(entity player)
235 for(pl = players.sort_next; pl && pl != player; pl = pl.sort_next)
240 error("Trying to remove a player which is not in the playerlist!");
243 parent.sort_next = player.sort_next;
245 player.sort_next.sort_prev = parent;
249 void MoveToLast(entity e)
252 entity ent = e.sort_next;
261 float RegisterTeam(entity Team)
263 assert_once(Team.team, eprint(Team));
266 for(tm = teams.sort_next; tm; tm = tm.sort_next)
268 error("Team already registered!");
269 Team.sort_next = teams.sort_next;
270 Team.sort_prev = teams;
272 teams.sort_next.sort_prev = Team;
273 teams.sort_next = Team;
274 if(Team.team && Team.team != NUM_SPECTATOR)
280 void RemoveTeam(entity Team)
285 for(tm = teams.sort_next; tm && tm != Team; tm = tm.sort_next)
290 LOG_INFO(_("Trying to remove a team which is not in the teamlist!"));
293 parent.sort_next = Team.sort_next;
295 Team.sort_next.sort_prev = parent;
296 if(Team.team && Team.team != NUM_SPECTATOR)
301 entity GetTeam(int Team, bool add)
303 TC(int, Team); TC(bool, add);
304 int num = (Team == NUM_SPECTATOR) ? 16 : Team;
306 return teamslots[num];
309 entity tm = new_pure(team);
317 bool SetTeam(entity o, int Team)
320 //devassert_once(Team);
333 if(GetTeam(Team, false) == NULL)
335 LOG_TRACEF("trying to switch to unsupported team %d", Team);
336 Team = NUM_SPECTATOR;
349 if(GetTeam(Team, false) == NULL)
351 LOG_TRACEF("trying to switch to unsupported team %d", Team);
352 Team = NUM_SPECTATOR;
357 if(Team == -1) // leave
361 tm = GetTeam(o.team, false);
372 tm = GetTeam(Team, true);
377 else if(Team != o.team)
379 tm = GetTeam(o.team, false);
382 tm = GetTeam(Team, true);
390 void Playerchecker_Think(entity this)
394 for(i = 0; i < maxclients; ++i)
397 if(entcs_GetName(i) == "")
401 // player disconnected
415 playerslots[i] = e = new_pure(playerslot);
419 e.ping_packetloss = 0;
420 e.ping_movementloss = 0;
421 //e.gotscores = 0; // we might already have the scores...
422 int t = entcs_GetScoreTeam(i);
423 if (t) SetTeam(e, t); // will not hurt; later updates come with Scoreboard_UpdatePlayerTeams
425 Scoreboard_UpdatePlayerPos(e);
429 this.nextthink = time + 0.2;
434 entity playerchecker = new_pure(playerchecker);
435 setthink(playerchecker, Playerchecker_Think);
436 playerchecker.nextthink = time + 0.2;
440 // this can't be called in CSQC_Init as it'd send cvars too early
441 ReplicateVars_Start();
446 void Release_Common_Keys()
449 localcmd("-fire2\n");
455 // CSQC_InputEvent : Used to perform actions based on any key pressed, key released and mouse on the client.
456 // Return value should be 1 if CSQC handled the input, otherwise return 0 to have the input passed to the engine.
457 // All keys are in ascii.
458 // bInputType = 0 is key pressed, 1 is key released, 2 and 3 are mouse input.
459 // In the case of keyboard input, nPrimary is the ascii code, and nSecondary is 0.
460 // In the case of mouse input, nPrimary is xdelta, nSecondary is ydelta.
461 // In the case of mouse input after a setcursormode(1) call, nPrimary is xpos, nSecondary is ypos.
462 float CSQC_InputEvent(int bInputType, float nPrimary, float nSecondary)
465 bool override = false;
467 override |= HUD_Scoreboard_InputEvent(bInputType, nPrimary, nSecondary);
471 override |= HUD_Panel_InputEvent(bInputType, nPrimary, nSecondary);
475 override |= HUD_Panel_Chat_InputEvent(bInputType, nPrimary, nSecondary);
477 override |= QuickMenu_InputEvent(bInputType, nPrimary, nSecondary);
479 override |= HUD_Radar_InputEvent(bInputType, nPrimary, nSecondary);
481 override |= MapVote_InputEvent(bInputType, nPrimary, nSecondary);
483 override |= HUD_Minigame_InputEvent(bInputType, nPrimary, nSecondary);
488 if(bInputType == 3 || bInputType == 2)
491 // at this point bInputType can only be 0 or 1 (key pressed or released)
492 bool key_pressed = (bInputType == 0);
495 if(nPrimary == K_ALT) hudShiftState |= S_ALT;
496 if(nPrimary == K_CTRL) hudShiftState |= S_CTRL;
497 if(nPrimary == K_SHIFT) hudShiftState |= S_SHIFT;
498 if(nPrimary == K_TAB) hudShiftState |= S_TAB;
501 if(nPrimary == K_ALT) hudShiftState -= (hudShiftState & S_ALT);
502 if(nPrimary == K_CTRL) hudShiftState -= (hudShiftState & S_CTRL);
503 if(nPrimary == K_SHIFT) hudShiftState -= (hudShiftState & S_SHIFT);
504 if(nPrimary == K_TAB) hudShiftState -= (hudShiftState & S_TAB);
507 // NOTE: Shift-Escape must be filtered out because it's the hardcoded console shortcut
508 if (nPrimary == K_ESCAPE && !(hudShiftState & S_SHIFT) && key_pressed)
510 if (hudShiftState & S_TAB)
512 Scoreboard_UI_Enable(0);
515 if (!isdemo() && cvar("_menu_gamemenu_dialog_available"))
517 localcmd("\nmenu_showgamemenudialog\n");
525 // END REQUIRED CSQC FUNCTIONS
526 // --------------------------------------------------------------------------
528 // --------------------------------------------------------------------------
529 // BEGIN OPTIONAL CSQC FUNCTIONS
531 void Ent_RemovePlayerScore(entity this)
534 SetTeam(this.owner, -1);
535 this.owner.gotscores = 0;
536 FOREACH(Scores, true, {
537 this.owner.(scores(it)) = 0; // clear all scores
542 NET_HANDLE(ENT_CLIENT_SCORES, bool isnew)
547 // damnit -.- don't want to go change every single .sv_entnum in hud.qc AGAIN
548 // (no I've never heard of M-x replace-string, sed, or anything like that)
549 bool isNew = !this.owner; // workaround for DP bug
550 int n = ReadByte()-1;
552 #ifdef DP_CSQC_ENTITY_REMOVE_IS_B0RKED
553 if(!isNew && n != this.sv_entnum)
555 //print("A CSQC entity changed its owner!\n");
556 LOG_INFOF("A CSQC entity changed its owner! (edict: %d, classname: %s)", etof(this), this.classname);
564 o = playerslots[this.sv_entnum];
567 o = playerslots[this.sv_entnum] = new_pure(playerslot);
570 o.sv_entnum = this.sv_entnum;
574 // RegisterPlayer(o);
575 //playerchecker will do this for us later, if it has not already done so
577 int sf = ReadShort();
578 int lf = ReadShort();
579 FOREACH(Scores, true, {
580 int p = 1 << (i % 16);
584 o.(scores(it)) = ReadInt24_t();
586 o.(scores(it)) = ReadChar();
593 Scoreboard_UpdatePlayerPos(o); // if not registered, we cannot do this yet!
595 this.entremove = Ent_RemovePlayerScore;
598 NET_HANDLE(ENT_CLIENT_TEAMSCORES, bool isnew)
603 this.team = ReadByte();
604 entity o = this.owner = GetTeam(this.team, true); // these team numbers can always be trusted
606 #if MAX_TEAMSCORE <= 8
610 int sf = ReadShort();
611 int lf = ReadShort();
613 for(i = 0; i < MAX_TEAMSCORE; ++i)
617 o.(teamscores(i)) = ReadInt24_t();
619 o.(teamscores(i)) = ReadChar();
624 Scoreboard_UpdateTeamPos(o);
627 NET_HANDLE(ENT_CLIENT_CLIENTDATA, bool isnew)
630 float newspectatee_status;
634 scoreboard_showscores_force = (f & BIT(0));
638 newspectatee_status = ReadByte();
639 if(newspectatee_status == player_localnum + 1)
640 newspectatee_status = -1; // observing
643 newspectatee_status = 0;
645 spectatorbutton_zoom = (f & BIT(2));
649 num_spectators = ReadByte();
653 for(i = 0; i < MAX_SPECTATORS; ++i)
654 spectatorlist[i] = 0; // reset list first
656 int limit = min(num_spectators, MAX_SPECTATORS);
657 for(i = 0; i < limit; ++i)
660 spectatorlist[i] = slot - 1;
665 for(int j = 0; j < MAX_SPECTATORS; ++j)
666 spectatorlist[j] = 0; // reset list if showspectators has been turned off
672 if(newspectatee_status != spectatee_status)
676 race_checkpointtime = 0;
677 hud_dynamic_shake_factor = -1;
678 spectatee_status_changed_time = time;
680 if (autocvar_hud_panel_healtharmor_progressbar_gfx)
682 if ( (spectatee_status == -1 && newspectatee_status > 0) //before observing, now spectating
683 || (spectatee_status > 0 && newspectatee_status > 0 && spectatee_status != newspectatee_status) //changed spectated player
686 else if(spectatee_status && !newspectatee_status) //before observing/spectating, now playing
689 spectatee_status = newspectatee_status;
691 // we could get rid of spectatee_status, and derive it from player_localentnum and player_localnum
694 NET_HANDLE(ENT_CLIENT_NAGGER, bool isnew)
699 int nags = ReadByte(); // NAGS NAGS NAGS NAGS NAGS NAGS NADZ NAGS NAGS NAGS
703 strfree(vote_called_vote);
713 vote_yescount = ReadByte();
714 vote_nocount = ReadByte();
715 vote_needed = ReadByte();
716 vote_highlighted = ReadChar();
721 strcpy(vote_called_vote, ReadString());
726 for(j = 0; j < maxclients; ++j)
728 playerslots[j].ready = true;
729 for(i = 1; i <= maxclients; i += 8)
732 for(j = i-1, b = BIT(0); b < BIT(8); b <<= 1, ++j)
735 playerslots[j].ready = false;
741 ready_waiting = (nags & BIT(0));
742 ready_waiting_for_me = (nags & BIT(1));
743 vote_waiting = (nags & BIT(2));
744 vote_waiting_for_me = (nags & BIT(3));
745 warmup_stage = (nags & BIT(4));
748 NET_HANDLE(ENT_CLIENT_ELIMINATEDPLAYERS, bool isnew)
752 serialize(byte, 0, sf);
754 for (int j = 0; j < maxclients; ++j) {
755 if (playerslots[j]) {
756 playerslots[j].eliminated = true;
759 for (int i = 1; i <= maxclients; i += 8) {
761 serialize(byte, 0, f);
762 for (int b = 0; b < 8; ++b) {
763 if (f & BIT(b)) continue;
765 if (playerslots[j]) {
766 playerslots[j].eliminated = false;
774 NET_HANDLE(ENT_CLIENT_RANDOMSEED, bool isnew)
778 float s = ReadShort();
783 NET_HANDLE(ENT_CLIENT_ACCURACY, bool isnew)
786 int sf = ReadInt24_t();
788 for (int w = 0; w <= WEP_LAST - WEP_FIRST; ++w)
789 weapon_accuracy[w] = -1;
794 for (int w = 0; w <= WEP_LAST - WEP_FIRST; ++w) {
798 weapon_accuracy[w] = -1;
800 weapon_accuracy[w] = 1.0; // no better error handling yet, sorry
802 weapon_accuracy[w] = (b - 1.0) / 100.0;
804 f = (f == 0x800000) ? 1 : f * 2;
809 void Spawn_Draw(entity this)
811 bool dodraw = autocvar_cl_spawn_point_particles;
812 if(dodraw && autocvar_cl_spawn_point_dist_max)
814 vector org = getpropertyvec(VF_ORIGIN);
815 dodraw = vdist(org - this.origin, <, autocvar_cl_spawn_point_dist_max);
819 pointparticles(((!teamplay) ? EFFECT_SPAWNPOINT_NEUTRAL : EFFECT_SPAWNPOINT(this.team - 1)), this.origin + '0 0 28', '0 0 2', bound(0, frametime, 0.1));
822 NET_HANDLE(ENT_CLIENT_SPAWNPOINT, bool is_new)
824 float teamnum = (ReadByte() - 1);
825 vector spn_origin = ReadVector();
827 this.team = (teamnum + 1);
831 this.origin = spn_origin;
832 setsize(this, PL_MIN_CONST, PL_MAX_CONST);
835 /*if(autocvar_cl_spawn_point_model) // needs a model first
837 this.mdl = "models/spawnpoint.md3";
838 this.colormod = Team_ColorRGB(teamnum);
839 precache_model(this.mdl);
840 setmodel(this, this.mdl);
841 this.drawmask = MASK_NORMAL;
842 //this.move_movetype = MOVETYPE_NOCLIP;
843 //this.draw = Spawn_Draw;
844 IL_PUSH(g_drawables, this);
846 this.draw = Spawn_Draw;
847 if (is_new) IL_PUSH(g_drawables, this);
850 //printf("Ent_ReadSpawnPoint(is_new = %d); origin = %s, team = %d, effect = %d\n", is_new, vtos(this.origin), teamnum, this.cnt);
854 NET_HANDLE(ENT_CLIENT_SPAWNEVENT, bool is_new)
856 // If entnum is 0, ONLY do the local spawn actions
857 // this way the server can disable the sending of
858 // spawn origin or such to clients if wanted.
859 float entnum = ReadByte();
863 this.origin = ReadVector();
867 float teamnum = entcs_GetTeam(entnum - 1);
869 if(autocvar_cl_spawn_event_particles)
873 case NUM_TEAM_1: pointparticles(EFFECT_SPAWN_RED, this.origin, '0 0 0', 1); break;
874 case NUM_TEAM_2: pointparticles(EFFECT_SPAWN_BLUE, this.origin, '0 0 0', 1); break;
875 case NUM_TEAM_3: pointparticles(EFFECT_SPAWN_YELLOW, this.origin, '0 0 0', 1); break;
876 case NUM_TEAM_4: pointparticles(EFFECT_SPAWN_PINK, this.origin, '0 0 0', 1); break;
877 default: pointparticles(EFFECT_SPAWN_NEUTRAL, this.origin, '0 0 0', 1); break;
880 if(autocvar_cl_spawn_event_sound)
882 sound(this, CH_TRIGGER, SND_SPAWN, VOL_BASE, ATTEN_NORM);
888 // local spawn actions
889 if(is_new && (!entnum || (entnum == player_localentnum)))
891 if(autocvar_cl_spawnzoom && !autocvar_cl_lockview)
894 current_viewzoom = (1 / bound(1, autocvar_cl_spawnzoom_factor, 16));
897 if(autocvar_cl_unpress_zoom_on_spawn)
902 HUD_Radar_Hide_Maximized();
904 //printf("Ent_ReadSpawnEvent(is_new = %d); origin = %s, entnum = %d, localentnum = %d\n", is_new, vtos(this.origin), entnum, player_localentnum);
907 // CSQC_Ent_Update : Called every frame that the server has indicated an update to the SSQC / CSQC entity has occured.
908 // The parameter isnew reflects if the entity is "new" to the client, meaning it just came into the client's PVS.
909 void CSQC_Ent_Update(entity this, bool isnew)
911 this.sourceLoc = __FILE__":"STR(__LINE__);
914 // set up the "time" global for received entities to be correct for interpolation purposes
915 float savetime = time;
922 serverprevtime = time;
923 serverdeltatime = STAT(MOVEVARS_TICRATE) * STAT(MOVEVARS_TIMESCALE);
924 time = serverprevtime + serverdeltatime;
927 #ifdef DP_CSQC_ENTITY_REMOVE_IS_B0RKED
930 if (t != this.enttype || isnew)
932 LOG_INFOF("A CSQC entity changed its type! (edict: %d, server: %d, type: %d -> %d)", etof(this), this.entnum, this.enttype, t);
943 LOG_INFOF("A CSQC entity appeared out of nowhere! (edict: %d, server: %d, type: %d)", etof(this), this.entnum, t);
950 FOREACH(LinkedEntities, it.m_id == t, {
951 if (isnew) this.classname = it.netname;
952 if (autocvar_developer_csqcentities)
953 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);
954 done = it.m_read(this, NULL, isnew);
955 MUTATOR_CALLHOOK(Ent_Update, this, isnew);
961 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);
965 // Destructor, but does NOT deallocate the entity by calling remove(). Also
966 // used when an entity changes its type. For an entity that someone interacts
967 // with others, make sure it can no longer do so.
968 void Ent_Remove(entity this)
970 if(this.entremove) this.entremove(this);
972 if(this.skeletonindex)
974 skel_delete(this.skeletonindex);
975 this.skeletonindex = 0;
978 if(this.snd_looping > 0)
980 sound(this, this.snd_looping, SND_Null, VOL_BASE, autocvar_cl_jetpack_attenuation);
981 this.snd_looping = 0;
986 this.draw = func_null;
987 this.entremove = func_null;
988 // TODO possibly set more stuff to defaults
990 // CSQC_Ent_Remove : Called when the server requests a SSQC / CSQC entity to be removed. Essentially call remove(this) as well.
991 void CSQC_Ent_Remove(entity this)
993 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Ent_Remove() with this=%i {.entnum=%d, .enttype=%d}", this, this.entnum, this.enttype);
996 LOG_WARN("CSQC_Ent_Remove called for already removed entity. Packet loss?");
999 if (this.enttype) Ent_Remove(this);
1003 void Gamemode_Init()
1007 if(!(calledhooks & HOOK_START))
1008 localcmd("\n_cl_hook_gamestart ", MapInfo_Type_ToString(gametype), "\n");
1009 calledhooks |= HOOK_START;
1012 // 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.
1013 void CSQC_Parse_StuffCmd(string strMessage)
1015 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_StuffCmd(\"%s\")", strMessage);
1016 localcmd(strMessage);
1018 // 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.
1019 void CSQC_Parse_Print(string strMessage)
1021 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_Print(\"%s\")", strMessage);
1022 print(ColorTranslateRGB(strMessage));
1025 // CSQC_Parse_CenterPrint : Provides the centerprint_AddStandard string in the first parameter that the server provided.
1026 void CSQC_Parse_CenterPrint(string strMessage)
1028 if (autocvar_developer_csqcentities) LOG_INFOF("CSQC_Parse_CenterPrint(\"%s\")", strMessage);
1029 centerprint_AddStandard(strMessage);
1032 // CSQC_Parse_TempEntity : Handles all temporary entity network data in the CSQC layer.
1033 // You must ALWAYS first acquire the temporary ID, which is sent as a byte.
1034 // Return value should be 1 if CSQC handled the temporary entity, otherwise return 0 to have the engine process the event.
1035 bool CSQC_Parse_TempEntity()
1038 int nTEID = ReadByte();
1040 FOREACH(TempEntities, it.m_id == nTEID, {
1041 if (autocvar_developer_csqcentities)
1042 LOG_INFOF("CSQC_Parse_TempEntity() nTEID=%s (%d)", it.netname, nTEID);
1043 return it.m_read(NULL, NULL, true);
1046 if (autocvar_developer_csqcentities)
1047 LOG_INFOF("CSQC_Parse_TempEntity() with nTEID=%d", nTEID);
1049 // No special logic for this temporary entity; return 0 so the engine can handle it
1056 if (autocvar_cl_orthoview && autocvar_cl_orthoview_nofog)
1057 localcmd("\nr_drawfog 0\n");
1058 else if (forcefog != "")
1059 localcmd(sprintf("\nfog %s\nr_fog_exp2 0\nr_drawfog 1\n", forcefog));
1062 bool net_handle_ServerWelcome();
1063 NET_HANDLE(ENT_CLIENT_SCORES_INFO, bool isnew)
1066 gametype = ReadRegistered(Gametypes);
1067 teamplay = _MapInfo_GetTeamPlayBool(gametype);
1068 HUD_ModIcons_SetFunc();
1069 FOREACH(Scores, true, {
1070 strcpy(scores_label(it), ReadString());
1071 scores_flags(it) = ReadByte();
1073 for (int i = 0; i < MAX_TEAMSCORE; ++i)
1075 strcpy(teamscores_label(i), ReadString());
1076 teamscores_flags(i) = ReadByte();
1078 bool welcome_msg_too = ReadByte();
1079 if (welcome_msg_too)
1080 net_handle_ServerWelcome();
1082 Scoreboard_InitScores();
1086 NET_HANDLE(ENT_CLIENT_INIT, bool isnew)
1088 nb_pb_period = ReadByte() / 32; //Accuracy of 1/32th
1090 hook_shotorigin[0] = decompressShotOrigin(ReadInt24_t());
1091 hook_shotorigin[1] = decompressShotOrigin(ReadInt24_t());
1092 hook_shotorigin[2] = decompressShotOrigin(ReadInt24_t());
1093 hook_shotorigin[3] = decompressShotOrigin(ReadInt24_t());
1094 arc_shotorigin[0] = decompressShotOrigin(ReadInt24_t());
1095 arc_shotorigin[1] = decompressShotOrigin(ReadInt24_t());
1096 arc_shotorigin[2] = decompressShotOrigin(ReadInt24_t());
1097 arc_shotorigin[3] = decompressShotOrigin(ReadInt24_t());
1099 strcpy(forcefog, ReadString());
1101 armorblockpercent = ReadByte() / 255.0;
1102 damagepush_speedfactor = ReadByte() / 255.0;
1104 serverflags = ReadByte();
1106 g_trueaim_minrange = ReadCoord();
1110 MUTATOR_CALLHOOK(Ent_Init);
1112 if (!postinit) PostInit();
1115 float GetSpeedUnitFactor(int speed_unit)
1121 case 2: return 0.0254;
1122 case 3: return 0.0254 * 3.6;
1123 case 4: return 0.0254 * 3.6 * 0.6213711922;
1124 case 5: return 0.0254 * 1.943844492; // 1 m/s = 1.943844492 knots, because 1 knot = 1.852 km/h
1128 string GetSpeedUnit(int speed_unit)
1132 // translator-friendly strings without the initial space
1134 case 1: return strcat(" ", _("qu/s"));
1135 case 2: return strcat(" ", _("m/s"));
1136 case 3: return strcat(" ", _("km/h"));
1137 case 4: return strcat(" ", _("mph"));
1138 case 5: return strcat(" ", _("knots"));
1142 NET_HANDLE(TE_CSQC_RACE, bool isNew)
1148 case RACE_NET_CHECKPOINT_HIT_QUALIFYING:
1149 race_checkpoint = ReadByte();
1150 race_time = ReadInt24_t();
1151 race_previousbesttime = ReadInt24_t();
1152 race_mypreviousbesttime = ReadInt24_t();
1153 string pbestname = ReadString();
1154 if(autocvar_cl_race_cptimes_onlyself)
1156 race_previousbesttime = race_mypreviousbesttime;
1157 race_mypreviousbesttime = 0;
1158 strcpy(race_previousbestname, "");
1161 strcpy(race_previousbestname, pbestname);
1163 race_checkpointtime = time;
1165 if(race_checkpoint == 0 || race_checkpoint == 254)
1167 race_penaltyaccumulator = 0;
1168 race_laptime = time; // valid
1172 case RACE_NET_CHECKPOINT_CLEAR:
1174 race_checkpointtime = 0;
1177 case RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING:
1178 race_laptime = ReadCoord();
1179 race_checkpointtime = -99999;
1181 case RACE_NET_CHECKPOINT_NEXT_QUALIFYING:
1182 race_nextcheckpoint = ReadByte();
1184 race_nextbesttime = ReadInt24_t();
1185 if(b != RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING) // not while spectating (matches server)
1186 race_mybesttime = ReadInt24_t();
1187 string newname = ReadString();
1188 if(autocvar_cl_race_cptimes_onlyself && b != RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING)
1190 race_nextbesttime = race_mybesttime;
1191 race_mybesttime = 0;
1192 strcpy(race_nextbestname, "");
1195 strcpy(race_nextbestname, newname);
1198 case RACE_NET_CHECKPOINT_HIT_RACE:
1199 race_mycheckpoint = ReadByte();
1200 race_mycheckpointtime = time;
1201 race_mycheckpointdelta = ReadInt24_t();
1202 race_mycheckpointlapsdelta = ReadByte();
1203 if(race_mycheckpointlapsdelta >= 128)
1204 race_mycheckpointlapsdelta -= 256;
1205 int who = ReadByte();
1207 strcpy(race_mycheckpointenemy, entcs_GetName(who - 1));
1209 strcpy(race_mycheckpointenemy, ""); // TODO: maybe string_null works fine here?
1212 case RACE_NET_CHECKPOINT_HIT_RACE_BY_OPPONENT:
1213 race_othercheckpoint = ReadByte();
1214 race_othercheckpointtime = time;
1215 race_othercheckpointdelta = ReadInt24_t();
1216 race_othercheckpointlapsdelta = ReadByte();
1217 if(race_othercheckpointlapsdelta >= 128)
1218 race_othercheckpointlapsdelta -= 256;
1219 int what = ReadByte();
1221 strcpy(race_othercheckpointenemy, entcs_GetName(what - 1));
1223 strcpy(race_othercheckpointenemy, ""); // TODO: maybe string_null works fine here?
1226 case RACE_NET_PENALTY_RACE:
1227 case RACE_NET_PENALTY_QUALIFYING:
1228 race_penaltyeventtime = time;
1229 race_penaltytime = ReadShort();
1230 string reason = ReadString();
1231 if (reason == "missing a checkpoint")
1232 reason = _("missing a checkpoint");
1233 strcpy(race_penaltyreason, reason);
1234 if (b == RACE_NET_PENALTY_QUALIFYING)
1235 race_penaltyaccumulator += race_penaltytime;
1238 case RACE_NET_SERVER_RECORD:
1239 race_server_record = ReadInt24_t();
1241 case RACE_NET_SPEED_AWARD:
1242 race_speedaward = ReadInt24_t() * GetSpeedUnitFactor(autocvar_hud_panel_physics_speed_unit);
1243 strcpy(race_speedaward_holder, ReadString());
1245 case RACE_NET_SPEED_AWARD_BEST:
1246 race_speedaward_alltimebest = ReadInt24_t() * GetSpeedUnitFactor(autocvar_hud_panel_physics_speed_unit);
1247 strcpy(race_speedaward_alltimebest_holder, ReadString());
1249 case RACE_NET_RANKINGS_CNT:
1250 RANKINGS_DISPLAY_CNT = ReadByte();
1252 case RACE_NET_SERVER_RANKINGS:
1254 int pos = ReadShort();
1255 prevpos = ReadShort();
1258 // move other rankings out of the way
1261 int m = min(prevpos, RANKINGS_DISPLAY_CNT);
1262 for (i=m-1; i>pos-1; --i) {
1263 grecordtime[i] = grecordtime[i-1];
1264 strcpy(grecordholder[i], grecordholder[i-1]);
1266 } else if (del) { // a record has been deleted by the admin
1267 for (i=pos-1; i<= RANKINGS_DISPLAY_CNT-1; ++i) {
1268 if (i == RANKINGS_DISPLAY_CNT-1) { // clear out last record
1270 strfree(grecordholder[i]);
1273 grecordtime[i] = grecordtime[i+1];
1274 strcpy(grecordholder[i], grecordholder[i+1]);
1277 } else { // player has no ranked record yet
1278 for (i=RANKINGS_DISPLAY_CNT-1;i>pos-1;--i) {
1279 grecordtime[i] = grecordtime[i-1];
1280 strcpy(grecordholder[i], grecordholder[i-1]);
1284 if (grecordtime[RANKINGS_DISPLAY_CNT]) {
1285 // kick off the player who fell from the last displayed position
1286 grecordtime[RANKINGS_DISPLAY_CNT] = 0;
1287 strfree(grecordholder[RANKINGS_DISPLAY_CNT]);
1290 // store new ranking
1291 strcpy(grecordholder[pos-1], ReadString());
1292 grecordtime[pos-1] = ReadInt24_t();
1293 if(strdecolorize(grecordholder[pos-1]) == strdecolorize(entcs_GetName(player_localnum)))
1296 case RACE_NET_SERVER_STATUS:
1297 race_status = ReadShort();
1298 strcpy(race_status_name, ReadString());
1303 NET_HANDLE(TE_CSQC_TEAMNAGGER, bool isNew)
1309 NET_HANDLE(TE_CSQC_PINGPLREPORT, bool isNew)
1312 int pi = ReadShort();
1313 int pl = ReadByte();
1314 int ml = ReadByte();
1316 entity e = playerslots[i];
1319 e.ping_packetloss = pl / 255.0;
1320 e.ping_movementloss = ml / 255.0;
1323 NET_HANDLE(TE_CSQC_WEAPONCOMPLAIN, bool isNew)
1325 int weapon_id = ReadByte();
1326 complain_weapon = REGISTRY_GET(Weapons, weapon_id);
1327 complain_weapon_type = ReadByte();
1330 complain_weapon_time = time;
1331 weapontime = time; // ping the weapon panel
1333 switch(complain_weapon_type)
1335 case 0: Local_Notification(MSG_MULTI, ITEM_WEAPON_NOAMMO, weapon_id); break;
1336 case 1: Local_Notification(MSG_MULTI, ITEM_WEAPON_DONTHAVE, weapon_id); break;
1337 default: Local_Notification(MSG_MULTI, ITEM_WEAPON_UNAVAILABLE, weapon_id); break;
1341 string translate_modifications(string s)
1343 return build_mutator_list(s);
1346 string translate_weaponarena(string s)
1348 if (s == "") return s;
1349 if (s == "All Weapons Arena") return _("All Weapons Arena");
1350 if (s == "All Available Weapons Arena") return _("All Available Weapons Arena");
1351 if (s == "Most Weapons Arena") return _("Most Weapons Arena");
1352 if (s == "Most Available Weapons Arena") return _("Most Available Weapons Arena");
1353 if (s == "Dev All Weapons Arena") return s; // development option, do not translate
1354 if (s == "Dev All Available Weapons Arena") return s; // development option, do not translate
1355 if (s == "No Weapons Arena") return _("No Weapons Arena");
1357 int n = tokenizebyseparator(s, " & ");
1358 string wpn_list = "";
1359 for (int i = 0; i < n; i++)
1361 Weapon wep = Weapon_from_name(argv(i));
1362 if (wep == WEP_Null)
1363 LOG_INFO("^3Warning: ^7server sent an invalid weapon name\n");
1364 wpn_list = cons_mid(wpn_list, " & ", wep.m_name);
1367 return sprintf(_("%s Arena"), wpn_list);
1369 return _("No Weapons Arena");
1372 string GetVersionMessage(string hostversion, bool version_mismatch, bool version_check)
1374 string xonotic_hostversion = strcat("Xonotic ", hostversion);
1375 if (version_mismatch)
1378 return strcat(sprintf(_("This is %s"), xonotic_hostversion), "\n^3",
1379 _("Your client version is outdated."), "\n\n\n",
1380 _("### YOU WON'T BE ABLE TO PLAY ON THIS SERVER ###"), "\n\n\n",
1381 _("Please update!"));
1383 return strcat(sprintf(_("This is %s"), xonotic_hostversion), "\n^3",
1384 _("This server is using an outdated Xonotic version."), "\n\n\n",
1385 _("### THIS SERVER IS INCOMPATIBLE AND THUS YOU CANNOT JOIN ###"));
1387 return sprintf(_("Welcome to %s"), xonotic_hostversion);
1390 bool net_handle_ServerWelcome()
1392 bool campaign = ReadByte();
1395 string campaign_title = ReadString();
1396 int campaign_level = ReadByte();
1397 string campaign_msg = ReadString();
1398 string welcomedialog_args;
1399 welcomedialog_args = strcat("HOSTNAME \"", campaign_title, "\"");
1400 string key = getcommandkey(_("jump"), "+jump");
1401 string msg = strcat(
1402 CCR("^F1"), sprintf(_("Level %d:"), campaign_level),
1403 sprintf(CCR(" ^BG%s\n^3\n"), campaign_msg),
1404 sprintf(CCR(_("^BGPress ^F2%s^BG to enter the game")), key));
1405 msg = MakeConsoleSafe(strreplace("\n", "\\n", msg));
1406 welcomedialog_args = strcat(welcomedialog_args, " WELCOME \"", msg, "\"");
1407 localcmd("\nmenu_cmd directmenu Welcome ", welcomedialog_args, "\n");
1411 welcome_msg_force_centerprint = ReadByte();
1412 strcpy(hostname, ReadString());
1414 string hostversion = ReadString();
1415 bool version_mismatch = ReadByte();
1416 bool version_check = ReadByte();
1417 string ver = GetVersionMessage(hostversion, version_mismatch, version_check);
1419 string modifications = translate_modifications(ReadString());
1420 string weaponarena_list = translate_weaponarena(ReadString());
1421 string cache_mutatormsg = ReadString();
1422 string motd = ReadString();
1425 msg = strcat(msg, ver);
1426 msg = strcat(msg, "^8\n\n", strcat(_("Gametype:"), " ^1", MapInfo_Type_ToText(gametype)), "^8\n");
1428 modifications = cons_mid(modifications, ", ", weaponarena_list);
1429 if(modifications != "")
1430 msg = strcat(msg, "^8\n", _("Active modifications:"), " ^3", modifications, "^8\n");
1432 if (cache_mutatormsg != "")
1433 msg = strcat(msg, "\n\n^8", _("Special gameplay tips:"), " ^7", cache_mutatormsg);
1434 string mutator_msg = "";
1435 MUTATOR_CALLHOOK(BuildGameplayTipsString, mutator_msg);
1436 mutator_msg = M_ARGV(0, string);
1437 msg = strcat(msg, mutator_msg); // trust that the mutator will do proper formatting
1440 msg = strcat(msg, "\n\n^8", _("MOTD:"), " ^7", motd);
1442 strcpy(welcome_msg, msg);
1443 welcome_msg_menu_check_maxtime = time + 1; // wait for menu to load before showing the welcome dialog
1447 void Welcome_Message_Show_Try()
1449 if (!welcome_msg_menu_check_maxtime)
1452 bool want_dialog = (!welcome_msg_force_centerprint && !isdemo() && autocvar_cl_welcome_in_menu_dialog);
1453 // if want dialog check if menu is initialized but for a short time
1454 if (!want_dialog || cvar("_menu_initialized") == 2 || time > welcome_msg_menu_check_maxtime)
1456 if (want_dialog && cvar("_menu_welcome_dialog_available"))
1458 string welcomedialog_args = strcat("HOSTNAME \"", hostname, "\"");
1459 string msg = MakeConsoleSafe(strreplace("\n", "\\n", welcome_msg));
1460 welcomedialog_args = strcat(welcomedialog_args, " WELCOME \"", msg, "\"");
1461 localcmd("\nmenu_cmd directmenu Welcome ", welcomedialog_args, "\n");
1464 centerprint_Add(ORDINAL(CPID_MOTD), strcat(hostname, "\n\n\n", welcome_msg), -1, 0);
1466 strfree(welcome_msg);
1467 welcome_msg_menu_check_maxtime = 0;
1471 NET_HANDLE(TE_CSQC_SERVERWELCOME, bool isNew)
1473 return net_handle_ServerWelcome();
1476 string _getcommandkey(string cmd_name, string command, bool forcename)
1479 float n, j, k, l = 0;
1481 if (!autocvar_hud_showbinds)
1484 keys = db_get(binddb, command);
1487 bool joy_active = cvar("joy_active");
1488 n = tokenize(findkeysforcommand(command, 0)); // uses '...' strings
1489 for(j = 0; j < n; ++j)
1494 string key = keynumtostring(k);
1495 if(!joy_active && substring(key, 0, 3) == "JOY")
1498 key = translate_key(key);
1503 keys = strcat(keys, ", ", key);
1506 if (autocvar_hud_showbinds_limit > 0 && autocvar_hud_showbinds_limit <= l)
1513 db_put(binddb, command, keys);
1516 if (keys == "NO_KEY") {
1517 if (autocvar_hud_showbinds > 1)
1518 return sprintf(_("%s (not bound)"), cmd_name);
1522 else if (autocvar_hud_showbinds > 1 || forcename)
1523 return sprintf("%s (%s)", cmd_name, keys);
1528 /** engine callback */
1529 void URI_Get_Callback(int id, int status, string data)
1531 TC(int, id); TC(int, status);
1532 if(url_URI_Get_Callback(id, status, data))
1536 else if (id == URI_GET_DISCARD)
1540 else if (id >= URI_GET_CURL && id <= URI_GET_CURL_END)
1543 Curl_URI_Get_Callback(id, status, data);
1547 LOG_INFOF("Received HTTP request data for an invalid id %d.", id);