1 // ====================================================
2 // Shared code for server commands, written by Samual
3 // Last updated: December 27th, 2011
4 // ====================================================
6 // select the proper prefix for usage and other messages
7 string GetCommandPrefix(entity caller)
15 // if client return player nickname, or if server return admin nickname
16 string GetCallerName(entity caller)
19 return caller.netname;
21 return admin_name(); //((autocvar_sv_adminnick != "") ? autocvar_sv_adminnick : autocvar_hostname);
24 // verify that the client provided is acceptable for use
25 float VerifyClientEntity(entity client, float must_be_real, float must_be_bots)
27 if not(client.flags & FL_CLIENT)
28 return CLIENT_DOESNT_EXIST;
29 else if(must_be_real && (clienttype(client) != CLIENTTYPE_REAL))
30 return CLIENT_NOT_REAL;
31 else if(must_be_bots && (clienttype(client) != CLIENTTYPE_BOT))
32 return CLIENT_NOT_BOT;
34 return CLIENT_ACCEPTABLE;
37 // if the client is not acceptable, return a string to be used for error messages
38 string GetClientErrorString(float clienterror, string original_input)
42 case CLIENT_DOESNT_EXIST: { return strcat("Client '", original_input, "' doesn't exist"); }
43 case CLIENT_NOT_REAL: { return strcat("Client '", original_input, "' is not real"); }
44 case CLIENT_NOT_BOT: { return strcat("Client '", original_input, "' is not a bot"); }
45 default: { return "Incorrect usage of GetClientErrorString"; }
49 // is this entity number even in the possible range of entities?
50 float VerifyClientNumber(float tmp_number)
52 if((tmp_number < 1) || (tmp_number > maxclients))
58 entity GetIndexedEntity(float argc, float start_index)
60 entity tmp_player, selection;
61 float tmp_number, index;
67 if(argc > start_index)
69 if(substring(argv(index), 0, 1) == "#")
71 tmp_string = substring(argv(index), 1, -1);
74 if(tmp_string != "") // is it all one token? like #1
76 tmp_number = stof(tmp_string);
78 else if(argc > index) // no, it's two tokens? # 1
80 tmp_number = stof(argv(index));
84 else // maybe it's ONLY a number?
86 tmp_number = stof(argv(index));
90 if(VerifyClientNumber(tmp_number))
92 selection = edict_num(tmp_number); // yes, it was a number
94 else // no, maybe it's a name?
96 FOR_EACH_CLIENT(tmp_player)
97 if (strdecolorize(tmp_player.netname) == strdecolorize(argv(start_index)))
98 selection = tmp_player;
100 index = (start_index + 1);
105 print(strcat("start_index: ", ftos(start_index), ", next_token: ", ftos(next_token), ", edict: ", ftos(num_for_edict(selection)), ".\n"));
109 // find a player which matches the input string, and return their entity
110 entity GetFilteredEntity(string input)
112 entity tmp_player, selection;
115 if(substring(input, 0, 1) == "#")
116 tmp_number = stof(substring(input, 1, -1));
118 tmp_number = stof(input);
120 if(VerifyClientNumber(tmp_number))
122 selection = edict_num(tmp_number);
126 FOR_EACH_CLIENT(tmp_player)
127 if (strdecolorize(tmp_player.netname) == strdecolorize(input))
128 selection = tmp_player;
134 // same thing, but instead return their edict number
135 float GetFilteredNumber(string input)
137 entity selection = GetFilteredEntity(input);
140 if(selection) { output = num_for_edict(selection); }
145 // switch between sprint and print depending on whether the reciever is the server or a player
146 void print_to(entity to, string input)
149 sprint(to, strcat(input, "\n"));
154 // ==========================================
155 // Supporting functions for common commands
156 // ==========================================
158 // used by CommonCommand_timeout() and CommonCommand_timein() to handle game pausing and messaging and such.
159 void timeout_handler_reset()
163 timeout_caller = world;
165 timeout_leadtime = 0;
167 FOR_EACH_REALPLAYER(tmp_player)
168 Send_CSQC_Centerprint_Generic_Expire(tmp_player, CPID_TIMEOUT_COUNTDOWN);
173 void timeout_handler_think()
177 switch(timeout_status)
181 if(timeout_time > 0) // countdown is still going
183 FOR_EACH_REALPLAYER(tmp_player)
184 Send_CSQC_Centerprint_Generic(tmp_player, CPID_TIMEOUT_COUNTDOWN, "Timeout ends in %d seconds!", 1, timeout_time);
186 if(timeout_time == autocvar_sv_timeout_resumetime) // play a warning sound when only <sv_timeout_resumetime> seconds are left
187 Announce("prepareforbattle");
189 self.nextthink = time + TIMEOUT_SLOWMO_VALUE; // think again in one second
190 timeout_time -= 1; // decrease the time counter
192 else // time to end the timeout
194 timeout_status = TIMEOUT_INACTIVE;
196 // reset the slowmo value back to normal
197 cvar_set("slowmo", ftos(orig_slowmo));
199 // unlock the view for players so they can move around again
200 FOR_EACH_REALPLAYER(tmp_player)
201 tmp_player.fixangle = FALSE;
203 timeout_handler_reset();
209 case TIMEOUT_LEADTIME:
211 if(timeout_leadtime > 0) // countdown is still going
213 // centerprint the information to every player
214 FOR_EACH_REALPLAYER(tmp_player)
215 Send_CSQC_Centerprint_Generic(tmp_player, CPID_TIMEOUT_COUNTDOWN, "Timeout begins in %d seconds!", 1, timeout_leadtime);
217 self.nextthink = time + 1; // think again in one second
218 timeout_leadtime -= 1; // decrease the time counter
220 else // time to begin the timeout
222 timeout_status = TIMEOUT_ACTIVE;
224 // set the slowmo value to the timeout default slowmo value
225 cvar_set("slowmo", ftos(TIMEOUT_SLOWMO_VALUE));
227 // reset all the flood variables
228 FOR_EACH_CLIENT(tmp_player)
229 tmp_player.nickspamcount = tmp_player.nickspamtime = tmp_player.floodcontrol_chat =
230 tmp_player.floodcontrol_chatteam = tmp_player.floodcontrol_chattell =
231 tmp_player.floodcontrol_voice = tmp_player.floodcontrol_voiceteam = 0;
233 // copy .v_angle to .lastV_angle for every player in order to fix their view during pause (see PlayerPreThink)
234 FOR_EACH_REALPLAYER(tmp_player)
235 tmp_player.lastV_angle = tmp_player.v_angle;
237 self.nextthink = time; // think again next frame to handle it under TIMEOUT_ACTIVE code
244 case TIMEOUT_INACTIVE:
247 timeout_handler_reset();
255 // ===================================================
256 // Common commands used in both sv_cmd.qc and cmd.qc
257 // ===================================================
259 void CommonCommand_cvar_changes(float request, entity caller)
263 case CMD_REQUEST_COMMAND:
265 print_to(caller, cvar_changes);
266 return; // never fall through to usage
270 case CMD_REQUEST_USAGE:
272 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_changes"));
273 print_to(caller, " No arguments required.");
274 print_to(caller, "See also: ^2cvar_purechanges^7");
280 void CommonCommand_cvar_purechanges(float request, entity caller)
284 case CMD_REQUEST_COMMAND:
286 print_to(caller, cvar_purechanges);
287 return; // never fall through to usage
291 case CMD_REQUEST_USAGE:
293 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_purechanges"));
294 print_to(caller, " No arguments required.");
295 print_to(caller, "See also: ^2cvar_changes^7");
301 void CommonCommand_info(float request, entity caller, float argc)
305 case CMD_REQUEST_COMMAND:
307 string command = builtin_cvar_string(strcat("sv_info_", argv(1)));
310 wordwrap_sprint(command, 1000);
312 print_to(caller, "ERROR: unsupported info command");
314 return; // never fall through to usage
318 case CMD_REQUEST_USAGE:
320 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " info request"));
321 print_to(caller, " Where 'request' is the suffixed string appended onto the request for cvar.");
327 void CommonCommand_ladder(float request, entity caller)
331 case CMD_REQUEST_COMMAND:
333 print_to(caller, ladder_reply);
334 return; // never fall through to usage
338 case CMD_REQUEST_USAGE:
340 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " ladder"));
341 print_to(caller, " No arguments required.");
347 void CommonCommand_lsmaps(float request, entity caller)
351 case CMD_REQUEST_COMMAND:
353 print_to(caller, lsmaps_reply);
354 return; // never fall through to usage
358 case CMD_REQUEST_USAGE:
360 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " lsmaps"));
361 print_to(caller, " No arguments required.");
367 void CommonCommand_lsnewmaps(float request, entity caller)
371 case CMD_REQUEST_COMMAND:
373 print_to(caller, lsnewmaps_reply);
374 return; // never fall through to usage
378 case CMD_REQUEST_USAGE:
380 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " lsnewmaps"));
381 print_to(caller, " No arguments required.");
387 void CommonCommand_printmaplist(float request, entity caller)
391 case CMD_REQUEST_COMMAND:
393 print_to(caller, maplist_reply);
394 return; // never fall through to usage
398 case CMD_REQUEST_USAGE:
400 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " printmaplist"));
401 print_to(caller, " No arguments required.");
407 void CommonCommand_rankings(float request, entity caller)
411 case CMD_REQUEST_COMMAND:
413 print_to(caller, rankings_reply);
414 return; // never fall through to usage
418 case CMD_REQUEST_USAGE:
420 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " rankings"));
421 print_to(caller, " No arguments required.");
427 void CommonCommand_records(float request, entity caller)
431 case CMD_REQUEST_COMMAND:
435 for(i = 0; i < 10; ++i)
437 print_to(caller, records_reply[i]);
439 return; // never fall through to usage
443 case CMD_REQUEST_USAGE:
445 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " records"));
446 print_to(caller, " No arguments required.");
452 void CommonCommand_teamstatus(float request, entity caller)
456 case CMD_REQUEST_COMMAND:
458 Score_NicePrint(caller);
459 return; // never fall through to usage
463 case CMD_REQUEST_USAGE:
465 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " teamstatus"));
466 print_to(caller, " No arguments required.");
472 void CommonCommand_time(float request, entity caller)
476 case CMD_REQUEST_COMMAND:
478 print_to(caller, strcat("time = ", ftos(time)));
479 print_to(caller, strcat("frame start = ", ftos(gettime(GETTIME_FRAMESTART))));
480 print_to(caller, strcat("realtime = ", ftos(gettime(GETTIME_REALTIME))));
481 print_to(caller, strcat("hires = ", ftos(gettime(GETTIME_HIRES))));
482 print_to(caller, strcat("uptime = ", ftos(gettime(GETTIME_UPTIME))));
483 print_to(caller, strcat("localtime = ", strftime(TRUE, "%a %b %e %H:%M:%S %Z %Y")));
484 print_to(caller, strcat("gmtime = ", strftime(FALSE, "%a %b %e %H:%M:%S %Z %Y")));
489 case CMD_REQUEST_USAGE:
491 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " time"));
492 print_to(caller, " No arguments required.");
498 void CommonCommand_timein(float request, entity caller)
502 case CMD_REQUEST_COMMAND:
504 if(!caller || autocvar_sv_timeout)
506 if not(timeout_status) { print_to(caller, "^7Error: There is no active timeout called."); }
507 else if(caller && (caller != timeout_caller)) { print_to(caller, "^7Error: You are not allowed to stop the active timeout."); }
509 else // everything should be okay, continue aborting timeout
511 switch(timeout_status)
513 case TIMEOUT_LEADTIME:
515 timeout_status = TIMEOUT_INACTIVE;
517 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
518 bprint(strcat("^7The timeout was aborted by ", GetCallerName(caller), " !\n"));
524 timeout_time = autocvar_sv_timeout_resumetime;
525 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
526 bprint(strcat("^1Attention: ^7", GetCallerName(caller), " resumed the game! Prepare for battle!\n"));
530 default: dprint("timeout status was inactive, but this code was executed anyway?"); return;
534 else { print_to(caller, "^1Timeins are not allowed to be called, enable them with sv_timeout 1.\n"); }
536 return; // never fall through to usage
540 case CMD_REQUEST_USAGE:
542 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timein"));
543 print_to(caller, " No arguments required.");
549 void CommonCommand_timeout(float request, entity caller) // DEAR GOD THIS COMMAND IS TERRIBLE.
553 case CMD_REQUEST_COMMAND:
555 if(!caller || autocvar_sv_timeout)
557 float last_possible_timeout = ((autocvar_timelimit * 60) - autocvar_sv_timeout_leadtime - 1);
559 if(timeout_status) { print_to(caller, "^7Error: A timeout is already active."); }
560 else if(vote_called) { print_to(caller, "^7Error: You can not call a timeout while a vote is active."); }
561 else if(inWarmupStage && !g_warmup_allow_timeout) { print_to(caller, "^7Error: You can not call a timeout in warmup-stage."); }
562 else if(time < game_starttime) { print_to(caller, "^7Error: You can not call a timeout while the map is being restarted."); }
563 else if(caller && (caller.allowed_timeouts < 1)) { print_to(caller, "^7Error: You already used all your timeout calls for this map."); }
564 else if(caller && (caller.classname != "player")) { print_to(caller, "^7Error: You must be a player to call a timeout."); }
565 else if((autocvar_timelimit) && (last_possible_timeout < time - game_starttime)) { print_to(caller, "^7Error: It is too late to call a timeout now!"); }
567 else // everything should be okay, proceed with starting the timeout
569 if(caller) { caller.allowed_timeouts -= 1; }
571 bprint(GetCallerName(caller), " ^7called a timeout", (caller ? strcat(" (", ftos(caller.allowed_timeouts), " timeout(s) left)") : string_null), "!\n"); // write a bprint who started the timeout (and how many they have left)
573 timeout_status = TIMEOUT_LEADTIME;
574 timeout_caller = caller;
575 timeout_time = autocvar_sv_timeout_length;
576 timeout_leadtime = autocvar_sv_timeout_leadtime;
578 timeout_handler = spawn();
579 timeout_handler.think = timeout_handler_think;
580 timeout_handler.nextthink = time; // always let the entity think asap
582 Announce("timeoutcalled");
585 else { print_to(caller, "^1Timeouts are not allowed to be called, enable them with sv_timeout 1.\n"); }
587 return; // never fall through to usage
591 case CMD_REQUEST_USAGE:
593 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timeout"));
594 print_to(caller, " No arguments required.");
600 void CommonCommand_who(float request, entity caller, float argc)
604 case CMD_REQUEST_COMMAND:
606 float total_listed_players, tmp_hours, tmp_minutes, tmp_seconds, is_bot;
609 float privacy = (caller && autocvar_sv_status_privacy);
610 string separator = strreplace("%", " ", strcat((argv(1) ? argv(1) : " "), "^7"));
611 string tmp_netaddress, tmp_crypto_idfp;
613 print_to(caller, strcat("List of client information", (privacy ? " (some data is hidden for privacy)" : string_null), ":"));
614 print_to(caller, sprintf(strreplace(" ", separator, " %-4s %-20s %-5s %-3s %-9s %-16s %s "),
615 "ent", "nickname", "ping", "pl", "time", "ip", "crypto_id"));
617 FOR_EACH_CLIENT(tmp_player)
619 is_bot = (clienttype(tmp_player) == CLIENTTYPE_BOT);
623 tmp_netaddress = "null/botclient";
624 tmp_crypto_idfp = "null/botclient";
628 tmp_netaddress = "hidden";
629 tmp_crypto_idfp = "hidden";
633 tmp_netaddress = tmp_player.netaddress;
634 tmp_crypto_idfp = tmp_player.crypto_idfp;
637 tmp_hours = tmp_minutes = tmp_seconds = 0;
639 tmp_seconds = floor(time - tmp_player.jointime);
640 tmp_minutes = floor(tmp_seconds / 60);
641 tmp_hours = floor(tmp_minutes / 60);
643 if(tmp_minutes) { tmp_seconds -= (tmp_minutes * 60); }
644 if(tmp_hours) { tmp_minutes -= (tmp_hours * 60); }
646 print_to(caller, sprintf(strreplace(" ", separator, " #%-3d %-20.20s %-5d %-3d %-9s %-16s %s "),
647 num_for_edict(tmp_player),
650 tmp_player.ping_packetloss,
651 sprintf("%02d:%02d:%02d", tmp_hours, tmp_minutes, tmp_seconds),
655 ++total_listed_players;
658 print_to(caller, strcat("Finished listing ", ftos(total_listed_players), " client(s) out of ", ftos(maxclients), " slots."));
660 return; // never fall through to usage
664 case CMD_REQUEST_USAGE:
666 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " who [separator]"));
667 print_to(caller, " Where 'separator' is the optional string to separate the values with, default is a space.");
673 /* use this when creating a new command, making sure to place it in alphabetical order... also,
674 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
675 void CommonCommand_(float request, entity caller)
679 case CMD_REQUEST_COMMAND:
682 return; // never fall through to usage
686 case CMD_REQUEST_USAGE:
688 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " "));
689 print_to(caller, " No arguments required.");
697 // ==================================
698 // Macro system for common commands
699 // ==================================
701 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
702 #define COMMON_COMMANDS(request,caller,arguments,command) \
703 COMMON_COMMAND("cvar_changes", CommonCommand_cvar_changes(request, caller), "Prints a list of all changed server cvars") \
704 COMMON_COMMAND("cvar_purechanges", CommonCommand_cvar_purechanges(request, caller), "Prints a list of all changed gameplay cvars") \
705 COMMON_COMMAND("info", CommonCommand_info(request, caller, arguments), "Request for unique server information set up by admin") \
706 COMMON_COMMAND("ladder", CommonCommand_ladder(request, caller), "Get information about top players if supported") \
707 COMMON_COMMAND("lsmaps", CommonCommand_lsmaps(request, caller), "List maps which can be used with the current game mode") \
708 COMMON_COMMAND("lsnewmaps", CommonCommand_lsnewmaps(request, caller), "List maps which have no records or are seemingly unplayed yet") \
709 COMMON_COMMAND("printmaplist", CommonCommand_printmaplist(request, caller), "Display full server maplist reply") \
710 COMMON_COMMAND("rankings", CommonCommand_rankings(request, caller), "Print information about rankings") \
711 COMMON_COMMAND("records", CommonCommand_records(request, caller), "List top 10 records for the current map") \
712 COMMON_COMMAND("teamstatus", CommonCommand_teamstatus(request, caller), "Show information about player and team scores") \
713 COMMON_COMMAND("time", CommonCommand_time(request, caller), "Print different formats/readouts of time") \
714 COMMON_COMMAND("timein", CommonCommand_timein(request, caller), "Resume the game from being paused with a timeout") \
715 COMMON_COMMAND("timeout", CommonCommand_timeout(request, caller), "Call a timeout which pauses the game for certain amount of time unless unpaused") \
716 COMMON_COMMAND("vote", VoteCommand(request, caller, arguments, command), "Request an action to be voted upon by players") \
717 COMMON_COMMAND("who", CommonCommand_who(request, caller, arguments), "Display detailed client information about all players") \
720 void CommonCommand_macro_help(entity caller)
722 #define COMMON_COMMAND(name,function,description) \
723 { print_to(caller, strcat(" ^2", name, "^7: ", description)); }
725 COMMON_COMMANDS(0, caller, 0, "")
726 #undef COMMON_COMMAND
731 float CommonCommand_macro_command(float argc, entity caller, string command)
733 #define COMMON_COMMAND(name,function,description) \
734 { if(name == strtolower(argv(0))) { function; return TRUE; } }
736 COMMON_COMMANDS(CMD_REQUEST_COMMAND, caller, argc, command)
737 #undef COMMON_COMMAND
742 float CommonCommand_macro_usage(float argc, entity caller)
744 #define COMMON_COMMAND(name,function,description) \
745 { if(name == strtolower(argv(1))) { function; return TRUE; } }
747 COMMON_COMMANDS(CMD_REQUEST_USAGE, caller, argc, "")
748 #undef COMMON_COMMAND
753 void CommonCommand_macro_write_aliases(float fh)
755 #define COMMON_COMMAND(name,function,description) \
756 { CMD_Write_Alias("qc_cmd_svcmd", name, description); }
758 COMMON_COMMANDS(0, world, 0, "")
759 #undef COMMON_COMMAND