3 #include <server/chat.qh>
4 #include <server/client.qh>
5 #include <server/mutators/_mod.qh>
6 #include <common/weapons/_all.qh>
7 #include <common/stats.qh>
8 #include <server/world.qh>
10 #include <common/command/_mod.qh>
13 #include "../scores.qh"
15 #include <common/monsters/_mod.qh>
16 #include <common/notifications/all.qh>
17 #include <lib/warpzone/common.qh>
20 // ====================================================
21 // Shared code for server commands, written by Samual
22 // Last updated: December 27th, 2011
23 // ====================================================
25 // select the proper prefix for usage and other messages
26 string GetCommandPrefix(entity caller)
28 if (caller) return "cmd";
32 // if client return player nickname, or if server return admin nickname
33 string GetCallerName(entity caller)
35 if (caller) return playername(caller.netname, caller.team, false);
36 else return ((autocvar_sv_adminnick != "") ? autocvar_sv_adminnick : "SERVER ADMIN"); // autocvar_hostname
39 // verify that the client provided is acceptable for kicking
40 float VerifyKickableEntity(entity client)
42 if (!IS_REAL_CLIENT(client)) return CLIENT_NOT_REAL;
43 return CLIENT_ACCEPTABLE;
46 // verify that the client provided is acceptable for use
47 float VerifyClientEntity(entity client, float must_be_real, float must_be_bots)
49 if (!IS_CLIENT(client)) return CLIENT_DOESNT_EXIST;
50 else if (must_be_real && !IS_REAL_CLIENT(client)) return CLIENT_NOT_REAL;
51 else if (must_be_bots && !IS_BOT_CLIENT(client)) return CLIENT_NOT_BOT;
53 return CLIENT_ACCEPTABLE;
56 // if the client is not acceptable, return a string to be used for error messages
57 string GetClientErrorString_color(float clienterror, string original_input, string col)
61 case CLIENT_DOESNT_EXIST:
62 { return strcat(col, "Client '", original_input, col, "' doesn't exist");
65 { return strcat(col, "Client '", original_input, col, "' is not real");
68 { return strcat(col, "Client '", original_input, col, "' is not a bot");
71 { return "Incorrect usage of GetClientErrorString";
76 // is this entity number even in the possible range of entities?
77 float VerifyClientNumber(float tmp_number)
79 if ((tmp_number < 1) || (tmp_number > maxclients)) return false;
83 entity GetIndexedEntity(int argc, float start_index)
86 float tmp_number, index;
93 if (argc > start_index)
95 if (substring(argv(index), 0, 1) == "#")
97 tmp_string = substring(argv(index), 1, -1);
100 if (tmp_string != "") // is it all one token? like #1
102 tmp_number = stof(tmp_string);
104 else if (argc > index) // no, it's two tokens? # 1
106 tmp_number = stof(argv(index));
114 else // maybe it's ONLY a number?
116 tmp_number = stof(argv(index));
120 if (VerifyClientNumber(tmp_number))
122 selection = edict_num(tmp_number); // yes, it was a number
124 else // no, maybe it's a name?
126 FOREACH_CLIENT(true, {
127 if(strdecolorize(it.netname) == strdecolorize(argv(start_index)))
130 break; // no reason to keep looking
134 index = (start_index + 1);
139 // print(strcat("start_index: ", ftos(start_index), ", next_token: ", ftos(next_token), ", edict: ", ftos(num_for_edict(selection)), ".\n"));
143 // find a player which matches the input string, and return their entity
144 entity GetFilteredEntity(string input)
149 if (substring(input, 0, 1) == "#") tmp_number = stof(substring(input, 1, -1));
150 else tmp_number = stof(input);
152 if (VerifyClientNumber(tmp_number))
154 selection = edict_num(tmp_number);
159 FOREACH_CLIENT(true, {
160 if(strdecolorize(it.netname) == strdecolorize(input))
163 break; // no reason to keep looking
171 // same thing, but instead return their edict number
172 float GetFilteredNumber(string input)
174 entity selection = GetFilteredEntity(input);
177 output = etof(selection);
182 // switch between sprint and print depending on whether the receiver is the server or a player
183 void print_to(entity to, string input)
185 if (to) sprint(to, strcat(input, "\n"));
186 else print(input, "\n");
189 // ==========================================
190 // Supporting functions for common commands
191 // ==========================================
193 // used by CommonCommand_timeout() and CommonCommand_timein() to handle game pausing and messaging and such.
194 void timeout_handler_reset(entity this)
196 timeout_caller = NULL;
198 timeout_leadtime = 0;
203 void timeout_handler_think(entity this)
205 switch (timeout_status)
209 if (timeout_time > 0) // countdown is still going
211 Send_Notification(NOTIF_ALL, NULL, MSG_CENTER, CENTER_TIMEOUT_ENDING, timeout_time);
213 if (timeout_time == autocvar_sv_timeout_resumetime) // play a warning sound when only <sv_timeout_resumetime> seconds are left
214 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_PREPARE);
216 this.nextthink = time + TIMEOUT_SLOWMO_VALUE; // think again in one second
217 timeout_time -= 1; // decrease the time counter
219 else // time to end the timeout
221 Kill_Notification(NOTIF_ALL, NULL, MSG_CENTER, CPID_TIMEIN);
222 timeout_status = TIMEOUT_INACTIVE;
224 // reset the slowmo value back to normal
225 cvar_set("slowmo", ftos(orig_slowmo));
227 // unlock the view for players so they can move around again
228 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), {
232 timeout_handler_reset(this);
238 case TIMEOUT_LEADTIME:
240 if (timeout_leadtime > 0) // countdown is still going
242 Send_Notification(NOTIF_ALL, NULL, MSG_CENTER, CENTER_TIMEOUT_BEGINNING, timeout_leadtime);
244 this.nextthink = time + 1; // think again in one second
245 timeout_leadtime -= 1; // decrease the time counter
247 else // time to begin the timeout
249 timeout_status = TIMEOUT_ACTIVE;
251 // set the slowmo value to the timeout default slowmo value
252 cvar_set("slowmo", ftos(TIMEOUT_SLOWMO_VALUE));
254 // reset all the flood variables
255 FOREACH_CLIENT(true, {
256 it.nickspamcount = it.nickspamtime = it.floodcontrol_chat =
257 it.floodcontrol_chatteam = it.floodcontrol_chattell =
258 it.floodcontrol_voice = it.floodcontrol_voiceteam = 0;
261 // copy .v_angle to .lastV_angle for every player in order to fix their view during pause (see PlayerPreThink)
262 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), {
263 it.lastV_angle = it.v_angle;
266 this.nextthink = time; // think again next frame to handle it under TIMEOUT_ACTIVE code
273 case TIMEOUT_INACTIVE:
276 timeout_handler_reset(this);
283 // ===================================================
284 // Common commands used in both sv_cmd.qc and cmd.qc
285 // ===================================================
287 void CommonCommand_cvar_changes(int request, entity caller)
291 case CMD_REQUEST_COMMAND:
293 print_to(caller, cvar_changes);
294 return; // never fall through to usage
298 case CMD_REQUEST_USAGE:
300 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_changes"));
301 print_to(caller, " No arguments required.");
302 print_to(caller, "See also: ^2cvar_purechanges^7");
308 void CommonCommand_cvar_purechanges(int request, entity caller)
312 case CMD_REQUEST_COMMAND:
314 print_to(caller, cvar_purechanges);
315 return; // never fall through to usage
319 case CMD_REQUEST_USAGE:
321 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_purechanges"));
322 print_to(caller, " No arguments required.");
323 print_to(caller, "See also: ^2cvar_changes^7");
329 void CommonCommand_editmob(int request, entity caller, int argc)
333 case CMD_REQUEST_COMMAND:
335 if (autocvar_g_campaign) { print_to(caller, "Monster editing is disabled in singleplayer"); return; }
336 // no checks for g_monsters here, as it may be toggled mid match which existing monsters
340 makevectors(caller.v_angle);
341 WarpZone_TraceLine(caller.origin + caller.view_ofs, caller.origin + caller.view_ofs + v_forward * 100, MOVE_NORMAL, caller);
344 entity mon = trace_ent;
345 bool is_visible = IS_MONSTER(mon);
346 string argument = argv(2);
352 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
353 if (!argument) break; // escape to usage
354 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
355 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
356 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
358 string mon_oldname = mon.monster_name;
360 mon.monster_name = argument;
361 if (mon.sprite) WaypointSprite_UpdateSprites(mon.sprite, WP_Monster, WP_Null, WP_Null);
362 print_to(caller, sprintf("Your pet '%s' is now known as '%s'", mon_oldname, mon.monster_name));
367 if (!caller) { print_to(caller, "Only players can spawn monsters"); return; }
368 if (!argv(2)) break; // escape to usage
370 int moveflag, tmp_moncount = 0;
371 string arg_lower = strtolower(argument);
372 moveflag = (argv(3)) ? stof(argv(3)) : 1; // follow owner if not defined
374 if (arg_lower == "list") { print_to(caller, monsterlist_reply); return; }
376 IL_EACH(g_monsters, it.realowner == caller,
381 if (!autocvar_g_monsters) { print_to(caller, "Monsters are disabled"); return; }
382 if (autocvar_g_monsters_max <= 0 || autocvar_g_monsters_max_perplayer <= 0) { print_to(caller, "Monster spawning is disabled"); return; }
383 if (!IS_PLAYER(caller)) { print_to(caller, "You must be playing to spawn a monster"); return; }
384 if (MUTATOR_CALLHOOK(AllowMobSpawning, caller)) { print_to(caller, M_ARGV(1, string)); return; }
385 if (caller.vehicle) { print_to(caller, "You can't spawn monsters while driving a vehicle"); return; }
386 if (STAT(FROZEN, caller)) { print_to(caller, "You can't spawn monsters while frozen"); return; }
387 if (IS_DEAD(caller)) { print_to(caller, "You can't spawn monsters while dead"); return; }
388 if (tmp_moncount >= autocvar_g_monsters_max) { print_to(caller, "The maximum monster count has been reached"); return; }
389 if (tmp_moncount >= autocvar_g_monsters_max_perplayer) { print_to(caller, "You can't spawn any more monsters"); return; }
392 FOREACH(Monsters, it != MON_Null && it.netname == arg_lower,
398 if (!found && arg_lower != "random" && arg_lower != "anyrandom") { print_to(caller, "Invalid monster"); return; }
401 WarpZone_TraceBox(CENTER_OR_VIEWOFS(caller), caller.mins, caller.maxs, CENTER_OR_VIEWOFS(caller) + v_forward * 150, true, caller);
402 mon = spawnmonster(spawn(), arg_lower, MON_Null, caller, caller, trace_endpos, false, false, moveflag);
403 print_to(caller, strcat("Spawned ", mon.monster_name));
408 if (!caller) { print_to(caller, "Only players can kill monsters"); return; }
409 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
410 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
412 Damage(mon, NULL, NULL, GetResource(mon, RES_HEALTH) + mon.max_health + 200, DEATH_KILL.m_id, DMG_NOWEP, mon.origin, '0 0 0');
413 print_to(caller, strcat("Your pet '", mon.monster_name, "' has been brutally mutilated"));
418 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
419 if (!argument) break; // escape to usage
420 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
421 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
422 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
423 if (mon.monsterdef == MON_MAGE) { print_to(caller, "Mage skins can't be changed"); return; } // TODO
425 mon.skin = stof(argument);
426 print_to(caller, strcat("Monster skin successfully changed to ", ftos(mon.skin)));
431 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
432 if (!argument) break; // escape to usage
433 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
434 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
435 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
437 mon.monster_moveflags = stof(argument);
438 print_to(caller, strcat("Monster move target successfully changed to ", ftos(mon.monster_moveflags)));
443 if (caller) { print_to(caller, "This command is not available to players"); return; }
444 if (MUTATOR_CALLHOOK(AllowMobButcher)) { LOG_INFO(M_ARGV(0, string)); return; }
446 int tmp_remcount = 0;
448 IL_EACH(g_monsters, true,
453 IL_CLEAR(g_monsters);
455 monsters_total = monsters_killed = totalspawned = 0;
457 print_to(caller, (tmp_remcount) ? sprintf("Killed %d monster%s", tmp_remcount, (tmp_remcount == 1) ? "" : "s") : "No monsters to kill");
464 case CMD_REQUEST_USAGE:
466 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " editmob command [arguments]"));
467 print_to(caller, " Where 'command' can be butcher spawn skin movetarget kill name");
468 print_to(caller, " spawn, skin, movetarget and name require 'arguments'");
469 print_to(caller, " spawn also takes arguments list and random");
470 print_to(caller, " Monster will follow owner if third argument of spawn command is not defined");
476 void CommonCommand_info(int request, entity caller, int argc)
480 case CMD_REQUEST_COMMAND:
482 string command = cvar_string(strcat("sv_info_", argv(1)));
484 if (command) wordwrap_sprint(caller, command, 1000);
485 else print_to(caller, "ERROR: unsupported info command");
487 return; // never fall through to usage
491 case CMD_REQUEST_USAGE:
493 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " info request"));
494 print_to(caller, " Where 'request' is the suffixed string appended onto the request for cvar.");
500 void CommonCommand_ladder(int request, entity caller)
504 case CMD_REQUEST_COMMAND:
506 print_to(caller, ladder_reply);
507 return; // never fall through to usage
511 case CMD_REQUEST_USAGE:
513 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " ladder"));
514 print_to(caller, " No arguments required.");
520 void CommonCommand_lsmaps(int request, entity caller)
524 case CMD_REQUEST_COMMAND:
526 print_to(caller, lsmaps_reply);
527 return; // never fall through to usage
531 case CMD_REQUEST_USAGE:
533 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " lsmaps"));
534 print_to(caller, " No arguments required.");
540 void CommonCommand_printmaplist(int request, entity caller)
544 case CMD_REQUEST_COMMAND:
546 print_to(caller, maplist_reply);
547 return; // never fall through to usage
551 case CMD_REQUEST_USAGE:
553 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " printmaplist"));
554 print_to(caller, " No arguments required.");
560 void CommonCommand_rankings(int request, entity caller)
564 case CMD_REQUEST_COMMAND:
566 print_to(caller, rankings_reply);
567 return; // never fall through to usage
571 case CMD_REQUEST_USAGE:
573 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " rankings"));
574 print_to(caller, " No arguments required.");
580 void CommonCommand_records(int request, entity caller)
584 case CMD_REQUEST_COMMAND:
586 int num = stoi(argv(1));
587 if(num > 0 && num <= 10 && records_reply[num - 1] != "")
588 print_to(caller, records_reply[num - 1]);
591 for (int i = 0; i < 10; ++i)
592 if (records_reply[i] != "") print_to(caller, records_reply[i]);
595 return; // never fall through to usage
599 case CMD_REQUEST_USAGE:
601 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " records"));
602 print_to(caller, " No arguments required.");
608 void CommonCommand_teamstatus(int request, entity caller)
612 case CMD_REQUEST_COMMAND:
614 Score_NicePrint(caller);
615 return; // never fall through to usage
619 case CMD_REQUEST_USAGE:
621 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " teamstatus"));
622 print_to(caller, " No arguments required.");
628 void CommonCommand_time(int request, entity caller)
632 case CMD_REQUEST_COMMAND:
634 print_to(caller, strcat("time = ", ftos(time)));
635 print_to(caller, strcat("frame start = ", ftos(gettime(GETTIME_FRAMESTART))));
636 print_to(caller, strcat("realtime = ", ftos(gettime(GETTIME_REALTIME))));
637 print_to(caller, strcat("hires = ", ftos(gettime(GETTIME_HIRES))));
638 print_to(caller, strcat("uptime = ", ftos(gettime(GETTIME_UPTIME))));
639 print_to(caller, strcat("localtime = ", strftime(true, "%a %b %d %H:%M:%S %Z %Y")));
640 print_to(caller, strcat("gmtime = ", strftime(false, "%a %b %d %H:%M:%S %Z %Y")));
645 case CMD_REQUEST_USAGE:
647 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " time"));
648 print_to(caller, " No arguments required.");
654 void CommonCommand_timein(int request, entity caller)
658 case CMD_REQUEST_COMMAND:
660 if (!caller || autocvar_sv_timeout)
662 if (!timeout_status) { print_to(caller, "^7Error: There is no active timeout called."); }
663 else if (caller && (caller != timeout_caller))
665 print_to(caller, "^7Error: You are not allowed to stop the active timeout.");
668 else // everything should be okay, continue aborting timeout
670 switch (timeout_status)
672 case TIMEOUT_LEADTIME:
674 timeout_status = TIMEOUT_INACTIVE;
676 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
677 bprint(strcat("^7The timeout was aborted by ", GetCallerName(caller), " !\n"));
683 timeout_time = autocvar_sv_timeout_resumetime;
684 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
685 bprint(strcat("^1Attention: ^7", GetCallerName(caller), " resumed the game! Prepare for battle!\n"));
689 default: LOG_TRACE("timeout status was inactive, but this code was executed anyway?");
694 else { print_to(caller, "^1Timeins are not allowed to be called, enable them with sv_timeout 1.\n"); }
696 return; // never fall through to usage
700 case CMD_REQUEST_USAGE:
702 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timein"));
703 print_to(caller, " No arguments required.");
709 void CommonCommand_timeout(int request, entity caller) // DEAR GOD THIS COMMAND IS TERRIBLE.
713 case CMD_REQUEST_COMMAND:
715 if (!caller || autocvar_sv_timeout)
717 float last_possible_timeout = ((autocvar_timelimit * 60) - autocvar_sv_timeout_leadtime - 1);
719 if (timeout_status) { print_to(caller, "^7Error: A timeout is already active."); }
720 else if (vote_called)
722 print_to(caller, "^7Error: You can not call a timeout while a vote is active.");
724 else if (warmup_stage && !autocvar_g_warmup_allow_timeout)
726 print_to(caller, "^7Error: You can not call a timeout in warmup-stage.");
728 else if (time < game_starttime)
730 print_to(caller, "^7Error: You can not call a timeout while the map is being restarted.");
732 else if (caller && (CS(caller).allowed_timeouts < 1))
734 print_to(caller, "^7Error: You already used all your timeout calls for this map.");
736 else if (caller && !IS_PLAYER(caller))
738 print_to(caller, "^7Error: You must be a player to call a timeout.");
740 else if ((autocvar_timelimit) && (last_possible_timeout < time - game_starttime))
742 print_to(caller, "^7Error: It is too late to call a timeout now!");
745 else // everything should be okay, proceed with starting the timeout
747 if (caller) CS(caller).allowed_timeouts -= 1;
748 // write a bprint who started the timeout (and how many they have left)
749 bprint(GetCallerName(caller), " ^7called a timeout", (caller ? strcat(" (", ftos(CS(caller).allowed_timeouts), " timeout(s) left)") : ""), "!\n");
751 timeout_status = TIMEOUT_LEADTIME;
752 timeout_caller = caller;
753 timeout_time = autocvar_sv_timeout_length;
754 timeout_leadtime = autocvar_sv_timeout_leadtime;
756 timeout_handler = spawn();
757 setthink(timeout_handler, timeout_handler_think);
758 timeout_handler.nextthink = time; // always let the entity think asap
760 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_TIMEOUT);
763 else { print_to(caller, "^1Timeouts are not allowed to be called, enable them with sv_timeout 1.\n"); }
765 return; // never fall through to usage
769 case CMD_REQUEST_USAGE:
771 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timeout"));
772 print_to(caller, " No arguments required.");
778 void CommonCommand_who(int request, entity caller, int argc)
782 case CMD_REQUEST_COMMAND:
784 float total_listed_players, is_bot;
786 float privacy = (caller && autocvar_sv_status_privacy);
787 string separator = strreplace("%", " ", strcat((argv(1) ? argv(1) : " "), "^7"));
788 string tmp_netaddress, tmp_crypto_idfp;
790 print_to(caller, strcat("List of client information", (privacy ? " (some data is hidden for privacy)" : ""), ":"));
791 print_to(caller, sprintf(strreplace(" ", separator, " %-4s %-20s %-5s %-3s %-9s %-16s %s "),
792 "ent", "nickname", "ping", "pl", "time", "ip", "crypto_id"));
794 total_listed_players = 0;
795 FOREACH_CLIENT(true, {
796 is_bot = (IS_BOT_CLIENT(it));
800 tmp_netaddress = "null/botclient";
801 tmp_crypto_idfp = "null/botclient";
805 tmp_netaddress = "hidden";
806 tmp_crypto_idfp = "hidden";
810 tmp_netaddress = it.netaddress;
811 tmp_crypto_idfp = it.crypto_idfp;
814 print_to(caller, sprintf(strreplace(" ", separator, " #%-3d %-20.20s %-5d %-3d %-9s %-16s %s "),
818 CS(it).ping_packetloss,
819 process_time(1, time - CS(it).jointime),
823 ++total_listed_players;
826 print_to(caller, strcat("Finished listing ", ftos(total_listed_players), " client(s) out of ", ftos(maxclients), " slots."));
828 return; // never fall through to usage
832 case CMD_REQUEST_USAGE:
834 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " who [separator]"));
835 print_to(caller, " Where 'separator' is the optional string to separate the values with, default is a space.");
841 /* use this when creating a new command, making sure to place it in alphabetical order... also,
842 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
843 void CommonCommand_(int request, entity caller)
847 case CMD_REQUEST_COMMAND:
850 return; // never fall through to usage
854 case CMD_REQUEST_USAGE:
856 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " "));
857 print_to(caller, " No arguments required.");