3 #include <common/command/_mod.qh>
4 #include <common/monsters/_mod.qh>
5 #include <common/notifications/all.qh>
6 #include <common/stats.qh>
7 #include <common/weapons/_all.qh>
8 #include <lib/warpzone/common.qh>
9 #include <server/chat.qh>
10 #include <server/client.qh>
11 #include <server/command/common.qh>
12 #include <server/mutators/_mod.qh>
13 #include <server/scores.qh>
14 #include <server/world.qh>
17 // ====================================================
18 // Shared code for server commands, written by Samual
19 // Last updated: December 27th, 2011
20 // ====================================================
22 // select the proper prefix for usage and other messages
23 string GetCommandPrefix(entity caller)
25 if (caller) return "cmd";
29 // if client return player nickname, or if server return admin nickname
30 string GetCallerName(entity caller)
32 if (caller) return playername(caller.netname, caller.team, false);
33 else return ((autocvar_sv_adminnick != "") ? autocvar_sv_adminnick : "SERVER ADMIN"); // autocvar_hostname
36 // verify that the client provided is acceptable for kicking
37 float VerifyKickableEntity(entity client)
39 if (!IS_REAL_CLIENT(client)) return CLIENT_NOT_REAL;
40 return CLIENT_ACCEPTABLE;
43 // verify that the client provided is acceptable for use
44 float VerifyClientEntity(entity client, float must_be_real, float must_be_bots)
46 if (!IS_CLIENT(client)) return CLIENT_DOESNT_EXIST;
47 else if (must_be_real && !IS_REAL_CLIENT(client)) return CLIENT_NOT_REAL;
48 else if (must_be_bots && !IS_BOT_CLIENT(client)) return CLIENT_NOT_BOT;
50 return CLIENT_ACCEPTABLE;
53 // if the client is not acceptable, return a string to be used for error messages
54 string GetClientErrorString_color(float clienterror, string original_input, string col)
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;
80 entity GetIndexedEntity(int argc, float start_index)
83 float tmp_number, index;
90 if (argc > start_index)
92 if (substring(argv(index), 0, 1) == "#")
94 tmp_string = substring(argv(index), 1, -1);
97 if (tmp_string != "") // is it all one token? like #1
99 tmp_number = stof(tmp_string);
101 else if (argc > index) // no, it's two tokens? # 1
103 tmp_number = stof(argv(index));
111 else // maybe it's ONLY a number?
113 tmp_number = stof(argv(index));
117 if (VerifyClientNumber(tmp_number))
119 selection = edict_num(tmp_number); // yes, it was a number
121 else // no, maybe it's a name?
123 FOREACH_CLIENT(true, {
124 if(strdecolorize(it.netname) == strdecolorize(argv(start_index)))
127 break; // no reason to keep looking
131 index = (start_index + 1);
136 // print(strcat("start_index: ", ftos(start_index), ", next_token: ", ftos(next_token), ", edict: ", ftos(num_for_edict(selection)), ".\n"));
140 // find a player which matches the input string, and return their entity
141 entity GetFilteredEntity(string input)
146 if (substring(input, 0, 1) == "#") tmp_number = stof(substring(input, 1, -1));
147 else tmp_number = stof(input);
149 if (VerifyClientNumber(tmp_number))
151 selection = edict_num(tmp_number);
156 FOREACH_CLIENT(true, {
157 if(strdecolorize(it.netname) == strdecolorize(input))
160 break; // no reason to keep looking
168 // same thing, but instead return their edict number
169 float GetFilteredNumber(string input)
171 entity selection = GetFilteredEntity(input);
174 output = etof(selection);
179 // switch between sprint and print depending on whether the receiver is the server or a player
180 void print_to(entity to, string input)
182 if (to) sprint(to, strcat(input, "\n"));
183 else print(input, "\n");
186 // ==========================================
187 // Supporting functions for common commands
188 // ==========================================
190 // used by CommonCommand_timeout() and CommonCommand_timein() to handle game pausing and messaging and such.
191 void timeout_handler_reset(entity this)
193 timeout_caller = NULL;
195 timeout_leadtime = 0;
200 void timeout_handler_think(entity this)
202 switch (timeout_status)
206 if (timeout_time > 0) // countdown is still going
208 Send_Notification(NOTIF_ALL, NULL, MSG_CENTER, CENTER_TIMEOUT_ENDING, timeout_time);
210 if (timeout_time == autocvar_sv_timeout_resumetime) // play a warning sound when only <sv_timeout_resumetime> seconds are left
211 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_PREPARE);
213 this.nextthink = time + TIMEOUT_SLOWMO_VALUE; // think again in one second
214 timeout_time -= 1; // decrease the time counter
216 else // time to end the timeout
218 Kill_Notification(NOTIF_ALL, NULL, MSG_CENTER, CPID_TIMEIN);
219 timeout_status = TIMEOUT_INACTIVE;
221 // reset the slowmo value back to normal
222 cvar_set("slowmo", ftos(orig_slowmo));
224 // unlock the view for players so they can move around again
225 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), {
229 timeout_handler_reset(this);
235 case TIMEOUT_LEADTIME:
237 if (timeout_leadtime > 0) // countdown is still going
239 Send_Notification(NOTIF_ALL, NULL, MSG_CENTER, CENTER_TIMEOUT_BEGINNING, timeout_leadtime);
241 this.nextthink = time + 1; // think again in one second
242 timeout_leadtime -= 1; // decrease the time counter
244 else // time to begin the timeout
246 timeout_status = TIMEOUT_ACTIVE;
248 // set the slowmo value to the timeout default slowmo value
249 cvar_set("slowmo", ftos(TIMEOUT_SLOWMO_VALUE));
251 // reset all the flood variables
252 FOREACH_CLIENT(true, {
253 it.nickspamcount = it.nickspamtime = it.floodcontrol_chat =
254 it.floodcontrol_chatteam = it.floodcontrol_chattell =
255 it.floodcontrol_voice = it.floodcontrol_voiceteam = 0;
258 // copy .v_angle to .lastV_angle for every player in order to fix their view during pause (see PlayerPreThink)
259 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), {
260 it.lastV_angle = it.v_angle;
263 this.nextthink = time; // think again next frame to handle it under TIMEOUT_ACTIVE code
270 case TIMEOUT_INACTIVE:
273 timeout_handler_reset(this);
280 // ===================================================
281 // Common commands used in both sv_cmd.qc and cmd.qc
282 // ===================================================
284 void CommonCommand_cvar_changes(int request, entity caller)
288 case CMD_REQUEST_COMMAND:
290 print_to(caller, cvar_changes);
291 return; // never fall through to usage
295 case CMD_REQUEST_USAGE:
297 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_changes"));
298 print_to(caller, " No arguments required.");
299 print_to(caller, "See also: ^2cvar_purechanges^7");
305 void CommonCommand_cvar_purechanges(int request, entity caller)
309 case CMD_REQUEST_COMMAND:
311 print_to(caller, cvar_purechanges);
312 return; // never fall through to usage
316 case CMD_REQUEST_USAGE:
318 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_purechanges"));
319 print_to(caller, " No arguments required.");
320 print_to(caller, "See also: ^2cvar_changes^7");
326 void CommonCommand_editmob(int request, entity caller, int argc)
330 case CMD_REQUEST_COMMAND:
332 if (autocvar_g_campaign) { print_to(caller, "Monster editing is disabled in singleplayer"); return; }
333 // no checks for g_monsters here, as it may be toggled mid match which existing monsters
337 makevectors(caller.v_angle);
338 WarpZone_TraceLine(caller.origin + caller.view_ofs, caller.origin + caller.view_ofs + v_forward * 100, MOVE_NORMAL, caller);
341 entity mon = trace_ent;
342 bool is_visible = IS_MONSTER(mon);
343 string argument = argv(2);
349 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
350 if (!argument) break; // escape to usage
351 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
352 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
353 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
355 string mon_oldname = mon.monster_name;
357 mon.monster_name = argument;
358 if (mon.sprite) WaypointSprite_UpdateSprites(mon.sprite, WP_Monster, WP_Null, WP_Null);
359 print_to(caller, sprintf("Your pet '%s' is now known as '%s'", mon_oldname, mon.monster_name));
364 if (!caller) { print_to(caller, "Only players can spawn monsters"); return; }
365 if (!argv(2)) break; // escape to usage
367 int moveflag, tmp_moncount = 0;
368 string arg_lower = strtolower(argument);
369 moveflag = (argv(3)) ? stof(argv(3)) : 1; // follow owner if not defined
371 if (arg_lower == "list") { print_to(caller, monsterlist_reply); return; }
373 IL_EACH(g_monsters, it.realowner == caller,
378 if (!autocvar_g_monsters) { print_to(caller, "Monsters are disabled"); return; }
379 if (autocvar_g_monsters_max <= 0 || autocvar_g_monsters_max_perplayer <= 0) { print_to(caller, "Monster spawning is disabled"); return; }
380 if (!IS_PLAYER(caller)) { print_to(caller, "You must be playing to spawn a monster"); return; }
381 if (MUTATOR_CALLHOOK(AllowMobSpawning, caller)) { print_to(caller, M_ARGV(1, string)); return; }
382 if (caller.vehicle) { print_to(caller, "You can't spawn monsters while driving a vehicle"); return; }
383 if (STAT(FROZEN, caller)) { print_to(caller, "You can't spawn monsters while frozen"); return; }
384 if (IS_DEAD(caller)) { print_to(caller, "You can't spawn monsters while dead"); return; }
385 if (tmp_moncount >= autocvar_g_monsters_max) { print_to(caller, "The maximum monster count has been reached"); return; }
386 if (tmp_moncount >= autocvar_g_monsters_max_perplayer) { print_to(caller, "You can't spawn any more monsters"); return; }
389 FOREACH(Monsters, it != MON_Null && it.netname == arg_lower,
395 if (!found && arg_lower != "random" && arg_lower != "anyrandom") { print_to(caller, "Invalid monster"); return; }
398 WarpZone_TraceBox(CENTER_OR_VIEWOFS(caller), caller.mins, caller.maxs, CENTER_OR_VIEWOFS(caller) + v_forward * 150, true, caller);
399 mon = spawnmonster(spawn(), arg_lower, MON_Null, caller, caller, trace_endpos, false, false, moveflag);
400 print_to(caller, strcat("Spawned ", mon.monster_name));
405 if (!caller) { print_to(caller, "Only players can kill monsters"); return; }
406 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
407 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
409 Damage(mon, NULL, NULL, GetResource(mon, RES_HEALTH) + mon.max_health + 200, DEATH_KILL.m_id, DMG_NOWEP, mon.origin, '0 0 0');
410 print_to(caller, strcat("Your pet '", mon.monster_name, "' has been brutally mutilated"));
415 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
416 if (!argument) break; // escape to usage
417 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
418 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
419 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
420 if (mon.monsterdef == MON_MAGE) { print_to(caller, "Mage skins can't be changed"); return; } // TODO
422 mon.skin = stof(argument);
423 print_to(caller, strcat("Monster skin successfully changed to ", ftos(mon.skin)));
428 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
429 if (!argument) break; // escape to usage
430 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
431 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
432 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
434 mon.monster_moveflags = stof(argument);
435 print_to(caller, strcat("Monster move target successfully changed to ", ftos(mon.monster_moveflags)));
440 if (caller) { print_to(caller, "This command is not available to players"); return; }
441 if (MUTATOR_CALLHOOK(AllowMobButcher)) { LOG_INFO(M_ARGV(0, string)); return; }
443 int tmp_remcount = 0;
445 IL_EACH(g_monsters, true,
450 IL_CLEAR(g_monsters);
452 monsters_total = monsters_killed = totalspawned = 0;
454 print_to(caller, (tmp_remcount) ? sprintf("Killed %d monster%s", tmp_remcount, (tmp_remcount == 1) ? "" : "s") : "No monsters to kill");
461 case CMD_REQUEST_USAGE:
463 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " editmob command [arguments]"));
464 print_to(caller, " Where 'command' can be butcher spawn skin movetarget kill name");
465 print_to(caller, " spawn, skin, movetarget and name require 'arguments'");
466 print_to(caller, " spawn also takes arguments list and random");
467 print_to(caller, " Monster will follow owner if third argument of spawn command is not defined");
473 void CommonCommand_info(int request, entity caller, int argc)
477 case CMD_REQUEST_COMMAND:
479 string command = cvar_string(strcat("sv_info_", argv(1)));
481 if (command) wordwrap_sprint(caller, command, 1000);
482 else print_to(caller, "ERROR: unsupported info command");
484 return; // never fall through to usage
488 case CMD_REQUEST_USAGE:
490 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " info request"));
491 print_to(caller, " Where 'request' is the suffixed string appended onto the request for cvar.");
497 void CommonCommand_ladder(int request, entity caller)
501 case CMD_REQUEST_COMMAND:
503 print_to(caller, ladder_reply);
504 return; // never fall through to usage
508 case CMD_REQUEST_USAGE:
510 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " ladder"));
511 print_to(caller, " No arguments required.");
517 void CommonCommand_lsmaps(int request, entity caller)
521 case CMD_REQUEST_COMMAND:
523 print_to(caller, lsmaps_reply);
524 return; // never fall through to usage
528 case CMD_REQUEST_USAGE:
530 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " lsmaps"));
531 print_to(caller, " No arguments required.");
537 void CommonCommand_printmaplist(int request, entity caller)
541 case CMD_REQUEST_COMMAND:
543 print_to(caller, maplist_reply);
544 return; // never fall through to usage
548 case CMD_REQUEST_USAGE:
550 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " printmaplist"));
551 print_to(caller, " No arguments required.");
557 void CommonCommand_rankings(int request, entity caller)
561 case CMD_REQUEST_COMMAND:
563 print_to(caller, rankings_reply);
564 return; // never fall through to usage
568 case CMD_REQUEST_USAGE:
570 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " rankings"));
571 print_to(caller, " No arguments required.");
577 void CommonCommand_records(int request, entity caller)
581 case CMD_REQUEST_COMMAND:
583 int num = stoi(argv(1));
584 if(num > 0 && num <= 10 && records_reply[num - 1] != "")
585 print_to(caller, records_reply[num - 1]);
588 for (int i = 0; i < 10; ++i)
589 if (records_reply[i] != "") print_to(caller, records_reply[i]);
592 return; // never fall through to usage
596 case CMD_REQUEST_USAGE:
598 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " records"));
599 print_to(caller, " No arguments required.");
605 void CommonCommand_teamstatus(int request, entity caller)
609 case CMD_REQUEST_COMMAND:
611 Score_NicePrint(caller);
612 return; // never fall through to usage
616 case CMD_REQUEST_USAGE:
618 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " teamstatus"));
619 print_to(caller, " No arguments required.");
625 void CommonCommand_time(int request, entity caller)
629 case CMD_REQUEST_COMMAND:
631 print_to(caller, strcat("time = ", ftos(time)));
632 print_to(caller, strcat("frame start = ", ftos(gettime(GETTIME_FRAMESTART))));
633 print_to(caller, strcat("realtime = ", ftos(gettime(GETTIME_REALTIME))));
634 print_to(caller, strcat("hires = ", ftos(gettime(GETTIME_HIRES))));
635 print_to(caller, strcat("uptime = ", ftos(gettime(GETTIME_UPTIME))));
636 print_to(caller, strcat("localtime = ", strftime(true, "%a %b %d %H:%M:%S %Z %Y")));
637 print_to(caller, strcat("gmtime = ", strftime(false, "%a %b %d %H:%M:%S %Z %Y")));
642 case CMD_REQUEST_USAGE:
644 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " time"));
645 print_to(caller, " No arguments required.");
651 void CommonCommand_timein(int request, entity caller)
655 case CMD_REQUEST_COMMAND:
657 if (!caller || autocvar_sv_timeout)
659 if (!timeout_status) { print_to(caller, "^7Error: There is no active timeout called."); }
660 else if (caller && (caller != timeout_caller))
662 print_to(caller, "^7Error: You are not allowed to stop the active timeout.");
665 else // everything should be okay, continue aborting timeout
667 switch (timeout_status)
669 case TIMEOUT_LEADTIME:
671 timeout_status = TIMEOUT_INACTIVE;
673 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
674 bprint(strcat("^7The timeout was aborted by ", GetCallerName(caller), " !\n"));
680 timeout_time = autocvar_sv_timeout_resumetime;
681 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
682 bprint(strcat("^1Attention: ^7", GetCallerName(caller), " resumed the game! Prepare for battle!\n"));
686 default: LOG_TRACE("timeout status was inactive, but this code was executed anyway?");
691 else { print_to(caller, "^1Timeins are not allowed to be called, enable them with sv_timeout 1.\n"); }
693 return; // never fall through to usage
697 case CMD_REQUEST_USAGE:
699 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timein"));
700 print_to(caller, " No arguments required.");
706 void CommonCommand_timeout(int request, entity caller) // DEAR GOD THIS COMMAND IS TERRIBLE.
710 case CMD_REQUEST_COMMAND:
712 if (!caller || autocvar_sv_timeout)
714 float last_possible_timeout = ((autocvar_timelimit * 60) - autocvar_sv_timeout_leadtime - 1);
716 if (timeout_status) { print_to(caller, "^7Error: A timeout is already active."); }
717 else if (vote_called)
719 print_to(caller, "^7Error: You can not call a timeout while a vote is active.");
721 else if (warmup_stage && !autocvar_g_warmup_allow_timeout)
723 print_to(caller, "^7Error: You can not call a timeout in warmup-stage.");
725 else if (time < game_starttime)
727 print_to(caller, "^7Error: You can not call a timeout while the map is being restarted.");
729 else if (caller && (CS(caller).allowed_timeouts < 1))
731 print_to(caller, "^7Error: You already used all your timeout calls for this map.");
733 else if (caller && !IS_PLAYER(caller))
735 print_to(caller, "^7Error: You must be a player to call a timeout.");
737 else if ((autocvar_timelimit) && (last_possible_timeout < time - game_starttime))
739 print_to(caller, "^7Error: It is too late to call a timeout now!");
742 else // everything should be okay, proceed with starting the timeout
744 if (caller) CS(caller).allowed_timeouts -= 1;
745 // write a bprint who started the timeout (and how many they have left)
746 bprint(GetCallerName(caller), " ^7called a timeout", (caller ? strcat(" (", ftos(CS(caller).allowed_timeouts), " timeout(s) left)") : ""), "!\n");
748 timeout_status = TIMEOUT_LEADTIME;
749 timeout_caller = caller;
750 timeout_time = autocvar_sv_timeout_length;
751 timeout_leadtime = autocvar_sv_timeout_leadtime;
753 timeout_handler = spawn();
754 setthink(timeout_handler, timeout_handler_think);
755 timeout_handler.nextthink = time; // always let the entity think asap
757 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_TIMEOUT);
760 else { print_to(caller, "^1Timeouts are not allowed to be called, enable them with sv_timeout 1.\n"); }
762 return; // never fall through to usage
766 case CMD_REQUEST_USAGE:
768 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timeout"));
769 print_to(caller, " No arguments required.");
775 void CommonCommand_who(int request, entity caller, int argc)
779 case CMD_REQUEST_COMMAND:
781 float total_listed_players, is_bot;
783 float privacy = (caller && autocvar_sv_status_privacy);
784 string separator = strreplace("%", " ", strcat((argv(1) ? argv(1) : " "), "^7"));
785 string tmp_netaddress, tmp_crypto_idfp;
787 print_to(caller, strcat("List of client information", (privacy ? " (some data is hidden for privacy)" : ""), ":"));
788 print_to(caller, sprintf(strreplace(" ", separator, " %-4s %-20s %-5s %-3s %-9s %-16s %s "),
789 "ent", "nickname", "ping", "pl", "time", "ip", "crypto_id"));
791 total_listed_players = 0;
792 FOREACH_CLIENT(true, {
793 is_bot = (IS_BOT_CLIENT(it));
797 tmp_netaddress = "null/botclient";
798 tmp_crypto_idfp = "null/botclient";
802 tmp_netaddress = "hidden";
803 tmp_crypto_idfp = "hidden";
807 tmp_netaddress = it.netaddress;
808 tmp_crypto_idfp = it.crypto_idfp;
811 print_to(caller, sprintf(strreplace(" ", separator, " #%-3d %-20.20s %-5d %-3d %-9s %-16s %s "),
815 CS(it).ping_packetloss,
816 process_time(1, time - CS(it).jointime),
820 ++total_listed_players;
823 print_to(caller, strcat("Finished listing ", ftos(total_listed_players), " client(s) out of ", ftos(maxclients), " slots."));
825 return; // never fall through to usage
829 case CMD_REQUEST_USAGE:
831 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " who [separator]"));
832 print_to(caller, " Where 'separator' is the optional string to separate the values with, default is a space.");
838 /* use this when creating a new command, making sure to place it in alphabetical order... also,
839 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
840 void CommonCommand_(int request, entity caller)
844 case CMD_REQUEST_COMMAND:
847 return; // never fall through to usage
851 case CMD_REQUEST_USAGE:
853 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " "));
854 print_to(caller, " No arguments required.");