3 #include <common/command/_mod.qh>
4 #include <common/deathtypes/all.qh>
5 #include <common/monsters/_mod.qh>
6 #include <common/notifications/all.qh>
7 #include <common/stats.qh>
8 #include <common/vehicles/all.qh>
9 #include <common/weapons/_all.qh>
10 #include <lib/warpzone/common.qh>
11 #include <server/campaign.qh>
12 #include <server/chat.qh>
13 #include <server/client.qh>
14 #include <server/command/common.qh>
15 #include <server/mutators/_mod.qh>
16 #include <server/scores.qh>
17 #include <server/world.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 // switch between sprint and print depending on whether the receiver is the server or a player
172 void print_to(entity to, string input)
174 if (to) sprint(to, strcat(input, "\n"));
175 else print(input, "\n");
178 // ==========================================
179 // Supporting functions for common commands
180 // ==========================================
182 // used by CommonCommand_timeout() and CommonCommand_timein() to handle game pausing and messaging and such.
183 void timeout_handler_reset(entity this)
185 timeout_caller = NULL;
187 timeout_leadtime = 0;
192 void timeout_handler_think(entity this)
194 switch (timeout_status)
198 if (timeout_time > 0) // countdown is still going
200 Send_Notification(NOTIF_ALL, NULL, MSG_CENTER, CENTER_TIMEOUT_ENDING, timeout_time);
202 if (timeout_time == autocvar_sv_timeout_resumetime) // play a warning sound when only <sv_timeout_resumetime> seconds are left
203 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_PREPARE);
205 this.nextthink = time + TIMEOUT_SLOWMO_VALUE; // think again in one second
206 timeout_time -= 1; // decrease the time counter
208 else // time to end the timeout
210 Kill_Notification(NOTIF_ALL, NULL, MSG_CENTER, CPID_TIMEIN);
211 timeout_status = TIMEOUT_INACTIVE;
213 // reset the slowmo value back to normal
214 cvar_set("slowmo", ftos(orig_slowmo));
216 // unlock the view for players so they can move around again
217 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), {
221 timeout_handler_reset(this);
227 case TIMEOUT_LEADTIME:
229 if (timeout_leadtime > 0) // countdown is still going
231 Send_Notification(NOTIF_ALL, NULL, MSG_CENTER, CENTER_TIMEOUT_BEGINNING, timeout_leadtime);
233 this.nextthink = time + 1; // think again in one second
234 timeout_leadtime -= 1; // decrease the time counter
236 else // time to begin the timeout
238 timeout_status = TIMEOUT_ACTIVE;
240 // set the slowmo value to the timeout default slowmo value
241 cvar_set("slowmo", ftos(TIMEOUT_SLOWMO_VALUE));
243 // reset all the flood variables
244 FOREACH_CLIENT(true, {
245 it.nickspamcount = it.nickspamtime = it.floodcontrol_chat =
246 it.floodcontrol_chatteam = it.floodcontrol_chattell =
247 it.floodcontrol_voice = it.floodcontrol_voiceteam = 0;
250 // copy .v_angle to .lastV_angle for every player in order to fix their view during pause (see PlayerPreThink)
251 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), {
252 it.lastV_angle = it.v_angle;
255 this.nextthink = time; // think again next frame to handle it under TIMEOUT_ACTIVE code
262 case TIMEOUT_INACTIVE:
265 timeout_handler_reset(this);
272 // ===================================================
273 // Common commands used in both sv_cmd.qc and cmd.qc
274 // ===================================================
276 void CommonCommand_cvar_changes(int request, entity caller)
280 case CMD_REQUEST_COMMAND:
282 print_to(caller, cvar_changes);
283 return; // never fall through to usage
287 case CMD_REQUEST_USAGE:
289 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_changes"));
290 print_to(caller, " No arguments required.");
291 print_to(caller, "See also: ^2cvar_purechanges^7");
297 void CommonCommand_cvar_purechanges(int request, entity caller)
301 case CMD_REQUEST_COMMAND:
303 print_to(caller, cvar_purechanges);
304 return; // never fall through to usage
308 case CMD_REQUEST_USAGE:
310 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_purechanges"));
311 print_to(caller, " No arguments required.");
312 print_to(caller, "See also: ^2cvar_changes^7");
318 void CommonCommand_editmob(int request, entity caller, int argc)
322 case CMD_REQUEST_COMMAND:
324 if (autocvar_g_campaign) { print_to(caller, "Monster editing is disabled in singleplayer"); return; }
325 // no checks for g_monsters here, as it may be toggled mid match which existing monsters
329 makevectors(caller.v_angle);
330 WarpZone_TraceLine(caller.origin + caller.view_ofs, caller.origin + caller.view_ofs + v_forward * 100, MOVE_NORMAL, caller);
333 entity mon = trace_ent;
334 bool is_visible = IS_MONSTER(mon);
335 string argument = argv(2);
341 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
342 if (!argument) break; // escape to usage
343 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
344 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
345 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
347 string mon_oldname = mon.monster_name;
349 mon.monster_name = argument;
350 if (mon.sprite) WaypointSprite_UpdateSprites(mon.sprite, WP_Monster, WP_Null, WP_Null);
351 print_to(caller, sprintf("Your pet '%s' is now known as '%s'", mon_oldname, mon.monster_name));
356 if (!caller) { print_to(caller, "Only players can spawn monsters"); return; }
357 if (!argv(2)) break; // escape to usage
359 int moveflag, tmp_moncount = 0;
360 string arg_lower = strtolower(argument);
361 moveflag = (argv(3)) ? stof(argv(3)) : 1; // follow owner if not defined
363 if (arg_lower == "list") { print_to(caller, monsterlist_reply); return; }
365 IL_EACH(g_monsters, it.realowner == caller,
370 if (!autocvar_g_monsters) { print_to(caller, "Monsters are disabled"); return; }
371 if (autocvar_g_monsters_max <= 0 || autocvar_g_monsters_max_perplayer <= 0) { print_to(caller, "Monster spawning is disabled"); return; }
372 if (!IS_PLAYER(caller)) { print_to(caller, "You must be playing to spawn a monster"); return; }
373 if (MUTATOR_CALLHOOK(AllowMobSpawning, caller)) { print_to(caller, M_ARGV(1, string)); return; }
374 if (caller.vehicle) { print_to(caller, "You can't spawn monsters while driving a vehicle"); return; }
375 if (STAT(FROZEN, caller)) { print_to(caller, "You can't spawn monsters while frozen"); return; }
376 if (IS_DEAD(caller)) { print_to(caller, "You can't spawn monsters while dead"); return; }
377 if (tmp_moncount >= autocvar_g_monsters_max) { print_to(caller, "The maximum monster count has been reached"); return; }
378 if (tmp_moncount >= autocvar_g_monsters_max_perplayer) { print_to(caller, "You can't spawn any more monsters"); return; }
381 FOREACH(Monsters, it != MON_Null && it.netname == arg_lower,
387 if (!found && arg_lower != "random" && arg_lower != "anyrandom") { print_to(caller, "Invalid monster"); return; }
390 WarpZone_TraceBox(CENTER_OR_VIEWOFS(caller), caller.mins, caller.maxs, CENTER_OR_VIEWOFS(caller) + v_forward * 150, true, caller);
391 mon = spawnmonster(spawn(), arg_lower, MON_Null, caller, caller, trace_endpos, false, false, moveflag);
392 print_to(caller, strcat("Spawned ", mon.monster_name));
397 if (!caller) { print_to(caller, "Only players can kill monsters"); return; }
398 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
399 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
401 Damage(mon, NULL, NULL, GetResource(mon, RES_HEALTH) + mon.max_health + 200, DEATH_KILL.m_id, DMG_NOWEP, mon.origin, '0 0 0');
402 print_to(caller, strcat("Your pet '", mon.monster_name, "' has been brutally mutilated"));
407 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
408 if (!argument) break; // escape to usage
409 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
410 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
411 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
412 if (mon.monsterdef == MON_MAGE) { print_to(caller, "Mage skins can't be changed"); return; } // TODO
414 mon.skin = stof(argument);
415 print_to(caller, strcat("Monster skin successfully changed to ", ftos(mon.skin)));
420 if (!caller) { print_to(caller, "Only players can edit monsters"); return; }
421 if (!argument) break; // escape to usage
422 if (!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
423 if (!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
424 if (mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
426 mon.monster_moveflags = stof(argument);
427 print_to(caller, strcat("Monster move target successfully changed to ", ftos(mon.monster_moveflags)));
432 if (caller) { print_to(caller, "This command is not available to players"); return; }
433 if (MUTATOR_CALLHOOK(AllowMobButcher)) { LOG_INFO(M_ARGV(0, string)); return; }
435 int tmp_remcount = 0;
437 IL_EACH(g_monsters, true,
442 IL_CLEAR(g_monsters);
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(int request, entity caller, int argc)
469 case CMD_REQUEST_COMMAND:
471 string command = 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(int 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(int 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(int 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(int 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(int request, entity caller)
573 case CMD_REQUEST_COMMAND:
575 int num = stoi(argv(1));
576 if(num > 0 && num <= 10 && records_reply[num - 1] != "")
577 print_to(caller, records_reply[num - 1]);
580 for (int i = 0; i < 10; ++i)
581 if (records_reply[i] != "") print_to(caller, records_reply[i]);
584 return; // never fall through to usage
588 case CMD_REQUEST_USAGE:
590 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " records [<pagenum>]"));
591 print_to(caller, " Without arguments it prints all records (all pages) for the current gametype,");
592 print_to(caller, " otherwise if there are multiple pages it only prints page <pagenum> (1..10),");
598 void CommonCommand_teamstatus(int request, entity caller)
602 case CMD_REQUEST_COMMAND:
604 Score_NicePrint(caller);
605 return; // never fall through to usage
609 case CMD_REQUEST_USAGE:
611 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " teamstatus"));
612 print_to(caller, " No arguments required.");
618 void CommonCommand_time(int request, entity caller)
622 case CMD_REQUEST_COMMAND:
624 print_to(caller, strcat("time = ", ftos(time)));
625 print_to(caller, strcat("frame start = ", ftos(gettime(GETTIME_FRAMESTART))));
626 print_to(caller, strcat("realtime = ", ftos(gettime(GETTIME_REALTIME))));
627 print_to(caller, strcat("hires = ", ftos(gettime(GETTIME_HIRES))));
628 print_to(caller, strcat("uptime = ", ftos(gettime(GETTIME_UPTIME))));
629 print_to(caller, strcat("localtime = ", strftime(true, "%a %b %d %H:%M:%S %Z %Y")));
630 print_to(caller, strcat("gmtime = ", strftime(false, "%a %b %d %H:%M:%S %Z %Y")));
635 case CMD_REQUEST_USAGE:
637 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " time"));
638 print_to(caller, " No arguments required.");
644 void CommonCommand_timein(int request, entity caller)
648 case CMD_REQUEST_COMMAND:
650 if (!caller || autocvar_sv_timeout)
652 if (!timeout_status) { print_to(caller, "^7Error: There is no active timeout called."); }
653 else if (caller && (caller != timeout_caller))
655 print_to(caller, "^7Error: You are not allowed to stop the active timeout.");
658 else // everything should be okay, continue aborting timeout
660 switch (timeout_status)
662 case TIMEOUT_LEADTIME:
664 timeout_status = TIMEOUT_INACTIVE;
666 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
667 bprint(strcat("^7The timeout was aborted by ", GetCallerName(caller), " !\n"));
673 timeout_time = autocvar_sv_timeout_resumetime;
674 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
675 bprint(strcat("^1Attention: ^7", GetCallerName(caller), " resumed the game! Prepare for battle!\n"));
679 default: LOG_TRACE("timeout status was inactive, but this code was executed anyway?");
684 else { print_to(caller, "^1Timeins are not allowed to be called, enable them with sv_timeout 1.\n"); }
686 return; // never fall through to usage
690 case CMD_REQUEST_USAGE:
692 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timein"));
693 print_to(caller, " No arguments required.");
699 void CommonCommand_timeout(int request, entity caller) // DEAR GOD THIS COMMAND IS TERRIBLE.
703 case CMD_REQUEST_COMMAND:
705 if (!caller || autocvar_sv_timeout)
707 float last_possible_timeout = ((autocvar_timelimit * 60) - autocvar_sv_timeout_leadtime - 1);
709 if (timeout_status) { print_to(caller, "^7Error: A timeout is already active."); }
710 else if (vote_called)
712 print_to(caller, "^7Error: You can not call a timeout while a vote is active.");
714 else if (warmup_stage && !autocvar_g_warmup_allow_timeout)
716 print_to(caller, "^7Error: You can not call a timeout in warmup-stage.");
718 else if (time < game_starttime)
720 print_to(caller, "^7Error: You can not call a timeout while the map is being restarted.");
722 else if (caller && (CS(caller).allowed_timeouts < 1))
724 print_to(caller, "^7Error: You already used all your timeout calls for this map.");
726 else if (caller && !IS_PLAYER(caller))
728 print_to(caller, "^7Error: You must be a player to call a timeout.");
730 else if ((autocvar_timelimit) && (last_possible_timeout < time - game_starttime))
732 print_to(caller, "^7Error: It is too late to call a timeout now!");
735 else // everything should be okay, proceed with starting the timeout
737 if (caller) CS(caller).allowed_timeouts -= 1;
738 // write a bprint who started the timeout (and how many they have left)
739 bprint(GetCallerName(caller), " ^7called a timeout", (caller ? strcat(" (", ftos(CS(caller).allowed_timeouts), " timeout(s) left)") : ""), "!\n");
741 timeout_status = TIMEOUT_LEADTIME;
742 timeout_caller = caller;
743 timeout_time = autocvar_sv_timeout_length;
744 timeout_leadtime = autocvar_sv_timeout_leadtime;
746 timeout_handler = new(timeout_handler);
747 setthink(timeout_handler, timeout_handler_think);
748 timeout_handler.nextthink = time; // always let the entity think asap
750 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_TIMEOUT);
753 else { print_to(caller, "^1Timeouts are not allowed to be called, enable them with sv_timeout 1.\n"); }
755 return; // never fall through to usage
759 case CMD_REQUEST_USAGE:
761 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timeout"));
762 print_to(caller, " No arguments required.");
768 void CommonCommand_who(int request, entity caller, int argc)
772 case CMD_REQUEST_COMMAND:
774 float total_listed_players, is_bot;
776 float privacy = (caller && autocvar_sv_status_privacy);
777 string separator = strreplace("%", " ", strcat((argv(1) ? argv(1) : " "), "^7"));
778 string tmp_netaddress, tmp_crypto_idfp;
780 print_to(caller, strcat("List of client information", (privacy ? " (some data is hidden for privacy)" : ""), ":"));
781 print_to(caller, sprintf(strreplace(" ", separator, " %-4s %-20s %-5s %-3s %-9s %-16s %s "),
782 "ent", "nickname", "ping", "pl", "time", "ip", "crypto_id"));
784 total_listed_players = 0;
785 FOREACH_CLIENT(true, {
786 is_bot = (IS_BOT_CLIENT(it));
790 tmp_netaddress = "null/botclient";
791 tmp_crypto_idfp = "null/botclient";
795 tmp_netaddress = "hidden";
796 tmp_crypto_idfp = "hidden";
800 tmp_netaddress = it.netaddress;
801 tmp_crypto_idfp = it.crypto_idfp;
804 print_to(caller, sprintf(strreplace(" ", separator, " #%-3d %-20.20s %-5d %-3d %-9s %-16s %s "),
808 CS(it).ping_packetloss,
809 process_time(1, time - CS(it).jointime),
813 ++total_listed_players;
816 print_to(caller, strcat("Finished listing ", ftos(total_listed_players), " client(s) out of ", ftos(maxclients), " slots."));
818 return; // never fall through to usage
822 case CMD_REQUEST_USAGE:
824 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " who [<separator>]"));
825 print_to(caller, " Where <separator> is the optional string to separate the values with, default is a space.");
831 /* use this when creating a new command, making sure to place it in alphabetical order... also,
832 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
833 void CommonCommand_(int request, entity caller)
837 case CMD_REQUEST_COMMAND:
840 return; // never fall through to usage
844 case CMD_REQUEST_USAGE:
846 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " "));
847 print_to(caller, " No arguments required.");