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";
28 // if client return player nickname, or if server return admin nickname
29 string GetCallerName(entity caller)
31 if (caller) return playername(caller, false);
32 else 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;
46 else if (must_be_real && !IS_REAL_CLIENT(client)) return CLIENT_NOT_REAL;
47 else if (must_be_bots && !IS_BOT_CLIENT(client)) return CLIENT_NOT_BOT;
49 return CLIENT_ACCEPTABLE;
52 // if the client is not acceptable, return a string to be used for error messages
53 string GetClientErrorString_color(float clienterror, string original_input, string col)
57 case CLIENT_DOESNT_EXIST:
58 { return strcat(col, "Client '", original_input, col, "' doesn't exist");
61 { return strcat(col, "Client '", original_input, col, "' is not real");
64 { return strcat(col, "Client '", original_input, col, "' is not a bot");
67 { return "Incorrect usage of GetClientErrorString";
72 // is this entity number even in the possible range of entities?
73 float VerifyClientNumber(float tmp_number)
75 if ((tmp_number < 1) || (tmp_number > maxclients)) return false;
79 entity GetIndexedEntity(int argc, float start_index)
82 float tmp_number, index;
89 if (argc > start_index)
91 if (substring(argv(index), 0, 1) == "#")
93 tmp_string = substring(argv(index), 1, -1);
96 if (tmp_string != "") // is it all one token? like #1
98 tmp_number = stof(tmp_string);
100 else if (argc > index) // no, it's two tokens? # 1
102 tmp_number = stof(argv(index));
110 else // maybe it's ONLY a number?
112 tmp_number = stof(argv(index));
116 if (VerifyClientNumber(tmp_number))
118 selection = edict_num(tmp_number); // yes, it was a number
120 else // no, maybe it's a name?
122 FOREACH_CLIENT(true, {
123 if(strdecolorize(it.netname) == strdecolorize(argv(start_index)))
126 break; // no reason to keep looking
130 index = (start_index + 1);
135 // print(strcat("start_index: ", ftos(start_index), ", next_token: ", ftos(next_token), ", edict: ", ftos(num_for_edict(selection)), ".\n"));
139 // find a player which matches the input string, and return their entity
140 entity GetFilteredEntity(string input)
145 if (substring(input, 0, 1) == "#") tmp_number = stof(substring(input, 1, -1));
146 else tmp_number = stof(input);
148 if (VerifyClientNumber(tmp_number))
150 selection = edict_num(tmp_number);
155 FOREACH_CLIENT(true, {
156 if(strdecolorize(it.netname) == strdecolorize(input))
159 break; // no reason to keep looking
167 // same thing, but instead return their edict number
168 float GetFilteredNumber(string input)
170 entity selection = GetFilteredEntity(input);
173 output = etof(selection);
178 // switch between sprint and print depending on whether the receiver is the server or a player
179 void print_to(entity to, string input)
181 if (to) sprint(to, strcat(input, "\n"));
182 else print(input, "\n");
185 // ==========================================
186 // Supporting functions for common commands
187 // ==========================================
189 // used by CommonCommand_timeout() and CommonCommand_timein() to handle game pausing and messaging and such.
190 void timeout_handler_reset(entity this)
192 timeout_caller = NULL;
194 timeout_leadtime = 0;
199 void timeout_handler_think(entity this)
201 switch (timeout_status)
205 if (timeout_time > 0) // countdown is still going
207 Send_Notification(NOTIF_ALL, NULL, MSG_CENTER, CENTER_TIMEOUT_ENDING, timeout_time);
209 if (timeout_time == autocvar_sv_timeout_resumetime) // play a warning sound when only <sv_timeout_resumetime> seconds are left
210 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_PREPARE);
212 this.nextthink = time + TIMEOUT_SLOWMO_VALUE; // think again in one second
213 timeout_time -= 1; // decrease the time counter
215 else // time to end the timeout
217 Kill_Notification(NOTIF_ALL, NULL, MSG_CENTER, CPID_TIMEIN);
218 timeout_status = TIMEOUT_INACTIVE;
220 // reset the slowmo value back to normal
221 cvar_set("slowmo", ftos(orig_slowmo));
223 // unlock the view for players so they can move around again
224 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), {
228 timeout_handler_reset(this);
234 case TIMEOUT_LEADTIME:
236 if (timeout_leadtime > 0) // countdown is still going
238 Send_Notification(NOTIF_ALL, NULL, MSG_CENTER, CENTER_TIMEOUT_BEGINNING, timeout_leadtime);
240 this.nextthink = time + 1; // think again in one second
241 timeout_leadtime -= 1; // decrease the time counter
243 else // time to begin the timeout
245 timeout_status = TIMEOUT_ACTIVE;
247 // set the slowmo value to the timeout default slowmo value
248 cvar_set("slowmo", ftos(TIMEOUT_SLOWMO_VALUE));
250 // reset all the flood variables
251 FOREACH_CLIENT(true, {
252 it.nickspamcount = it.nickspamtime = it.floodcontrol_chat =
253 it.floodcontrol_chatteam = it.floodcontrol_chattell =
254 it.floodcontrol_voice = it.floodcontrol_voiceteam = 0;
257 // copy .v_angle to .lastV_angle for every player in order to fix their view during pause (see PlayerPreThink)
258 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), {
259 it.lastV_angle = it.v_angle;
262 this.nextthink = time; // think again next frame to handle it under TIMEOUT_ACTIVE code
269 case TIMEOUT_INACTIVE:
272 timeout_handler_reset(this);
279 // ===================================================
280 // Common commands used in both sv_cmd.qc and cmd.qc
281 // ===================================================
283 void CommonCommand_cvar_changes(int request, entity caller)
287 case CMD_REQUEST_COMMAND:
289 print_to(caller, cvar_changes);
290 return; // never fall through to usage
294 case CMD_REQUEST_USAGE:
296 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_changes"));
297 print_to(caller, " No arguments required.");
298 print_to(caller, "See also: ^2cvar_purechanges^7");
304 void CommonCommand_cvar_purechanges(int request, entity caller)
308 case CMD_REQUEST_COMMAND:
310 print_to(caller, cvar_purechanges);
311 return; // never fall through to usage
315 case CMD_REQUEST_USAGE:
317 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_purechanges"));
318 print_to(caller, " No arguments required.");
319 print_to(caller, "See also: ^2cvar_changes^7");
325 void CommonCommand_editmob(int request, entity caller, int argc)
329 case CMD_REQUEST_COMMAND:
331 if (autocvar_g_campaign) { print_to(caller, "Monster editing is disabled in singleplayer"); return; }
332 // no checks for g_monsters here, as it may be toggled mid match which existing monsters
336 makevectors(caller.v_angle);
337 WarpZone_TraceLine(caller.origin + caller.view_ofs, caller.origin + caller.view_ofs + v_forward * 100, MOVE_NORMAL, caller);
340 entity mon = trace_ent;
341 bool is_visible = IS_MONSTER(mon);
342 string argument = argv(2);
348 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
349 if (!argument) break; // escape to usage
350 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
351 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
352 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
354 string mon_oldname = mon.monster_name;
356 mon.monster_name = argument;
357 if (mon.sprite) WaypointSprite_UpdateSprites(mon.sprite, WP_Monster, WP_Null, WP_Null); // TODO: the new name is never actually sent to CSQC!
358 print_to(caller, sprintf("Your pet '%s' is now known as '%s'", mon_oldname, mon.monster_name));
363 if (!caller) { print_to(caller, "Only players can spawn monsters"); return; }
364 if (!argv(2)) break; // escape to usage
366 int moveflag, tmp_moncount = 0;
367 string arg_lower = strtolower(argument);
368 moveflag = (argv(3)) ? stof(argv(3)) : 1; // follow owner if not defined
370 if (arg_lower == "list") { print_to(caller, monsterlist_reply); return; }
372 IL_EACH(g_monsters, it.realowner == caller,
377 if (!autocvar_g_monsters) { print_to(caller, "Monsters are disabled"); return; }
378 if (autocvar_g_monsters_max <= 0 || autocvar_g_monsters_max_perplayer <= 0) { print_to(caller, "Monster spawning is disabled"); return; }
379 if (!IS_PLAYER(caller)) { print_to(caller, "You must be playing to spawn a monster"); return; }
380 if (MUTATOR_CALLHOOK(AllowMobSpawning, caller)) { print_to(caller, M_ARGV(1, string)); return; }
381 if (caller.vehicle) { print_to(caller, "You can't spawn monsters while driving a vehicle"); return; }
382 if (STAT(FROZEN, caller)) { print_to(caller, "You can't spawn monsters while frozen"); return; }
383 if (IS_DEAD(caller)) { print_to(caller, "You can't spawn monsters while dead"); return; }
384 if (tmp_moncount >= autocvar_g_monsters_max) { print_to(caller, "The maximum monster count has been reached"); return; }
385 if (tmp_moncount >= autocvar_g_monsters_max_perplayer) { print_to(caller, "You can't spawn any more monsters"); return; }
388 FOREACH(Monsters, it != MON_Null && it.netname == arg_lower,
394 if (!found && arg_lower != "random" && arg_lower != "anyrandom") { print_to(caller, "Invalid monster"); return; }
397 WarpZone_TraceBox(CENTER_OR_VIEWOFS(caller), caller.mins, caller.maxs, CENTER_OR_VIEWOFS(caller) + v_forward * 150, true, caller);
398 mon = spawnmonster(spawn(), arg_lower, MON_Null, caller, caller, trace_endpos, false, false, moveflag);
399 print_to(caller, strcat("Spawned ", mon.monster_name));
404 if (!caller) { print_to(caller, "Only players can kill monsters"); return; }
405 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
406 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
408 Damage(mon, NULL, NULL, GetResource(mon, RES_HEALTH) + mon.max_health + 200, DEATH_KILL.m_id, DMG_NOWEP, mon.origin, '0 0 0');
409 print_to(caller, strcat("Your pet '", mon.monster_name, "' has been brutally mutilated"));
414 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
415 if (!argument) break; // escape to usage
416 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
417 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
418 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
419 if (mon.monsterdef == MON_MAGE) { print_to(caller, "Mage skins can't be changed"); return; } // TODO
421 mon.skin = stof(argument);
422 print_to(caller, strcat("Monster skin successfully changed to ", ftos(mon.skin)));
427 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
428 if (!argument) break; // escape to usage
429 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
430 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
431 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
433 mon.monster_moveflags = stof(argument);
434 print_to(caller, strcat("Monster move target successfully changed to ", ftos(mon.monster_moveflags)));
439 if (caller) { print_to(caller, "This command is not available to players"); return; }
440 if (MUTATOR_CALLHOOK(AllowMobButcher)) { LOG_INFO(M_ARGV(0, string)); return; }
442 int tmp_remcount = 0;
444 IL_EACH(g_monsters, true,
449 IL_CLEAR(g_monsters);
451 monsters_total = monsters_killed = totalspawned = 0;
453 print_to(caller, (tmp_remcount) ? sprintf("Killed %d monster%s", tmp_remcount, (tmp_remcount == 1) ? "" : "s") : "No monsters to kill");
460 case CMD_REQUEST_USAGE:
462 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " editmob command [arguments]"));
463 print_to(caller, " Where 'command' can be butcher spawn skin movetarget kill name");
464 print_to(caller, " spawn, skin, movetarget and name require 'arguments'");
465 print_to(caller, " spawn also takes arguments list and random");
466 print_to(caller, " Monster will follow owner if third argument of spawn command is not defined");
472 void CommonCommand_info(int request, entity caller, int argc)
476 case CMD_REQUEST_COMMAND:
478 string command = cvar_string(strcat("sv_info_", argv(1)));
480 if (command) wordwrap_sprint(caller, command, 1000);
481 else print_to(caller, "ERROR: unsupported info command");
483 return; // never fall through to usage
487 case CMD_REQUEST_USAGE:
489 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " info request"));
490 print_to(caller, " Where 'request' is the suffixed string appended onto the request for cvar.");
496 void CommonCommand_ladder(int request, entity caller)
500 case CMD_REQUEST_COMMAND:
502 print_to(caller, ladder_reply);
503 return; // never fall through to usage
507 case CMD_REQUEST_USAGE:
509 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " ladder"));
510 print_to(caller, " No arguments required.");
516 void CommonCommand_lsmaps(int request, entity caller)
520 case CMD_REQUEST_COMMAND:
522 print_to(caller, lsmaps_reply);
523 return; // never fall through to usage
527 case CMD_REQUEST_USAGE:
529 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " lsmaps"));
530 print_to(caller, " No arguments required.");
536 void CommonCommand_printmaplist(int request, entity caller)
540 case CMD_REQUEST_COMMAND:
542 print_to(caller, maplist_reply);
543 return; // never fall through to usage
547 case CMD_REQUEST_USAGE:
549 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " printmaplist"));
550 print_to(caller, " No arguments required.");
556 void CommonCommand_rankings(int request, entity caller)
560 case CMD_REQUEST_COMMAND:
562 print_to(caller, rankings_reply);
563 return; // never fall through to usage
567 case CMD_REQUEST_USAGE:
569 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " rankings"));
570 print_to(caller, " No arguments required.");
576 void CommonCommand_records(int request, entity caller)
580 case CMD_REQUEST_COMMAND:
582 int num = stoi(argv(1));
583 if(num > 0 && num <= 10 && records_reply[num - 1] != "")
584 print_to(caller, records_reply[num - 1]);
587 for (int i = 0; i < 10; ++i)
588 if (records_reply[i] != "") print_to(caller, records_reply[i]);
591 return; // never fall through to usage
595 case CMD_REQUEST_USAGE:
597 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " records"));
598 print_to(caller, " No arguments required.");
604 void CommonCommand_teamstatus(int request, entity caller)
608 case CMD_REQUEST_COMMAND:
610 Score_NicePrint(caller);
611 return; // never fall through to usage
615 case CMD_REQUEST_USAGE:
617 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " teamstatus"));
618 print_to(caller, " No arguments required.");
624 void CommonCommand_time(int request, entity caller)
628 case CMD_REQUEST_COMMAND:
630 print_to(caller, strcat("time = ", ftos(time)));
631 print_to(caller, strcat("frame start = ", ftos(gettime(GETTIME_FRAMESTART))));
632 print_to(caller, strcat("realtime = ", ftos(gettime(GETTIME_REALTIME))));
633 print_to(caller, strcat("hires = ", ftos(gettime(GETTIME_HIRES))));
634 print_to(caller, strcat("uptime = ", ftos(gettime(GETTIME_UPTIME))));
635 print_to(caller, strcat("localtime = ", strftime(true, "%a %b %d %H:%M:%S %Z %Y")));
636 print_to(caller, strcat("gmtime = ", strftime(false, "%a %b %d %H:%M:%S %Z %Y")));
641 case CMD_REQUEST_USAGE:
643 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " time"));
644 print_to(caller, " No arguments required.");
650 void CommonCommand_timein(int request, entity caller)
654 case CMD_REQUEST_COMMAND:
656 if (!caller || autocvar_sv_timeout)
658 if (!timeout_status) { print_to(caller, "^7Error: There is no active timeout called."); }
659 else if (caller && (caller != timeout_caller))
661 print_to(caller, "^7Error: You are not allowed to stop the active timeout.");
664 else // everything should be okay, continue aborting timeout
666 switch (timeout_status)
668 case TIMEOUT_LEADTIME:
670 timeout_status = TIMEOUT_INACTIVE;
672 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
673 bprint(strcat("^7The timeout was aborted by ", GetCallerName(caller), " !\n"));
679 timeout_time = autocvar_sv_timeout_resumetime;
680 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
681 bprint(strcat("^1Attention: ^7", GetCallerName(caller), " resumed the game! Prepare for battle!\n"));
685 default: LOG_TRACE("timeout status was inactive, but this code was executed anyway?");
690 else { print_to(caller, "^1Timeins are not allowed to be called, enable them with sv_timeout 1.\n"); }
692 return; // never fall through to usage
696 case CMD_REQUEST_USAGE:
698 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timein"));
699 print_to(caller, " No arguments required.");
705 void CommonCommand_timeout(int request, entity caller) // DEAR GOD THIS COMMAND IS TERRIBLE.
709 case CMD_REQUEST_COMMAND:
711 if (!caller || autocvar_sv_timeout)
713 float last_possible_timeout = ((autocvar_timelimit * 60) - autocvar_sv_timeout_leadtime - 1);
715 if (timeout_status) { print_to(caller, "^7Error: A timeout is already active."); }
716 else if (vote_called)
718 print_to(caller, "^7Error: You can not call a timeout while a vote is active.");
720 else if (warmup_stage && !g_warmup_allow_timeout)
722 print_to(caller, "^7Error: You can not call a timeout in warmup-stage.");
724 else if (time < game_starttime)
726 print_to(caller, "^7Error: You can not call a timeout while the map is being restarted.");
728 else if (caller && (CS(caller).allowed_timeouts < 1))
730 print_to(caller, "^7Error: You already used all your timeout calls for this map.");
732 else if (caller && !IS_PLAYER(caller))
734 print_to(caller, "^7Error: You must be a player to call a timeout.");
736 else if ((autocvar_timelimit) && (last_possible_timeout < time - game_starttime))
738 print_to(caller, "^7Error: It is too late to call a timeout now!");
741 else // everything should be okay, proceed with starting the timeout
743 if (caller) CS(caller).allowed_timeouts -= 1;
744 // write a bprint who started the timeout (and how many they have left)
745 bprint(GetCallerName(caller), " ^7called a timeout", (caller ? strcat(" (", ftos(CS(caller).allowed_timeouts), " timeout(s) left)") : ""), "!\n");
747 timeout_status = TIMEOUT_LEADTIME;
748 timeout_caller = caller;
749 timeout_time = autocvar_sv_timeout_length;
750 timeout_leadtime = autocvar_sv_timeout_leadtime;
752 timeout_handler = spawn();
753 setthink(timeout_handler, timeout_handler_think);
754 timeout_handler.nextthink = time; // always let the entity think asap
756 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_TIMEOUT);
759 else { print_to(caller, "^1Timeouts are not allowed to be called, enable them with sv_timeout 1.\n"); }
761 return; // never fall through to usage
765 case CMD_REQUEST_USAGE:
767 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timeout"));
768 print_to(caller, " No arguments required.");
774 void CommonCommand_who(int request, entity caller, int argc)
778 case CMD_REQUEST_COMMAND:
780 float total_listed_players, is_bot;
782 float privacy = (caller && autocvar_sv_status_privacy);
783 string separator = strreplace("%", " ", strcat((argv(1) ? argv(1) : " "), "^7"));
784 string tmp_netaddress, tmp_crypto_idfp;
786 print_to(caller, strcat("List of client information", (privacy ? " (some data is hidden for privacy)" : ""), ":"));
787 print_to(caller, sprintf(strreplace(" ", separator, " %-4s %-20s %-5s %-3s %-9s %-16s %s "),
788 "ent", "nickname", "ping", "pl", "time", "ip", "crypto_id"));
790 total_listed_players = 0;
791 FOREACH_CLIENT(true, {
792 is_bot = (IS_BOT_CLIENT(it));
796 tmp_netaddress = "null/botclient";
797 tmp_crypto_idfp = "null/botclient";
801 tmp_netaddress = "hidden";
802 tmp_crypto_idfp = "hidden";
806 tmp_netaddress = it.netaddress;
807 tmp_crypto_idfp = it.crypto_idfp;
810 print_to(caller, sprintf(strreplace(" ", separator, " #%-3d %-20.20s %-5d %-3d %-9s %-16s %s "),
814 CS(it).ping_packetloss,
815 process_time(1, time - CS(it).jointime),
819 ++total_listed_players;
822 print_to(caller, strcat("Finished listing ", ftos(total_listed_players), " client(s) out of ", ftos(maxclients), " slots."));
824 return; // never fall through to usage
828 case CMD_REQUEST_USAGE:
830 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " who [separator]"));
831 print_to(caller, " Where 'separator' is the optional string to separate the values with, default is a space.");
837 /* use this when creating a new command, making sure to place it in alphabetical order... also,
838 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
839 void CommonCommand_(int request, entity caller)
843 case CMD_REQUEST_COMMAND:
846 return; // never fall through to usage
850 case CMD_REQUEST_USAGE:
852 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " "));
853 print_to(caller, " No arguments required.");