2 #include <common/command/command.qh>
5 #include "../scores.qh"
7 #include <common/monsters/all.qh>
8 #include <common/notifications/all.qh>
9 #include <lib/warpzone/common.qh>
12 // ====================================================
13 // Shared code for server commands, written by Samual
14 // Last updated: December 27th, 2011
15 // ====================================================
17 // select the proper prefix for usage and other messages
18 string GetCommandPrefix(entity caller)
20 if (caller) return "cmd";
24 // if client return player nickname, or if server return admin nickname
25 string GetCallerName(entity caller)
27 if (caller) return caller.netname;
28 else return admin_name(); // ((autocvar_sv_adminnick != "") ? autocvar_sv_adminnick : autocvar_hostname);
31 // verify that the client provided is acceptable for kicking
32 float VerifyKickableEntity(entity client)
34 if (!IS_REAL_CLIENT(client)) return CLIENT_NOT_REAL;
35 return CLIENT_ACCEPTABLE;
38 // verify that the client provided is acceptable for use
39 float VerifyClientEntity(entity client, float must_be_real, float must_be_bots)
41 if (!IS_CLIENT(client)) return CLIENT_DOESNT_EXIST;
42 else if (must_be_real && !IS_REAL_CLIENT(client)) return CLIENT_NOT_REAL;
43 else if (must_be_bots && !IS_BOT_CLIENT(client)) return CLIENT_NOT_BOT;
45 return CLIENT_ACCEPTABLE;
48 // if the client is not acceptable, return a string to be used for error messages
49 string GetClientErrorString_color(float clienterror, string original_input, string col)
53 case CLIENT_DOESNT_EXIST:
54 { return strcat(col, "Client '", original_input, col, "' doesn't exist");
57 { return strcat(col, "Client '", original_input, col, "' is not real");
60 { return strcat(col, "Client '", original_input, col, "' is not a bot");
63 { return "Incorrect usage of GetClientErrorString";
68 // is this entity number even in the possible range of entities?
69 float VerifyClientNumber(float tmp_number)
71 if ((tmp_number < 1) || (tmp_number > maxclients)) return false;
75 entity GetIndexedEntity(float argc, float start_index)
78 float tmp_number, index;
85 if (argc > start_index)
87 if (substring(argv(index), 0, 1) == "#")
89 tmp_string = substring(argv(index), 1, -1);
92 if (tmp_string != "") // is it all one token? like #1
94 tmp_number = stof(tmp_string);
96 else if (argc > index) // no, it's two tokens? # 1
98 tmp_number = stof(argv(index));
106 else // maybe it's ONLY a number?
108 tmp_number = stof(argv(index));
112 if (VerifyClientNumber(tmp_number))
114 selection = edict_num(tmp_number); // yes, it was a number
116 else // no, maybe it's a name?
118 FOREACH_CLIENT(true, LAMBDA(
119 if(strdecolorize(it.netname) == strdecolorize(argv(start_index)))
122 break; // no reason to keep looking
126 index = (start_index + 1);
131 // print(strcat("start_index: ", ftos(start_index), ", next_token: ", ftos(next_token), ", edict: ", ftos(num_for_edict(selection)), ".\n"));
135 // find a player which matches the input string, and return their entity
136 entity GetFilteredEntity(string input)
141 if (substring(input, 0, 1) == "#") tmp_number = stof(substring(input, 1, -1));
142 else tmp_number = stof(input);
144 if (VerifyClientNumber(tmp_number))
146 selection = edict_num(tmp_number);
151 FOREACH_CLIENT(true, LAMBDA(
152 if(strdecolorize(it.netname) == strdecolorize(input))
155 break; // no reason to keep looking
163 // same thing, but instead return their edict number
164 float GetFilteredNumber(string input)
166 entity selection = GetFilteredEntity(input);
169 output = etof(selection);
174 // switch between sprint and print depending on whether the receiver is the server or a player
175 void print_to(entity to, string input)
177 if (to) sprint(to, strcat(input, "\n"));
178 else LOG_INFO(input, "\n");
181 // ==========================================
182 // Supporting functions for common commands
183 // ==========================================
185 // used by CommonCommand_timeout() and CommonCommand_timein() to handle game pausing and messaging and such.
186 void timeout_handler_reset(entity this)
188 timeout_caller = NULL;
190 timeout_leadtime = 0;
195 void timeout_handler_think(entity this)
197 switch (timeout_status)
201 if (timeout_time > 0) // countdown is still going
203 Send_Notification(NOTIF_ALL, NULL, MSG_CENTER, CENTER_TIMEOUT_ENDING, timeout_time);
205 if (timeout_time == autocvar_sv_timeout_resumetime) // play a warning sound when only <sv_timeout_resumetime> seconds are left
206 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_PREPARE);
208 this.nextthink = time + TIMEOUT_SLOWMO_VALUE; // think again in one second
209 timeout_time -= 1; // decrease the time counter
211 else // time to end the timeout
213 timeout_status = TIMEOUT_INACTIVE;
215 // reset the slowmo value back to normal
216 cvar_set("slowmo", ftos(orig_slowmo));
218 // unlock the view for players so they can move around again
219 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), LAMBDA(
223 timeout_handler_reset(this);
229 case TIMEOUT_LEADTIME:
231 if (timeout_leadtime > 0) // countdown is still going
233 Send_Notification(NOTIF_ALL, NULL, MSG_CENTER, CENTER_TIMEOUT_BEGINNING, timeout_leadtime);
235 this.nextthink = time + 1; // think again in one second
236 timeout_leadtime -= 1; // decrease the time counter
238 else // time to begin the timeout
240 timeout_status = TIMEOUT_ACTIVE;
242 // set the slowmo value to the timeout default slowmo value
243 cvar_set("slowmo", ftos(TIMEOUT_SLOWMO_VALUE));
245 // reset all the flood variables
246 FOREACH_CLIENT(true, LAMBDA(
247 it.nickspamcount = it.nickspamtime = it.floodcontrol_chat =
248 it.floodcontrol_chatteam = it.floodcontrol_chattell =
249 it.floodcontrol_voice = it.floodcontrol_voiceteam = 0;
252 // copy .v_angle to .lastV_angle for every player in order to fix their view during pause (see PlayerPreThink)
253 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), LAMBDA(
254 it.lastV_angle = it.v_angle;
257 this.nextthink = time; // think again next frame to handle it under TIMEOUT_ACTIVE code
264 case TIMEOUT_INACTIVE:
267 timeout_handler_reset(this);
274 // ===================================================
275 // Common commands used in both sv_cmd.qc and cmd.qc
276 // ===================================================
278 void CommonCommand_cvar_changes(float request, entity caller)
282 case CMD_REQUEST_COMMAND:
284 print_to(caller, cvar_changes);
285 return; // never fall through to usage
289 case CMD_REQUEST_USAGE:
291 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_changes"));
292 print_to(caller, " No arguments required.");
293 print_to(caller, "See also: ^2cvar_purechanges^7");
299 void CommonCommand_cvar_purechanges(float request, entity caller)
303 case CMD_REQUEST_COMMAND:
305 print_to(caller, cvar_purechanges);
306 return; // never fall through to usage
310 case CMD_REQUEST_USAGE:
312 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_purechanges"));
313 print_to(caller, " No arguments required.");
314 print_to(caller, "See also: ^2cvar_changes^7");
320 void CommonCommand_editmob(int request, entity caller, int argc)
324 case CMD_REQUEST_COMMAND:
326 if (autocvar_g_campaign) { print_to(caller, "Monster editing is disabled in singleplayer"); return; }
327 // no checks for g_monsters here, as it may be toggled mid match which existing monsters
331 makevectors(caller.v_angle);
332 WarpZone_TraceLine(caller.origin + caller.view_ofs, caller.origin + caller.view_ofs + v_forward * 100, MOVE_NORMAL, caller);
335 entity mon = trace_ent;
336 bool is_visible = IS_MONSTER(mon);
337 string argument = argv(2);
343 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
344 if (!argument) break; // escape to usage
345 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
346 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
347 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
349 string mon_oldname = mon.monster_name;
351 mon.monster_name = argument;
352 if (mon.sprite) WaypointSprite_UpdateSprites(mon.sprite, WP_Monster, WP_Null, WP_Null);
353 print_to(caller, sprintf("Your pet '%s' is now known as '%s'", mon_oldname, mon.monster_name));
358 if (!caller) { print_to(caller, "Only players can spawn monsters"); return; }
359 if (!argv(2)) break; // escape to usage
361 int moveflag, tmp_moncount = 0;
362 string arg_lower = strtolower(argument);
363 moveflag = (argv(3)) ? stof(argv(3)) : 1; // follow owner if not defined
365 if (arg_lower == "list") { print_to(caller, monsterlist_reply); return; }
367 FOREACH_ENTITY_FLAGS(flags, FL_MONSTER, LAMBDA(
368 if(it.realowner == caller)
372 if (!autocvar_g_monsters) { print_to(caller, "Monsters are disabled"); return; }
373 if (autocvar_g_monsters_max <= 0 || autocvar_g_monsters_max_perplayer <= 0) { print_to(caller, "Monster spawning is disabled"); return; }
374 if (!IS_PLAYER(caller)) { print_to(caller, "You must be playing to spawn a monster"); return; }
375 if (MUTATOR_CALLHOOK(AllowMobSpawning, caller)) { print_to(caller, M_ARGV(1, string)); return; }
376 if (caller.vehicle) { print_to(caller, "You can't spawn monsters while driving a vehicle"); return; }
377 if (STAT(FROZEN, caller)) { print_to(caller, "You can't spawn monsters while frozen"); return; }
378 if (IS_DEAD(caller)) { print_to(caller, "You can't spawn monsters while dead"); return; }
379 if (tmp_moncount >= autocvar_g_monsters_max) { print_to(caller, "The maximum monster count has been reached"); return; }
380 if (tmp_moncount >= autocvar_g_monsters_max_perplayer) { print_to(caller, "You can't spawn any more monsters"); return; }
383 for (int i = MON_FIRST; i <= MON_LAST; ++i)
385 mon = get_monsterinfo(i);
386 if (mon.netname == arg_lower) { found = true; break; }
389 if (!found && arg_lower != "random") { print_to(caller, "Invalid monster"); return; }
392 WarpZone_TraceBox(CENTER_OR_VIEWOFS(caller), caller.mins, caller.maxs, CENTER_OR_VIEWOFS(caller) + v_forward * 150, true, caller);
393 mon = spawnmonster(arg_lower, 0, caller, caller, trace_endpos, false, false, moveflag);
394 print_to(caller, strcat("Spawned ", mon.monster_name));
399 if (!caller) { print_to(caller, "Only players can kill monsters"); return; }
400 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
401 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
403 Damage(mon, NULL, NULL, mon.health + mon.max_health + 200, DEATH_KILL.m_id, mon.origin, '0 0 0');
404 print_to(caller, strcat("Your pet '", mon.monster_name, "' has been brutally mutilated"));
409 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
410 if (!argument) break; // escape to usage
411 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
412 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
413 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
414 if (mon.monsterid == MON_MAGE.monsterid) { print_to(caller, "Mage skins can't be changed"); return; } // TODO
416 mon.skin = stof(argument);
417 print_to(caller, strcat("Monster skin successfully changed to ", ftos(mon.skin)));
422 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
423 if (!argument) break; // escape to usage
424 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
425 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
426 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
428 mon.monster_moveflags = stof(argument);
429 print_to(caller, strcat("Monster move target successfully changed to ", ftos(mon.monster_moveflags)));
434 if (caller) { print_to(caller, "This command is not available to players"); return; }
435 if (MUTATOR_CALLHOOK(AllowMobButcher)) { LOG_INFO(M_ARGV(0, string), "\n"); return; }
437 int tmp_remcount = 0;
439 FOREACH_ENTITY_FLAGS(flags, FL_MONSTER, LAMBDA(
444 monsters_total = monsters_killed = totalspawned = 0;
446 print_to(caller, (tmp_remcount) ? sprintf("Killed %d monster%s", tmp_remcount, (tmp_remcount == 1) ? "" : "s") : "No monsters to kill");
453 case CMD_REQUEST_USAGE:
455 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " editmob command [arguments]"));
456 print_to(caller, " Where 'command' can be butcher spawn skin movetarget kill name");
457 print_to(caller, " spawn, skin, movetarget and name require 'arguments'");
458 print_to(caller, " spawn also takes arguments list and random");
459 print_to(caller, " Monster will follow owner if third argument of spawn command is not defined");
465 void CommonCommand_info(float request, entity caller, float argc)
469 case CMD_REQUEST_COMMAND:
471 string command = builtin_cvar_string(strcat("sv_info_", argv(1)));
473 if (command) wordwrap_sprint(caller, command, 1000);
474 else print_to(caller, "ERROR: unsupported info command");
476 return; // never fall through to usage
480 case CMD_REQUEST_USAGE:
482 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " info request"));
483 print_to(caller, " Where 'request' is the suffixed string appended onto the request for cvar.");
489 void CommonCommand_ladder(float request, entity caller)
493 case CMD_REQUEST_COMMAND:
495 print_to(caller, ladder_reply);
496 return; // never fall through to usage
500 case CMD_REQUEST_USAGE:
502 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " ladder"));
503 print_to(caller, " No arguments required.");
509 void CommonCommand_lsmaps(float request, entity caller)
513 case CMD_REQUEST_COMMAND:
515 print_to(caller, lsmaps_reply);
516 return; // never fall through to usage
520 case CMD_REQUEST_USAGE:
522 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " lsmaps"));
523 print_to(caller, " No arguments required.");
529 void CommonCommand_printmaplist(float request, entity caller)
533 case CMD_REQUEST_COMMAND:
535 print_to(caller, maplist_reply);
536 return; // never fall through to usage
540 case CMD_REQUEST_USAGE:
542 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " printmaplist"));
543 print_to(caller, " No arguments required.");
549 void CommonCommand_rankings(float request, entity caller)
553 case CMD_REQUEST_COMMAND:
555 print_to(caller, rankings_reply);
556 return; // never fall through to usage
560 case CMD_REQUEST_USAGE:
562 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " rankings"));
563 print_to(caller, " No arguments required.");
569 void CommonCommand_records(float request, entity caller)
573 case CMD_REQUEST_COMMAND:
575 for (int i = 0; i < 10; ++i)
576 if (records_reply[i] != "") print_to(caller, records_reply[i]);
578 return; // never fall through to usage
582 case CMD_REQUEST_USAGE:
584 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " records"));
585 print_to(caller, " No arguments required.");
591 void CommonCommand_teamstatus(float request, entity caller)
595 case CMD_REQUEST_COMMAND:
597 Score_NicePrint(caller);
598 return; // never fall through to usage
602 case CMD_REQUEST_USAGE:
604 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " teamstatus"));
605 print_to(caller, " No arguments required.");
611 void CommonCommand_time(float request, entity caller)
615 case CMD_REQUEST_COMMAND:
617 print_to(caller, strcat("time = ", ftos(time)));
618 print_to(caller, strcat("frame start = ", ftos(gettime(GETTIME_FRAMESTART))));
619 print_to(caller, strcat("realtime = ", ftos(gettime(GETTIME_REALTIME))));
620 print_to(caller, strcat("hires = ", ftos(gettime(GETTIME_HIRES))));
621 print_to(caller, strcat("uptime = ", ftos(gettime(GETTIME_UPTIME))));
622 print_to(caller, strcat("localtime = ", strftime(true, "%a %b %e %H:%M:%S %Z %Y")));
623 print_to(caller, strcat("gmtime = ", strftime(false, "%a %b %e %H:%M:%S %Z %Y")));
628 case CMD_REQUEST_USAGE:
630 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " time"));
631 print_to(caller, " No arguments required.");
637 void CommonCommand_timein(float request, entity caller)
641 case CMD_REQUEST_COMMAND:
643 if (!caller || autocvar_sv_timeout)
645 if (!timeout_status) { print_to(caller, "^7Error: There is no active timeout called."); }
646 else if (caller && (caller != timeout_caller))
648 print_to(caller, "^7Error: You are not allowed to stop the active timeout.");
651 else // everything should be okay, continue aborting timeout
653 switch (timeout_status)
655 case TIMEOUT_LEADTIME:
657 timeout_status = TIMEOUT_INACTIVE;
659 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
660 bprint(strcat("^7The timeout was aborted by ", GetCallerName(caller), " !\n"));
666 timeout_time = autocvar_sv_timeout_resumetime;
667 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
668 bprint(strcat("^1Attention: ^7", GetCallerName(caller), " resumed the game! Prepare for battle!\n"));
672 default: LOG_TRACE("timeout status was inactive, but this code was executed anyway?");
677 else { print_to(caller, "^1Timeins are not allowed to be called, enable them with sv_timeout 1.\n"); }
679 return; // never fall through to usage
683 case CMD_REQUEST_USAGE:
685 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timein"));
686 print_to(caller, " No arguments required.");
692 void CommonCommand_timeout(float request, entity caller) // DEAR GOD THIS COMMAND IS TERRIBLE.
696 case CMD_REQUEST_COMMAND:
698 if (!caller || autocvar_sv_timeout)
700 float last_possible_timeout = ((autocvar_timelimit * 60) - autocvar_sv_timeout_leadtime - 1);
702 if (timeout_status) { print_to(caller, "^7Error: A timeout is already active."); }
703 else if (vote_called)
705 print_to(caller, "^7Error: You can not call a timeout while a vote is active.");
707 else if (warmup_stage && !g_warmup_allow_timeout)
709 print_to(caller, "^7Error: You can not call a timeout in warmup-stage.");
711 else if (time < game_starttime)
713 print_to(caller, "^7Error: You can not call a timeout while the map is being restarted.");
715 else if (caller && (caller.allowed_timeouts < 1))
717 print_to(caller, "^7Error: You already used all your timeout calls for this map.");
719 else if (caller && !IS_PLAYER(caller))
721 print_to(caller, "^7Error: You must be a player to call a timeout.");
723 else if ((autocvar_timelimit) && (last_possible_timeout < time - game_starttime))
725 print_to(caller, "^7Error: It is too late to call a timeout now!");
728 else // everything should be okay, proceed with starting the timeout
730 if (caller) caller.allowed_timeouts -= 1;
731 // write a bprint who started the timeout (and how many they have left)
732 bprint(GetCallerName(caller), " ^7called a timeout", (caller ? strcat(" (", ftos(caller.allowed_timeouts), " timeout(s) left)") : ""), "!\n");
734 timeout_status = TIMEOUT_LEADTIME;
735 timeout_caller = caller;
736 timeout_time = autocvar_sv_timeout_length;
737 timeout_leadtime = autocvar_sv_timeout_leadtime;
739 timeout_handler = spawn();
740 setthink(timeout_handler, timeout_handler_think);
741 timeout_handler.nextthink = time; // always let the entity think asap
743 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_TIMEOUT);
746 else { print_to(caller, "^1Timeouts are not allowed to be called, enable them with sv_timeout 1.\n"); }
748 return; // never fall through to usage
752 case CMD_REQUEST_USAGE:
754 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timeout"));
755 print_to(caller, " No arguments required.");
761 void CommonCommand_who(float request, entity caller, float argc)
765 case CMD_REQUEST_COMMAND:
767 float total_listed_players, is_bot;
769 float privacy = (caller && autocvar_sv_status_privacy);
770 string separator = strreplace("%", " ", strcat((argv(1) ? argv(1) : " "), "^7"));
771 string tmp_netaddress, tmp_crypto_idfp;
773 print_to(caller, strcat("List of client information", (privacy ? " (some data is hidden for privacy)" : ""), ":"));
774 print_to(caller, sprintf(strreplace(" ", separator, " %-4s %-20s %-5s %-3s %-9s %-16s %s "),
775 "ent", "nickname", "ping", "pl", "time", "ip", "crypto_id"));
777 total_listed_players = 0;
778 FOREACH_CLIENT(true, LAMBDA(
779 is_bot = (IS_BOT_CLIENT(it));
783 tmp_netaddress = "null/botclient";
784 tmp_crypto_idfp = "null/botclient";
788 tmp_netaddress = "hidden";
789 tmp_crypto_idfp = "hidden";
793 tmp_netaddress = it.netaddress;
794 tmp_crypto_idfp = it.crypto_idfp;
797 print_to(caller, sprintf(strreplace(" ", separator, " #%-3d %-20.20s %-5d %-3d %-9s %-16s %s "),
802 process_time(1, time - it.jointime),
806 ++total_listed_players;
809 print_to(caller, strcat("Finished listing ", ftos(total_listed_players), " client(s) out of ", ftos(maxclients), " slots."));
811 return; // never fall through to usage
815 case CMD_REQUEST_USAGE:
817 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " who [separator]"));
818 print_to(caller, " Where 'separator' is the optional string to separate the values with, default is a space.");
824 /* use this when creating a new command, making sure to place it in alphabetical order... also,
825 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
826 void CommonCommand_(float request, entity caller)
830 case CMD_REQUEST_COMMAND:
833 return; // never fall through to usage
837 case CMD_REQUEST_USAGE:
839 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " "));
840 print_to(caller, " No arguments required.");