3 #include <server/defs.qh>
4 #include <server/miscfunctions.qh>
6 #include <common/command/_mod.qh>
9 #include "../scores.qh"
11 #include <common/monsters/_mod.qh>
12 #include <common/notifications/all.qh>
13 #include <lib/warpzone/common.qh>
16 // ====================================================
17 // Shared code for server commands, written by Samual
18 // Last updated: December 27th, 2011
19 // ====================================================
21 // select the proper prefix for usage and other messages
22 string GetCommandPrefix(entity caller)
24 if (caller) { return "cmd"; } else { return "sv_cmd"; }
27 // if client return player nickname, or if server return admin nickname
28 string GetCallerName(entity caller)
30 if (caller) { return playername(caller, false); } else {
31 return (autocvar_sv_adminnick != "") ? autocvar_sv_adminnick : "SERVER ADMIN"; // autocvar_hostname
35 // verify that the client provided is acceptable for kicking
36 float VerifyKickableEntity(entity client)
38 if (!IS_REAL_CLIENT(client)) { return CLIENT_NOT_REAL; }
39 return CLIENT_ACCEPTABLE;
42 // verify that the client provided is acceptable for use
43 float VerifyClientEntity(entity client, float must_be_real, float must_be_bots)
45 if (!IS_CLIENT(client)) { return CLIENT_DOESNT_EXIST; } else if (must_be_real && !IS_REAL_CLIENT(client)) {
46 return CLIENT_NOT_REAL;
47 } else if (must_be_bots && !IS_BOT_CLIENT(client)) {
48 return CLIENT_NOT_BOT;
51 return CLIENT_ACCEPTABLE;
54 // if the client is not acceptable, return a string to be used for error messages
55 string GetClientErrorString_color(float clienterror, string original_input, string col)
57 switch (clienterror) {
58 case CLIENT_DOESNT_EXIST:
59 { return strcat(col, "Client '", original_input, col, "' doesn't exist");
62 { return strcat(col, "Client '", original_input, col, "' is not real");
65 { return strcat(col, "Client '", original_input, col, "' is not a bot");
68 { return "Incorrect usage of GetClientErrorString";
73 // is this entity number even in the possible range of entities?
74 float VerifyClientNumber(float tmp_number)
76 if ((tmp_number < 1) || (tmp_number > maxclients)) { return false; } else { return true; }
79 entity GetIndexedEntity(float argc, float start_index)
82 float tmp_number, index;
89 if (argc > start_index) {
90 if (substring(argv(index), 0, 1) == "#") {
91 tmp_string = substring(argv(index), 1, -1);
94 if (tmp_string != "") { // is it all one token? like #1
95 tmp_number = stof(tmp_string);
96 } else if (argc > index) { // no, it's two tokens? # 1
97 tmp_number = stof(argv(index));
102 } else { // maybe it's ONLY a number?
103 tmp_number = stof(argv(index));
107 if (VerifyClientNumber(tmp_number)) {
108 selection = edict_num(tmp_number); // yes, it was a number
109 } else { // no, maybe it's a name?
110 FOREACH_CLIENT(true, {
111 if (strdecolorize(it.netname) == strdecolorize(argv(start_index))) {
113 break; // no reason to keep looking
117 index = (start_index + 1);
122 // print(strcat("start_index: ", ftos(start_index), ", next_token: ", ftos(next_token), ", edict: ", ftos(num_for_edict(selection)), ".\n"));
126 // find a player which matches the input string, and return their entity
127 entity GetFilteredEntity(string input)
132 if (substring(input, 0, 1) == "#") { tmp_number = stof(substring(input, 1, -1)); } else { tmp_number = stof(input); }
134 if (VerifyClientNumber(tmp_number)) {
135 selection = edict_num(tmp_number);
138 FOREACH_CLIENT(true, {
139 if (strdecolorize(it.netname) == strdecolorize(input)) {
141 break; // no reason to keep looking
149 // same thing, but instead return their edict number
150 float GetFilteredNumber(string input)
152 entity selection = GetFilteredEntity(input);
155 output = etof(selection);
160 // switch between sprint and print depending on whether the receiver is the server or a player
161 void print_to(entity to, string input)
163 if (to) { sprint(to, strcat(input, "\n")); } else { print(input, "\n"); }
166 // ==========================================
167 // Supporting functions for common commands
168 // ==========================================
170 // used by CommonCommand_timeout() and CommonCommand_timein() to handle game pausing and messaging and such.
171 void timeout_handler_reset(entity this)
173 timeout_caller = NULL;
175 timeout_leadtime = 0;
180 void timeout_handler_think(entity this)
182 switch (timeout_status) {
185 if (timeout_time > 0) { // countdown is still going
186 Send_Notification(NOTIF_ALL, NULL, MSG_CENTER, CENTER_TIMEOUT_ENDING, timeout_time);
188 if (timeout_time == autocvar_sv_timeout_resumetime) { // play a warning sound when only <sv_timeout_resumetime> seconds are left
189 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_PREPARE);
192 this.nextthink = time + TIMEOUT_SLOWMO_VALUE; // think again in one second
193 timeout_time -= 1; // decrease the time counter
194 } else { // time to end the timeout
195 Kill_Notification(NOTIF_ALL, NULL, MSG_CENTER, CPID_TIMEIN);
196 timeout_status = TIMEOUT_INACTIVE;
198 // reset the slowmo value back to normal
199 cvar_set("slowmo", ftos(orig_slowmo));
201 // unlock the view for players so they can move around again
202 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), {
206 timeout_handler_reset(this);
212 case TIMEOUT_LEADTIME:
214 if (timeout_leadtime > 0) { // countdown is still going
215 Send_Notification(NOTIF_ALL, NULL, MSG_CENTER, CENTER_TIMEOUT_BEGINNING, timeout_leadtime);
217 this.nextthink = time + 1; // think again in one second
218 timeout_leadtime -= 1; // decrease the time counter
219 } else { // time to begin the timeout
220 timeout_status = TIMEOUT_ACTIVE;
222 // set the slowmo value to the timeout default slowmo value
223 cvar_set("slowmo", ftos(TIMEOUT_SLOWMO_VALUE));
225 // reset all the flood variables
226 FOREACH_CLIENT(true, {
227 it.nickspamcount = it.nickspamtime = it.floodcontrol_chat =
228 it.floodcontrol_chatteam = it.floodcontrol_chattell =
229 it.floodcontrol_voice = it.floodcontrol_voiceteam = 0;
232 // copy .v_angle to .lastV_angle for every player in order to fix their view during pause (see PlayerPreThink)
233 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), {
234 it.lastV_angle = it.v_angle;
237 this.nextthink = time; // think again next frame to handle it under TIMEOUT_ACTIVE code
244 case TIMEOUT_INACTIVE:
247 timeout_handler_reset(this);
254 // ===================================================
255 // Common commands used in both sv_cmd.qc and cmd.qc
256 // ===================================================
258 void CommonCommand_cvar_changes(float request, entity caller)
261 case CMD_REQUEST_COMMAND:
263 print_to(caller, cvar_changes);
264 return; // never fall through to usage
268 case CMD_REQUEST_USAGE:
270 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_changes"));
271 print_to(caller, " No arguments required.");
272 print_to(caller, "See also: ^2cvar_purechanges^7");
278 void CommonCommand_cvar_purechanges(float request, entity caller)
281 case CMD_REQUEST_COMMAND:
283 print_to(caller, cvar_purechanges);
284 return; // never fall through to usage
288 case CMD_REQUEST_USAGE:
290 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_purechanges"));
291 print_to(caller, " No arguments required.");
292 print_to(caller, "See also: ^2cvar_changes^7");
298 void CommonCommand_editmob(int request, entity caller, int argc)
301 case CMD_REQUEST_COMMAND:
303 if (autocvar_g_campaign) { print_to(caller, "Monster editing is disabled in singleplayer"); return; }
304 // no checks for g_monsters here, as it may be toggled mid match which existing monsters
307 makevectors(caller.v_angle);
308 WarpZone_TraceLine(caller.origin + caller.view_ofs, caller.origin + caller.view_ofs + v_forward * 100, MOVE_NORMAL, caller);
311 entity mon = trace_ent;
312 bool is_visible = IS_MONSTER(mon);
313 string argument = argv(2);
318 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
320 break; // escape to usage
322 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
323 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
324 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
326 string mon_oldname = mon.monster_name;
328 mon.monster_name = argument;
329 if (mon.sprite) { WaypointSprite_UpdateSprites(mon.sprite, WP_Monster, WP_Null, WP_Null); }
330 print_to(caller, sprintf("Your pet '%s' is now known as '%s'", mon_oldname, mon.monster_name));
335 if (!caller) { print_to(caller, "Only players can spawn monsters"); return; }
337 break; // escape to usage
339 int moveflag, tmp_moncount = 0;
340 string arg_lower = strtolower(argument);
341 moveflag = (argv(3)) ? stof(argv(3)) : 1; // follow owner if not defined
343 if (arg_lower == "list") { print_to(caller, monsterlist_reply); return; }
345 IL_EACH(g_monsters, it.realowner == caller,
350 if (!autocvar_g_monsters) { print_to(caller, "Monsters are disabled"); return; }
351 if (autocvar_g_monsters_max <= 0 || autocvar_g_monsters_max_perplayer <= 0) { print_to(caller, "Monster spawning is disabled"); return; }
352 if (!IS_PLAYER(caller)) { print_to(caller, "You must be playing to spawn a monster"); return; }
353 if (MUTATOR_CALLHOOK(AllowMobSpawning, caller)) { print_to(caller, M_ARGV(1, string)); return; }
354 if (caller.vehicle) { print_to(caller, "You can't spawn monsters while driving a vehicle"); return; }
355 if (STAT(FROZEN, caller)) { print_to(caller, "You can't spawn monsters while frozen"); return; }
356 if (IS_DEAD(caller)) { print_to(caller, "You can't spawn monsters while dead"); return; }
357 if (tmp_moncount >= autocvar_g_monsters_max) { print_to(caller, "The maximum monster count has been reached"); return; }
358 if (tmp_moncount >= autocvar_g_monsters_max_perplayer) { print_to(caller, "You can't spawn any more monsters"); return; }
361 FOREACH(Monsters, it != MON_Null && it.netname == arg_lower,
367 if (!found && arg_lower != "random") { print_to(caller, "Invalid monster"); return; }
370 WarpZone_TraceBox(CENTER_OR_VIEWOFS(caller), caller.mins, caller.maxs, CENTER_OR_VIEWOFS(caller) + v_forward * 150, true, caller);
371 mon = spawnmonster(spawn(), arg_lower, 0, caller, caller, trace_endpos, false, false, moveflag);
372 print_to(caller, strcat("Spawned ", mon.monster_name));
377 if (!caller) { print_to(caller, "Only players can kill monsters"); return; }
378 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
379 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
381 Damage(mon, NULL, NULL, mon.health + mon.max_health + 200, DEATH_KILL.m_id, mon.origin, '0 0 0');
382 print_to(caller, strcat("Your pet '", mon.monster_name, "' has been brutally mutilated"));
387 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
389 break; // escape to usage
391 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
392 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
393 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
394 if (mon.monsterid == MON_MAGE.monsterid) { print_to(caller, "Mage skins can't be changed"); return; } // TODO
396 mon.skin = stof(argument);
397 print_to(caller, strcat("Monster skin successfully changed to ", ftos(mon.skin)));
402 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
404 break; // escape to usage
406 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
407 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
408 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
410 mon.monster_moveflags = stof(argument);
411 print_to(caller, strcat("Monster move target successfully changed to ", ftos(mon.monster_moveflags)));
416 if (caller) { print_to(caller, "This command is not available to players"); return; }
417 if (MUTATOR_CALLHOOK(AllowMobButcher)) { LOG_INFOF("%s", M_ARGV(0, string)); return; }
419 int tmp_remcount = 0;
421 IL_EACH(g_monsters, true,
426 IL_CLEAR(g_monsters);
428 monsters_total = monsters_killed = totalspawned = 0;
430 print_to(caller, (tmp_remcount) ? sprintf("Killed %d monster%s", tmp_remcount, (tmp_remcount == 1) ? "" : "s") : "No monsters to kill");
437 case CMD_REQUEST_USAGE:
439 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " editmob command [arguments]"));
440 print_to(caller, " Where 'command' can be butcher spawn skin movetarget kill name");
441 print_to(caller, " spawn, skin, movetarget and name require 'arguments'");
442 print_to(caller, " spawn also takes arguments list and random");
443 print_to(caller, " Monster will follow owner if third argument of spawn command is not defined");
449 void CommonCommand_info(float request, entity caller, float argc)
452 case CMD_REQUEST_COMMAND:
454 string command = builtin_cvar_string(strcat("sv_info_", argv(1)));
456 if (command) { wordwrap_sprint(caller, command, 1000); } else { print_to(caller, "ERROR: unsupported info command"); }
458 return; // never fall through to usage
462 case CMD_REQUEST_USAGE:
464 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " info request"));
465 print_to(caller, " Where 'request' is the suffixed string appended onto the request for cvar.");
471 void CommonCommand_ladder(float request, entity caller)
474 case CMD_REQUEST_COMMAND:
476 print_to(caller, ladder_reply);
477 return; // never fall through to usage
481 case CMD_REQUEST_USAGE:
483 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " ladder"));
484 print_to(caller, " No arguments required.");
490 void CommonCommand_lsmaps(float request, entity caller)
493 case CMD_REQUEST_COMMAND:
495 print_to(caller, lsmaps_reply);
496 return; // never fall through to usage
500 case CMD_REQUEST_USAGE:
502 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " lsmaps"));
503 print_to(caller, " No arguments required.");
509 void CommonCommand_printmaplist(float request, entity caller)
512 case CMD_REQUEST_COMMAND:
514 print_to(caller, maplist_reply);
515 return; // never fall through to usage
519 case CMD_REQUEST_USAGE:
521 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " printmaplist"));
522 print_to(caller, " No arguments required.");
528 void CommonCommand_rankings(float request, entity caller)
531 case CMD_REQUEST_COMMAND:
533 print_to(caller, rankings_reply);
534 return; // never fall through to usage
538 case CMD_REQUEST_USAGE:
540 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " rankings"));
541 print_to(caller, " No arguments required.");
547 void CommonCommand_records(float request, entity caller)
550 case CMD_REQUEST_COMMAND:
552 int num = stoi(argv(1));
553 if (num > 0 && num <= 10 && records_reply[num - 1] != "") {
554 print_to(caller, records_reply[num - 1]);
556 for (int i = 0; i < 10; ++i) {
557 if (records_reply[i] != "") { print_to(caller, records_reply[i]); } }
560 return; // never fall through to usage
564 case CMD_REQUEST_USAGE:
566 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " records"));
567 print_to(caller, " No arguments required.");
573 void CommonCommand_teamstatus(float request, entity caller)
576 case CMD_REQUEST_COMMAND:
578 Score_NicePrint(caller);
579 return; // never fall through to usage
583 case CMD_REQUEST_USAGE:
585 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " teamstatus"));
586 print_to(caller, " No arguments required.");
592 void CommonCommand_time(float request, entity caller)
595 case CMD_REQUEST_COMMAND:
597 print_to(caller, strcat("time = ", ftos(time)));
598 print_to(caller, strcat("frame start = ", ftos(gettime(GETTIME_FRAMESTART))));
599 print_to(caller, strcat("realtime = ", ftos(gettime(GETTIME_REALTIME))));
600 print_to(caller, strcat("hires = ", ftos(gettime(GETTIME_HIRES))));
601 print_to(caller, strcat("uptime = ", ftos(gettime(GETTIME_UPTIME))));
602 print_to(caller, strcat("localtime = ", strftime(true, "%a %b %e %H:%M:%S %Z %Y")));
603 print_to(caller, strcat("gmtime = ", strftime(false, "%a %b %e %H:%M:%S %Z %Y")));
608 case CMD_REQUEST_USAGE:
610 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " time"));
611 print_to(caller, " No arguments required.");
617 void CommonCommand_timein(float request, entity caller)
620 case CMD_REQUEST_COMMAND:
622 if (!caller || autocvar_sv_timeout) {
623 if (!timeout_status) { print_to(caller, "^7Error: There is no active timeout called."); } else if (caller && (caller != timeout_caller)) {
624 print_to(caller, "^7Error: You are not allowed to stop the active timeout.");
625 } else { // everything should be okay, continue aborting timeout
626 switch (timeout_status) {
627 case TIMEOUT_LEADTIME:
629 timeout_status = TIMEOUT_INACTIVE;
631 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
632 bprint(strcat("^7The timeout was aborted by ", GetCallerName(caller), " !\n"));
638 timeout_time = autocvar_sv_timeout_resumetime;
639 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
640 bprint(strcat("^1Attention: ^7", GetCallerName(caller), " resumed the game! Prepare for battle!\n"));
644 default: LOG_TRACE("timeout status was inactive, but this code was executed anyway?");
648 } else { print_to(caller, "^1Timeins are not allowed to be called, enable them with sv_timeout 1.\n"); }
650 return; // never fall through to usage
654 case CMD_REQUEST_USAGE:
656 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timein"));
657 print_to(caller, " No arguments required.");
663 void CommonCommand_timeout(float request, entity caller) // DEAR GOD THIS COMMAND IS TERRIBLE.
666 case CMD_REQUEST_COMMAND:
668 if (!caller || autocvar_sv_timeout) {
669 float last_possible_timeout = ((autocvar_timelimit * 60) - autocvar_sv_timeout_leadtime - 1);
671 if (timeout_status) { print_to(caller, "^7Error: A timeout is already active."); } else if (vote_called) {
672 print_to(caller, "^7Error: You can not call a timeout while a vote is active.");
673 } else if (warmup_stage && !g_warmup_allow_timeout) {
674 print_to(caller, "^7Error: You can not call a timeout in warmup-stage.");
675 } else if (time < game_starttime) {
676 print_to(caller, "^7Error: You can not call a timeout while the map is being restarted.");
677 } else if (caller && (CS(caller).allowed_timeouts < 1)) {
678 print_to(caller, "^7Error: You already used all your timeout calls for this map.");
679 } else if (caller && !IS_PLAYER(caller)) {
680 print_to(caller, "^7Error: You must be a player to call a timeout.");
681 } else if ((autocvar_timelimit) && (last_possible_timeout < time - game_starttime)) {
682 print_to(caller, "^7Error: It is too late to call a timeout now!");
683 } else { // everything should be okay, proceed with starting the timeout
684 if (caller) { CS(caller).allowed_timeouts -= 1; }
685 // write a bprint who started the timeout (and how many they have left)
686 bprint(GetCallerName(caller), " ^7called a timeout", (caller ? strcat(" (", ftos(CS(caller).allowed_timeouts), " timeout(s) left)") : ""), "!\n");
688 timeout_status = TIMEOUT_LEADTIME;
689 timeout_caller = caller;
690 timeout_time = autocvar_sv_timeout_length;
691 timeout_leadtime = autocvar_sv_timeout_leadtime;
693 timeout_handler = spawn();
694 setthink(timeout_handler, timeout_handler_think);
695 timeout_handler.nextthink = time; // always let the entity think asap
697 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_TIMEOUT);
699 } else { print_to(caller, "^1Timeouts are not allowed to be called, enable them with sv_timeout 1.\n"); }
701 return; // never fall through to usage
705 case CMD_REQUEST_USAGE:
707 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timeout"));
708 print_to(caller, " No arguments required.");
714 void CommonCommand_who(float request, entity caller, float argc)
717 case CMD_REQUEST_COMMAND:
719 float total_listed_players, is_bot;
721 float privacy = (caller && autocvar_sv_status_privacy);
722 string separator = strreplace("%", " ", strcat((argv(1) ? argv(1) : " "), "^7"));
723 string tmp_netaddress, tmp_crypto_idfp;
725 print_to(caller, strcat("List of client information", (privacy ? " (some data is hidden for privacy)" : ""), ":"));
726 print_to(caller, sprintf(strreplace(" ", separator, " %-4s %-20s %-5s %-3s %-9s %-16s %s "),
727 "ent", "nickname", "ping", "pl", "time", "ip", "crypto_id"));
729 total_listed_players = 0;
730 FOREACH_CLIENT(true, {
731 is_bot = (IS_BOT_CLIENT(it));
734 tmp_netaddress = "null/botclient";
735 tmp_crypto_idfp = "null/botclient";
736 } else if (privacy) {
737 tmp_netaddress = "hidden";
738 tmp_crypto_idfp = "hidden";
740 tmp_netaddress = it.netaddress;
741 tmp_crypto_idfp = it.crypto_idfp;
744 print_to(caller, sprintf(strreplace(" ", separator, " #%-3d %-20.20s %-5d %-3d %-9s %-16s %s "),
748 CS(it).ping_packetloss,
749 process_time(1, time - CS(it).jointime),
753 ++total_listed_players;
756 print_to(caller, strcat("Finished listing ", ftos(total_listed_players), " client(s) out of ", ftos(maxclients), " slots."));
758 return; // never fall through to usage
762 case CMD_REQUEST_USAGE:
764 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " who [separator]"));
765 print_to(caller, " Where 'separator' is the optional string to separate the values with, default is a space.");
771 /* use this when creating a new command, making sure to place it in alphabetical order... also,
772 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
773 void CommonCommand_(float request, entity caller)
777 case CMD_REQUEST_COMMAND:
780 return; // never fall through to usage
784 case CMD_REQUEST_USAGE:
786 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " "));
787 print_to(caller, " No arguments required.");