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 (!IS_CLIENT(client))
28 return CLIENT_DOESNT_EXIST;
29 else if(must_be_real && !IS_REAL_CLIENT(client))
30 return CLIENT_NOT_REAL;
31 else if(must_be_bots && !IS_BOT_CLIENT(client))
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;
68 if(argc > start_index)
70 if(substring(argv(index), 0, 1) == "#")
72 tmp_string = substring(argv(index), 1, -1);
75 if(tmp_string != "") // is it all one token? like #1
77 tmp_number = stof(tmp_string);
79 else if(argc > index) // no, it's two tokens? # 1
81 tmp_number = stof(argv(index));
87 else // maybe it's ONLY a number?
89 tmp_number = stof(argv(index));
93 if(VerifyClientNumber(tmp_number))
95 selection = edict_num(tmp_number); // yes, it was a number
97 else // no, maybe it's a name?
99 FOR_EACH_CLIENT(tmp_player)
100 if (strdecolorize(tmp_player.netname) == strdecolorize(argv(start_index)))
101 selection = tmp_player;
103 index = (start_index + 1);
108 //print(strcat("start_index: ", ftos(start_index), ", next_token: ", ftos(next_token), ", edict: ", ftos(num_for_edict(selection)), ".\n"));
112 // find a player which matches the input string, and return their entity
113 entity GetFilteredEntity(string input)
115 entity tmp_player, selection;
118 if(substring(input, 0, 1) == "#")
119 tmp_number = stof(substring(input, 1, -1));
121 tmp_number = stof(input);
123 if(VerifyClientNumber(tmp_number))
125 selection = edict_num(tmp_number);
130 FOR_EACH_CLIENT(tmp_player)
131 if (strdecolorize(tmp_player.netname) == strdecolorize(input))
132 selection = tmp_player;
138 // same thing, but instead return their edict number
139 float GetFilteredNumber(string input)
141 entity selection = GetFilteredEntity(input);
144 output = num_for_edict(selection);
149 // switch between sprint and print depending on whether the receiver is the server or a player
150 void print_to(entity to, string input)
153 sprint(to, strcat(input, "\n"));
158 // ==========================================
159 // Supporting functions for common commands
160 // ==========================================
162 // used by CommonCommand_timeout() and CommonCommand_timein() to handle game pausing and messaging and such.
163 void timeout_handler_reset()
165 timeout_caller = world;
167 timeout_leadtime = 0;
172 void timeout_handler_think()
176 switch(timeout_status)
180 if(timeout_time > 0) // countdown is still going
182 Send_Notification(NOTIF_ALL, world, MSG_CENTER, CENTER_TIMEOUT_ENDING, timeout_time);
184 if(timeout_time == autocvar_sv_timeout_resumetime) // play a warning sound when only <sv_timeout_resumetime> seconds are left
185 Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_PREPARE);
187 self.nextthink = time + TIMEOUT_SLOWMO_VALUE; // think again in one second
188 timeout_time -= 1; // decrease the time counter
190 else // time to end the timeout
192 timeout_status = TIMEOUT_INACTIVE;
194 // reset the slowmo value back to normal
195 cvar_set("slowmo", ftos(orig_slowmo));
197 // unlock the view for players so they can move around again
198 FOR_EACH_REALPLAYER(tmp_player)
199 tmp_player.fixangle = FALSE;
201 timeout_handler_reset();
207 case TIMEOUT_LEADTIME:
209 if(timeout_leadtime > 0) // countdown is still going
211 Send_Notification(NOTIF_ALL, world, MSG_CENTER, CENTER_TIMEOUT_BEGINNING, timeout_leadtime);
213 self.nextthink = time + 1; // think again in one second
214 timeout_leadtime -= 1; // decrease the time counter
216 else // time to begin the timeout
218 timeout_status = TIMEOUT_ACTIVE;
220 // set the slowmo value to the timeout default slowmo value
221 cvar_set("slowmo", ftos(TIMEOUT_SLOWMO_VALUE));
223 // reset all the flood variables
224 FOR_EACH_CLIENT(tmp_player)
225 tmp_player.nickspamcount = tmp_player.nickspamtime = tmp_player.floodcontrol_chat =
226 tmp_player.floodcontrol_chatteam = tmp_player.floodcontrol_chattell =
227 tmp_player.floodcontrol_voice = tmp_player.floodcontrol_voiceteam = 0;
229 // copy .v_angle to .lastV_angle for every player in order to fix their view during pause (see PlayerPreThink)
230 FOR_EACH_REALPLAYER(tmp_player)
231 tmp_player.lastV_angle = tmp_player.v_angle;
233 self.nextthink = time; // think again next frame to handle it under TIMEOUT_ACTIVE code
240 case TIMEOUT_INACTIVE:
243 timeout_handler_reset();
251 // ===================================================
252 // Common commands used in both sv_cmd.qc and cmd.qc
253 // ===================================================
255 void CommonCommand_cvar_changes(float request, entity caller)
259 case CMD_REQUEST_COMMAND:
261 print_to(caller, cvar_changes);
262 return; // never fall through to usage
266 case CMD_REQUEST_USAGE:
268 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_changes"));
269 print_to(caller, " No arguments required.");
270 print_to(caller, "See also: ^2cvar_purechanges^7");
276 void CommonCommand_cvar_purechanges(float request, entity caller)
280 case CMD_REQUEST_COMMAND:
282 print_to(caller, cvar_purechanges);
283 return; // never fall through to usage
287 case CMD_REQUEST_USAGE:
289 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_purechanges"));
290 print_to(caller, " No arguments required.");
291 print_to(caller, "See also: ^2cvar_changes^7");
297 void CommonCommand_info(float request, entity caller, float argc)
301 case CMD_REQUEST_COMMAND:
303 string command = builtin_cvar_string(strcat("sv_info_", argv(1)));
306 wordwrap_sprint(command, 1000);
308 print_to(caller, "ERROR: unsupported info command");
310 return; // never fall through to usage
314 case CMD_REQUEST_USAGE:
316 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " info request"));
317 print_to(caller, " Where 'request' is the suffixed string appended onto the request for cvar.");
323 void CommonCommand_ladder(float request, entity caller)
327 case CMD_REQUEST_COMMAND:
329 print_to(caller, ladder_reply);
330 return; // never fall through to usage
334 case CMD_REQUEST_USAGE:
336 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " ladder"));
337 print_to(caller, " No arguments required.");
343 void CommonCommand_lsmaps(float request, entity caller)
347 case CMD_REQUEST_COMMAND:
349 print_to(caller, lsmaps_reply);
350 return; // never fall through to usage
354 case CMD_REQUEST_USAGE:
356 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " lsmaps"));
357 print_to(caller, " No arguments required.");
363 void CommonCommand_printmaplist(float request, entity caller)
367 case CMD_REQUEST_COMMAND:
369 print_to(caller, maplist_reply);
370 return; // never fall through to usage
374 case CMD_REQUEST_USAGE:
376 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " printmaplist"));
377 print_to(caller, " No arguments required.");
383 void CommonCommand_rankings(float request, entity caller)
387 case CMD_REQUEST_COMMAND:
389 print_to(caller, rankings_reply);
390 return; // never fall through to usage
394 case CMD_REQUEST_USAGE:
396 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " rankings"));
397 print_to(caller, " No arguments required.");
403 void CommonCommand_records(float request, entity caller)
407 case CMD_REQUEST_COMMAND:
411 for(i = 0; i < 10; ++i)
412 if(records_reply[i] != "")
413 print_to(caller, records_reply[i]);
415 return; // never fall through to usage
419 case CMD_REQUEST_USAGE:
421 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " records"));
422 print_to(caller, " No arguments required.");
428 void CommonCommand_teamstatus(float request, entity caller)
432 case CMD_REQUEST_COMMAND:
434 Score_NicePrint(caller);
435 return; // never fall through to usage
439 case CMD_REQUEST_USAGE:
441 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " teamstatus"));
442 print_to(caller, " No arguments required.");
448 void CommonCommand_time(float request, entity caller)
452 case CMD_REQUEST_COMMAND:
454 print_to(caller, strcat("time = ", ftos(time)));
455 print_to(caller, strcat("frame start = ", ftos(gettime(GETTIME_FRAMESTART))));
456 print_to(caller, strcat("realtime = ", ftos(gettime(GETTIME_REALTIME))));
457 print_to(caller, strcat("hires = ", ftos(gettime(GETTIME_HIRES))));
458 print_to(caller, strcat("uptime = ", ftos(gettime(GETTIME_UPTIME))));
459 print_to(caller, strcat("localtime = ", strftime(TRUE, "%a %b %e %H:%M:%S %Z %Y")));
460 print_to(caller, strcat("gmtime = ", strftime(FALSE, "%a %b %e %H:%M:%S %Z %Y")));
465 case CMD_REQUEST_USAGE:
467 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " time"));
468 print_to(caller, " No arguments required.");
474 void CommonCommand_timein(float request, entity caller)
478 case CMD_REQUEST_COMMAND:
480 if(!caller || autocvar_sv_timeout)
482 if (!timeout_status) { print_to(caller, "^7Error: There is no active timeout called."); }
483 else if(caller && (caller != timeout_caller)) { print_to(caller, "^7Error: You are not allowed to stop the active timeout."); }
485 else // everything should be okay, continue aborting timeout
487 switch(timeout_status)
489 case TIMEOUT_LEADTIME:
491 timeout_status = TIMEOUT_INACTIVE;
493 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
494 bprint(strcat("^7The timeout was aborted by ", GetCallerName(caller), " !\n"));
500 timeout_time = autocvar_sv_timeout_resumetime;
501 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
502 bprint(strcat("^1Attention: ^7", GetCallerName(caller), " resumed the game! Prepare for battle!\n"));
506 default: dprint("timeout status was inactive, but this code was executed anyway?"); return;
510 else { print_to(caller, "^1Timeins are not allowed to be called, enable them with sv_timeout 1.\n"); }
512 return; // never fall through to usage
516 case CMD_REQUEST_USAGE:
518 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timein"));
519 print_to(caller, " No arguments required.");
525 void CommonCommand_timeout(float request, entity caller) // DEAR GOD THIS COMMAND IS TERRIBLE.
529 case CMD_REQUEST_COMMAND:
531 if(!caller || autocvar_sv_timeout)
533 float last_possible_timeout = ((autocvar_timelimit * 60) - autocvar_sv_timeout_leadtime - 1);
535 if(timeout_status) { print_to(caller, "^7Error: A timeout is already active."); }
536 else if(vote_called) { print_to(caller, "^7Error: You can not call a timeout while a vote is active."); }
537 else if(warmup_stage && !g_warmup_allow_timeout) { print_to(caller, "^7Error: You can not call a timeout in warmup-stage."); }
538 else if(time < game_starttime) { print_to(caller, "^7Error: You can not call a timeout while the map is being restarted."); }
539 else if(caller && (caller.allowed_timeouts < 1)) { print_to(caller, "^7Error: You already used all your timeout calls for this map."); }
540 else if(caller && !IS_PLAYER(caller)) { print_to(caller, "^7Error: You must be a player to call a timeout."); }
541 else if((autocvar_timelimit) && (last_possible_timeout < time - game_starttime)) { print_to(caller, "^7Error: It is too late to call a timeout now!"); }
543 else // everything should be okay, proceed with starting the timeout
545 if(caller) { caller.allowed_timeouts -= 1; }
547 bprint(GetCallerName(caller), " ^7called a timeout", (caller ? strcat(" (", ftos(caller.allowed_timeouts), " timeout(s) left)") : ""), "!\n"); // write a bprint who started the timeout (and how many they have left)
549 timeout_status = TIMEOUT_LEADTIME;
550 timeout_caller = caller;
551 timeout_time = autocvar_sv_timeout_length;
552 timeout_leadtime = autocvar_sv_timeout_leadtime;
554 timeout_handler = spawn();
555 timeout_handler.think = timeout_handler_think;
556 timeout_handler.nextthink = time; // always let the entity think asap
558 Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_TIMEOUT);
561 else { print_to(caller, "^1Timeouts are not allowed to be called, enable them with sv_timeout 1.\n"); }
563 return; // never fall through to usage
567 case CMD_REQUEST_USAGE:
569 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timeout"));
570 print_to(caller, " No arguments required.");
576 void CommonCommand_who(float request, entity caller, float argc)
580 case CMD_REQUEST_COMMAND:
582 float total_listed_players, is_bot;
585 float privacy = (caller && autocvar_sv_status_privacy);
586 string separator = strreplace("%", " ", strcat((argv(1) ? argv(1) : " "), "^7"));
587 string tmp_netaddress, tmp_crypto_idfp;
589 print_to(caller, strcat("List of client information", (privacy ? " (some data is hidden for privacy)" : ""), ":"));
590 print_to(caller, sprintf(strreplace(" ", separator, " %-4s %-20s %-5s %-3s %-9s %-16s %s "),
591 "ent", "nickname", "ping", "pl", "time", "ip", "crypto_id"));
593 total_listed_players = 0;
594 FOR_EACH_CLIENT(tmp_player)
596 is_bot = (IS_BOT_CLIENT(tmp_player));
600 tmp_netaddress = "null/botclient";
601 tmp_crypto_idfp = "null/botclient";
605 tmp_netaddress = "hidden";
606 tmp_crypto_idfp = "hidden";
610 tmp_netaddress = tmp_player.netaddress;
611 tmp_crypto_idfp = tmp_player.crypto_idfp;
614 print_to(caller, sprintf(strreplace(" ", separator, " #%-3d %-20.20s %-5d %-3d %-9s %-16s %s "),
615 num_for_edict(tmp_player),
618 tmp_player.ping_packetloss,
619 process_time(1, time - tmp_player.jointime),
623 ++total_listed_players;
626 print_to(caller, strcat("Finished listing ", ftos(total_listed_players), " client(s) out of ", ftos(maxclients), " slots."));
628 return; // never fall through to usage
632 case CMD_REQUEST_USAGE:
634 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " who [separator]"));
635 print_to(caller, " Where 'separator' is the optional string to separate the values with, default is a space.");
641 /* use this when creating a new command, making sure to place it in alphabetical order... also,
642 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
643 void CommonCommand_(float request, entity caller)
647 case CMD_REQUEST_COMMAND:
650 return; // never fall through to usage
654 case CMD_REQUEST_USAGE:
656 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " "));
657 print_to(caller, " No arguments required.");
665 // ==================================
666 // Macro system for common commands
667 // ==================================
669 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
670 #define COMMON_COMMANDS(request,caller,arguments,command) \
671 COMMON_COMMAND("cvar_changes", CommonCommand_cvar_changes(request, caller), "Prints a list of all changed server cvars") \
672 COMMON_COMMAND("cvar_purechanges", CommonCommand_cvar_purechanges(request, caller), "Prints a list of all changed gameplay cvars") \
673 COMMON_COMMAND("info", CommonCommand_info(request, caller, arguments), "Request for unique server information set up by admin") \
674 COMMON_COMMAND("ladder", CommonCommand_ladder(request, caller), "Get information about top players if supported") \
675 COMMON_COMMAND("lsmaps", CommonCommand_lsmaps(request, caller), "List maps which can be used with the current game mode") \
676 COMMON_COMMAND("printmaplist", CommonCommand_printmaplist(request, caller), "Display full server maplist reply") \
677 COMMON_COMMAND("rankings", CommonCommand_rankings(request, caller), "Print information about rankings") \
678 COMMON_COMMAND("records", CommonCommand_records(request, caller), "List top 10 records for the current map") \
679 COMMON_COMMAND("teamstatus", CommonCommand_teamstatus(request, caller), "Show information about player and team scores") \
680 COMMON_COMMAND("time", CommonCommand_time(request, caller), "Print different formats/readouts of time") \
681 COMMON_COMMAND("timein", CommonCommand_timein(request, caller), "Resume the game from being paused with a timeout") \
682 COMMON_COMMAND("timeout", CommonCommand_timeout(request, caller), "Call a timeout which pauses the game for certain amount of time unless unpaused") \
683 COMMON_COMMAND("vote", VoteCommand(request, caller, arguments, command), "Request an action to be voted upon by players") \
684 COMMON_COMMAND("who", CommonCommand_who(request, caller, arguments), "Display detailed client information about all players") \
687 void CommonCommand_macro_help(entity caller)
689 #define COMMON_COMMAND(name,function,description) \
690 { print_to(caller, strcat(" ^2", name, "^7: ", description)); }
692 COMMON_COMMANDS(0, caller, 0, "")
693 #undef COMMON_COMMAND
698 float CommonCommand_macro_command(float argc, entity caller, string command)
700 #define COMMON_COMMAND(name,function,description) \
701 { if(name == strtolower(argv(0))) { function; return TRUE; } }
703 COMMON_COMMANDS(CMD_REQUEST_COMMAND, caller, argc, command)
704 #undef COMMON_COMMAND
709 float CommonCommand_macro_usage(float argc, entity caller)
711 #define COMMON_COMMAND(name,function,description) \
712 { if(name == strtolower(argv(1))) { function; return TRUE; } }
714 COMMON_COMMANDS(CMD_REQUEST_USAGE, caller, argc, "")
715 #undef COMMON_COMMAND
720 void CommonCommand_macro_write_aliases(float fh)
722 #define COMMON_COMMAND(name,function,description) \
723 { CMD_Write_Alias("qc_cmd_svcmd", name, description); }
725 COMMON_COMMANDS(0, world, 0, "")
726 #undef COMMON_COMMAND