1 #include "../../common/command/command.qh"
5 #include "../scores.qh"
7 #include "../../common/notifications.qh"
10 // ====================================================
11 // Shared code for server commands, written by Samual
12 // Last updated: December 27th, 2011
13 // ====================================================
15 // select the proper prefix for usage and other messages
16 string GetCommandPrefix(entity caller)
24 // if client return player nickname, or if server return admin nickname
25 string GetCallerName(entity caller)
28 return caller.netname;
30 return admin_name(); //((autocvar_sv_adminnick != "") ? autocvar_sv_adminnick : autocvar_hostname);
33 // verify that the client provided is acceptable for kicking
34 float VerifyKickableEntity(entity client)
36 if (!IS_REAL_CLIENT(client))
37 return CLIENT_NOT_REAL;
38 return CLIENT_ACCEPTABLE;
41 // verify that the client provided is acceptable for use
42 float VerifyClientEntity(entity client, float must_be_real, float must_be_bots)
44 if (!IS_CLIENT(client))
45 return CLIENT_DOESNT_EXIST;
46 else if(must_be_real && !IS_REAL_CLIENT(client))
47 return CLIENT_NOT_REAL;
48 else if(must_be_bots && !IS_BOT_CLIENT(client))
49 return CLIENT_NOT_BOT;
51 return CLIENT_ACCEPTABLE;
54 // if the client is not acceptable, return a string to be used for error messages
55 string GetClientErrorString_color(float clienterror, string original_input, string col)
59 case CLIENT_DOESNT_EXIST: { return strcat(col, "Client '", original_input, col, "' doesn't exist"); }
60 case CLIENT_NOT_REAL: { return strcat(col, "Client '", original_input, col, "' is not real"); }
61 case CLIENT_NOT_BOT: { return strcat(col, "Client '", original_input, col, "' is not a bot"); }
62 default: { return "Incorrect usage of GetClientErrorString"; }
66 // is this entity number even in the possible range of entities?
67 float VerifyClientNumber(float tmp_number)
69 if((tmp_number < 1) || (tmp_number > maxclients))
75 entity GetIndexedEntity(float argc, float start_index)
77 entity tmp_player, selection;
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));
104 else // maybe it's ONLY a number?
106 tmp_number = stof(argv(index));
110 if(VerifyClientNumber(tmp_number))
112 selection = edict_num(tmp_number); // yes, it was a number
114 else // no, maybe it's a name?
116 FOR_EACH_CLIENT(tmp_player)
117 if (strdecolorize(tmp_player.netname) == strdecolorize(argv(start_index)))
118 selection = tmp_player;
120 index = (start_index + 1);
125 //print(strcat("start_index: ", ftos(start_index), ", next_token: ", ftos(next_token), ", edict: ", ftos(num_for_edict(selection)), ".\n"));
129 // find a player which matches the input string, and return their entity
130 entity GetFilteredEntity(string input)
132 entity tmp_player, selection;
135 if(substring(input, 0, 1) == "#")
136 tmp_number = stof(substring(input, 1, -1));
138 tmp_number = stof(input);
140 if(VerifyClientNumber(tmp_number))
142 selection = edict_num(tmp_number);
147 FOR_EACH_CLIENT(tmp_player)
148 if (strdecolorize(tmp_player.netname) == strdecolorize(input))
149 selection = tmp_player;
155 // same thing, but instead return their edict number
156 float GetFilteredNumber(string input)
158 entity selection = GetFilteredEntity(input);
161 output = num_for_edict(selection);
166 // switch between sprint and print depending on whether the receiver is the server or a player
167 void print_to(entity to, string input)
170 sprint(to, strcat(input, "\n"));
172 LOG_INFO(input, "\n");
175 // ==========================================
176 // Supporting functions for common commands
177 // ==========================================
179 // used by CommonCommand_timeout() and CommonCommand_timein() to handle game pausing and messaging and such.
180 void timeout_handler_reset()
182 timeout_caller = world;
184 timeout_leadtime = 0;
189 void timeout_handler_think()
193 switch(timeout_status)
197 if(timeout_time > 0) // countdown is still going
199 Send_Notification(NOTIF_ALL, world, MSG_CENTER, CENTER_TIMEOUT_ENDING, timeout_time);
201 if(timeout_time == autocvar_sv_timeout_resumetime) // play a warning sound when only <sv_timeout_resumetime> seconds are left
202 Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_PREPARE);
204 self.nextthink = time + TIMEOUT_SLOWMO_VALUE; // think again in one second
205 timeout_time -= 1; // decrease the time counter
207 else // time to end the timeout
209 timeout_status = TIMEOUT_INACTIVE;
211 // reset the slowmo value back to normal
212 cvar_set("slowmo", ftos(orig_slowmo));
214 // unlock the view for players so they can move around again
215 FOR_EACH_REALPLAYER(tmp_player)
216 tmp_player.fixangle = false;
218 timeout_handler_reset();
224 case TIMEOUT_LEADTIME:
226 if(timeout_leadtime > 0) // countdown is still going
228 Send_Notification(NOTIF_ALL, world, MSG_CENTER, CENTER_TIMEOUT_BEGINNING, timeout_leadtime);
230 self.nextthink = time + 1; // think again in one second
231 timeout_leadtime -= 1; // decrease the time counter
233 else // time to begin the timeout
235 timeout_status = TIMEOUT_ACTIVE;
237 // set the slowmo value to the timeout default slowmo value
238 cvar_set("slowmo", ftos(TIMEOUT_SLOWMO_VALUE));
240 // reset all the flood variables
241 FOR_EACH_CLIENT(tmp_player)
242 tmp_player.nickspamcount = tmp_player.nickspamtime = tmp_player.floodcontrol_chat =
243 tmp_player.floodcontrol_chatteam = tmp_player.floodcontrol_chattell =
244 tmp_player.floodcontrol_voice = tmp_player.floodcontrol_voiceteam = 0;
246 // copy .v_angle to .lastV_angle for every player in order to fix their view during pause (see PlayerPreThink)
247 FOR_EACH_REALPLAYER(tmp_player)
248 tmp_player.lastV_angle = tmp_player.v_angle;
250 self.nextthink = time; // think again next frame to handle it under TIMEOUT_ACTIVE code
257 case TIMEOUT_INACTIVE:
260 timeout_handler_reset();
268 // ===================================================
269 // Common commands used in both sv_cmd.qc and cmd.qc
270 // ===================================================
272 void CommonCommand_cvar_changes(float request, entity caller)
276 case CMD_REQUEST_COMMAND:
278 print_to(caller, cvar_changes);
279 return; // never fall through to usage
283 case CMD_REQUEST_USAGE:
285 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_changes"));
286 print_to(caller, " No arguments required.");
287 print_to(caller, "See also: ^2cvar_purechanges^7");
293 void CommonCommand_cvar_purechanges(float request, entity caller)
297 case CMD_REQUEST_COMMAND:
299 print_to(caller, cvar_purechanges);
300 return; // never fall through to usage
304 case CMD_REQUEST_USAGE:
306 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_purechanges"));
307 print_to(caller, " No arguments required.");
308 print_to(caller, "See also: ^2cvar_changes^7");
314 void CommonCommand_editmob(int request, entity caller, int argc)
318 case CMD_REQUEST_COMMAND:
320 if(autocvar_g_campaign) { print_to(caller, "Monster editing is disabled in singleplayer"); return; }
321 // no checks for g_monsters here, as it may be toggled mid match which existing monsters
325 makevectors(self.v_angle);
326 WarpZone_TraceLine(self.origin + self.view_ofs, self.origin + self.view_ofs + v_forward * 100, MOVE_NORMAL, self);
329 entity mon = trace_ent;
330 bool is_visible = IS_MONSTER(mon);
331 string argument = argv(2);
337 if(!caller) { print_to(caller, "Only players can edit monsters"); return; }
338 if(!argument) { break; } // escape to usage
339 if(!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
340 if(mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
341 if(!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
343 string mon_oldname = mon.monster_name;
345 mon.monster_name = argument;
346 if(mon.sprite) { WaypointSprite_UpdateSprites(mon.sprite, WP_Monster, WP_Null, WP_Null); }
347 print_to(caller, sprintf("Your pet '%s' is now known as '%s'", mon_oldname, mon.monster_name));
352 if(!caller) { print_to(caller, "Only players can spawn monsters"); return; }
353 if(!argv(2)) { break; } // escape to usage
355 int moveflag, tmp_moncount = 0;
356 string arg_lower = strtolower(argument);
357 moveflag = (argv(3)) ? stof(argv(3)) : 1; // follow owner if not defined
358 ret_string = "Monster spawning is currently disabled by a mutator";
360 if(arg_lower == "list") { print_to(caller, monsterlist_reply); return; }
362 FOR_EACH_MONSTER(mon) { if(mon.realowner == caller) ++tmp_moncount; }
364 if(!autocvar_g_monsters) { print_to(caller, "Monsters are disabled"); return; }
365 if(autocvar_g_monsters_max <= 0 || autocvar_g_monsters_max_perplayer <= 0) { print_to(caller, "Monster spawning is disabled"); return; }
366 if(!IS_PLAYER(caller)) { print_to(caller, "You must be playing to spawn a monster"); return; }
367 if(MUTATOR_CALLHOOK(AllowMobSpawning)) { print_to(caller, ret_string); return; }
368 if(caller.vehicle) { print_to(caller, "You can't spawn monsters while driving a vehicle"); return; }
369 if(caller.frozen) { print_to(caller, "You can't spawn monsters while frozen"); return; }
370 if(caller.deadflag != DEAD_NO) { print_to(caller, "You can't spawn monsters while dead"); return; }
371 if(tmp_moncount >= autocvar_g_monsters_max) { print_to(caller, "The maximum monster count has been reached"); return; }
372 if(tmp_moncount >= autocvar_g_monsters_max_perplayer) { print_to(caller, "You can't spawn any more monsters"); return; }
375 for(int i = MON_FIRST; i <= MON_LAST; ++i)
377 mon = get_monsterinfo(i);
378 if(mon.netname == arg_lower) { found = true; break; }
381 if(!found && arg_lower != "random") { print_to(caller, "Invalid monster"); return; }
384 WarpZone_TraceBox (CENTER_OR_VIEWOFS(caller), caller.mins, caller.maxs, CENTER_OR_VIEWOFS(caller) + v_forward * 150, true, caller);
385 mon = spawnmonster(arg_lower, 0, caller, caller, trace_endpos, false, false, moveflag);
386 print_to(caller, strcat("Spawned ", mon.monster_name));
391 if(!caller) { print_to(caller, "Only players can kill monsters"); return; }
392 if(mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
393 if(!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
395 Damage (mon, world, world, mon.health + mon.max_health + 200, DEATH_KILL, mon.origin, '0 0 0');
396 print_to(caller, strcat("Your pet '", mon.monster_name, "' has been brutally mutilated"));
401 if(!caller) { print_to(caller, "Only players can edit monsters"); return; }
402 if(!argument) { break; } // escape to usage
403 if(!autocvar_g_monsters_edit) { print_to(caller, "Monster editing is disabled"); return; }
404 if(!is_visible) { print_to(caller, "You must look at your monster to edit it"); return; }
405 if(mon.realowner != caller && autocvar_g_monsters_edit < 2) { print_to(caller, "This monster does not belong to you"); return; }
406 if(mon.monsterid == MON_MAGE.monsterid) { print_to(caller, "Mage skins can't be changed"); return; } // TODO
408 mon.skin = stof(argument);
409 print_to(caller, strcat("Monster skin successfully changed to ", ftos(mon.skin)));
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; }
420 mon.monster_moveflags = stof(argument);
421 print_to(caller, strcat("Monster move target successfully changed to ", ftos(mon.monster_moveflags)));
426 if(caller) { print_to(caller, "This command is not available to players"); return; }
427 if(g_invasion) { print_to(caller, "This command does not work during an invasion!"); return; }
429 int tmp_remcount = 0;
432 FOR_EACH_MONSTER(tmp_entity) { Monster_Remove(tmp_entity); ++tmp_remcount; }
434 monsters_total = monsters_killed = totalspawned = 0;
436 print_to(caller, (tmp_remcount) ? sprintf("Killed %d monster%s", tmp_remcount, (tmp_remcount == 1) ? "" : "s") : "No monsters to kill");
443 case CMD_REQUEST_USAGE:
445 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " editmob command [arguments]"));
446 print_to(caller, " Where 'command' can be butcher spawn skin movetarget kill name");
447 print_to(caller, " spawn, skin, movetarget and name require 'arguments'");
448 print_to(caller, " spawn also takes arguments list and random");
449 print_to(caller, " Monster will follow owner if third argument of spawn command is not defined");
455 void CommonCommand_info(float request, entity caller, float argc)
459 case CMD_REQUEST_COMMAND:
461 string command = builtin_cvar_string(strcat("sv_info_", argv(1)));
464 wordwrap_sprint(command, 1000);
466 print_to(caller, "ERROR: unsupported info command");
468 return; // never fall through to usage
472 case CMD_REQUEST_USAGE:
474 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " info request"));
475 print_to(caller, " Where 'request' is the suffixed string appended onto the request for cvar.");
481 void CommonCommand_ladder(float request, entity caller)
485 case CMD_REQUEST_COMMAND:
487 print_to(caller, ladder_reply);
488 return; // never fall through to usage
492 case CMD_REQUEST_USAGE:
494 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " ladder"));
495 print_to(caller, " No arguments required.");
501 void CommonCommand_lsmaps(float request, entity caller)
505 case CMD_REQUEST_COMMAND:
507 print_to(caller, lsmaps_reply);
508 return; // never fall through to usage
512 case CMD_REQUEST_USAGE:
514 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " lsmaps"));
515 print_to(caller, " No arguments required.");
521 void CommonCommand_printmaplist(float request, entity caller)
525 case CMD_REQUEST_COMMAND:
527 print_to(caller, maplist_reply);
528 return; // never fall through to usage
532 case CMD_REQUEST_USAGE:
534 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " printmaplist"));
535 print_to(caller, " No arguments required.");
541 void CommonCommand_rankings(float request, entity caller)
545 case CMD_REQUEST_COMMAND:
547 print_to(caller, rankings_reply);
548 return; // never fall through to usage
552 case CMD_REQUEST_USAGE:
554 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " rankings"));
555 print_to(caller, " No arguments required.");
561 void CommonCommand_records(float request, entity caller)
565 case CMD_REQUEST_COMMAND:
567 for(int i = 0; i < 10; ++i)
568 if(records_reply[i] != "")
569 print_to(caller, records_reply[i]);
571 return; // never fall through to usage
575 case CMD_REQUEST_USAGE:
577 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " records"));
578 print_to(caller, " No arguments required.");
584 void CommonCommand_teamstatus(float request, entity caller)
588 case CMD_REQUEST_COMMAND:
590 Score_NicePrint(caller);
591 return; // never fall through to usage
595 case CMD_REQUEST_USAGE:
597 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " teamstatus"));
598 print_to(caller, " No arguments required.");
604 void CommonCommand_time(float request, entity caller)
608 case CMD_REQUEST_COMMAND:
610 print_to(caller, strcat("time = ", ftos(time)));
611 print_to(caller, strcat("frame start = ", ftos(gettime(GETTIME_FRAMESTART))));
612 print_to(caller, strcat("realtime = ", ftos(gettime(GETTIME_REALTIME))));
613 print_to(caller, strcat("hires = ", ftos(gettime(GETTIME_HIRES))));
614 print_to(caller, strcat("uptime = ", ftos(gettime(GETTIME_UPTIME))));
615 print_to(caller, strcat("localtime = ", strftime(true, "%a %b %e %H:%M:%S %Z %Y")));
616 print_to(caller, strcat("gmtime = ", strftime(false, "%a %b %e %H:%M:%S %Z %Y")));
621 case CMD_REQUEST_USAGE:
623 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " time"));
624 print_to(caller, " No arguments required.");
630 void CommonCommand_timein(float request, entity caller)
634 case CMD_REQUEST_COMMAND:
636 if(!caller || autocvar_sv_timeout)
638 if (!timeout_status) { print_to(caller, "^7Error: There is no active timeout called."); }
639 else if(caller && (caller != timeout_caller)) { print_to(caller, "^7Error: You are not allowed to stop the active timeout."); }
641 else // everything should be okay, continue aborting timeout
643 switch(timeout_status)
645 case TIMEOUT_LEADTIME:
647 timeout_status = TIMEOUT_INACTIVE;
649 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
650 bprint(strcat("^7The timeout was aborted by ", GetCallerName(caller), " !\n"));
656 timeout_time = autocvar_sv_timeout_resumetime;
657 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
658 bprint(strcat("^1Attention: ^7", GetCallerName(caller), " resumed the game! Prepare for battle!\n"));
662 default: LOG_TRACE("timeout status was inactive, but this code was executed anyway?"); return;
666 else { print_to(caller, "^1Timeins are not allowed to be called, enable them with sv_timeout 1.\n"); }
668 return; // never fall through to usage
672 case CMD_REQUEST_USAGE:
674 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timein"));
675 print_to(caller, " No arguments required.");
681 void CommonCommand_timeout(float request, entity caller) // DEAR GOD THIS COMMAND IS TERRIBLE.
685 case CMD_REQUEST_COMMAND:
687 if(!caller || autocvar_sv_timeout)
689 float last_possible_timeout = ((autocvar_timelimit * 60) - autocvar_sv_timeout_leadtime - 1);
691 if(timeout_status) { print_to(caller, "^7Error: A timeout is already active."); }
692 else if(vote_called) { print_to(caller, "^7Error: You can not call a timeout while a vote is active."); }
693 else if(warmup_stage && !g_warmup_allow_timeout) { print_to(caller, "^7Error: You can not call a timeout in warmup-stage."); }
694 else if(time < game_starttime) { print_to(caller, "^7Error: You can not call a timeout while the map is being restarted."); }
695 else if(caller && (caller.allowed_timeouts < 1)) { print_to(caller, "^7Error: You already used all your timeout calls for this map."); }
696 else if(caller && !IS_PLAYER(caller)) { print_to(caller, "^7Error: You must be a player to call a timeout."); }
697 else if((autocvar_timelimit) && (last_possible_timeout < time - game_starttime)) { print_to(caller, "^7Error: It is too late to call a timeout now!"); }
699 else // everything should be okay, proceed with starting the timeout
701 if(caller) { caller.allowed_timeouts -= 1; }
703 // write a bprint who started the timeout (and how many they have left)
704 bprint(GetCallerName(caller), " ^7called a timeout", (caller ? strcat(" (", ftos(caller.allowed_timeouts), " timeout(s) left)") : ""), "!\n");
706 timeout_status = TIMEOUT_LEADTIME;
707 timeout_caller = caller;
708 timeout_time = autocvar_sv_timeout_length;
709 timeout_leadtime = autocvar_sv_timeout_leadtime;
711 timeout_handler = spawn();
712 timeout_handler.think = timeout_handler_think;
713 timeout_handler.nextthink = time; // always let the entity think asap
715 Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_TIMEOUT);
718 else { print_to(caller, "^1Timeouts are not allowed to be called, enable them with sv_timeout 1.\n"); }
720 return; // never fall through to usage
724 case CMD_REQUEST_USAGE:
726 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timeout"));
727 print_to(caller, " No arguments required.");
733 void CommonCommand_who(float request, entity caller, float argc)
737 case CMD_REQUEST_COMMAND:
739 float total_listed_players, is_bot;
742 float privacy = (caller && autocvar_sv_status_privacy);
743 string separator = strreplace("%", " ", strcat((argv(1) ? argv(1) : " "), "^7"));
744 string tmp_netaddress, tmp_crypto_idfp;
746 print_to(caller, strcat("List of client information", (privacy ? " (some data is hidden for privacy)" : ""), ":"));
747 print_to(caller, sprintf(strreplace(" ", separator, " %-4s %-20s %-5s %-3s %-9s %-16s %s "),
748 "ent", "nickname", "ping", "pl", "time", "ip", "crypto_id"));
750 total_listed_players = 0;
751 FOR_EACH_CLIENT(tmp_player)
753 is_bot = (IS_BOT_CLIENT(tmp_player));
757 tmp_netaddress = "null/botclient";
758 tmp_crypto_idfp = "null/botclient";
762 tmp_netaddress = "hidden";
763 tmp_crypto_idfp = "hidden";
767 tmp_netaddress = tmp_player.netaddress;
768 tmp_crypto_idfp = tmp_player.crypto_idfp;
771 print_to(caller, sprintf(strreplace(" ", separator, " #%-3d %-20.20s %-5d %-3d %-9s %-16s %s "),
772 num_for_edict(tmp_player),
775 tmp_player.ping_packetloss,
776 process_time(1, time - tmp_player.jointime),
780 ++total_listed_players;
783 print_to(caller, strcat("Finished listing ", ftos(total_listed_players), " client(s) out of ", ftos(maxclients), " slots."));
785 return; // never fall through to usage
789 case CMD_REQUEST_USAGE:
791 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " who [separator]"));
792 print_to(caller, " Where 'separator' is the optional string to separate the values with, default is a space.");
798 /* use this when creating a new command, making sure to place it in alphabetical order... also,
799 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
800 void CommonCommand_(float request, entity caller)
804 case CMD_REQUEST_COMMAND:
807 return; // never fall through to usage
811 case CMD_REQUEST_USAGE:
813 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " "));
814 print_to(caller, " No arguments required.");