// ====================================================
// Shared code for server commands, written by Samual
-// Last updated: December 19th, 2011
+// Last updated: December 27th, 2011
// ====================================================
// select the proper prefix for usage and other messages
if(selection) { output = num_for_edict(selection); }
- print(strcat("input: ", input, ", output: ", ftos(output), ",\n")); // todo remove after done debugging
return output;
}
print(input, "\n");
}
+// ==========================================
+// Supporting functions for common commands
+// ==========================================
+
+// used by CommonCommand_timeout() and CommonCommand_timein() to handle game pausing and messaging and such.
+void timeout_handler_reset()
+{
+ entity tmp_player;
+
+ timeout_caller = world;
+ timeout_time = 0;
+ timeout_leadtime = 0;
+
+ FOR_EACH_REALPLAYER(tmp_player)
+ Send_CSQC_Centerprint_Generic_Expire(tmp_player, CPID_TIMEOUT_COUNTDOWN);
+
+ remove(self);
+}
+
+void timeout_handler_think()
+{
+ entity tmp_player;
+
+ switch(timeout_status)
+ {
+ case TIMEOUT_ACTIVE:
+ {
+ if(timeout_time > 0) // countdown is still going
+ {
+ FOR_EACH_REALPLAYER(tmp_player)
+ Send_CSQC_Centerprint_Generic(tmp_player, CPID_TIMEOUT_COUNTDOWN, "Timeout ends in %d seconds!", 1, timeout_time);
+
+ if(timeout_time == autocvar_sv_timeout_resumetime) // play a warning sound when only <sv_timeout_resumetime> seconds are left
+ Announce("prepareforbattle");
+
+ self.nextthink = time + TIMEOUT_SLOWMO_VALUE; // think again in one second
+ timeout_time -= 1; // decrease the time counter
+ }
+ else // time to end the timeout
+ {
+ timeout_status = TIMEOUT_INACTIVE;
+
+ // reset the slowmo value back to normal
+ cvar_set("slowmo", ftos(orig_slowmo));
+
+ // unlock the view for players so they can move around again
+ FOR_EACH_REALPLAYER(tmp_player)
+ tmp_player.fixangle = FALSE;
+
+ timeout_handler_reset();
+ }
+
+ return;
+ }
+
+ case TIMEOUT_LEADTIME:
+ {
+ if (timeout_leadtime > 0) // countdown is still going
+ {
+ // centerprint the information to every player
+ FOR_EACH_REALPLAYER(tmp_player)
+ Send_CSQC_Centerprint_Generic(tmp_player, CPID_TIMEOUT_COUNTDOWN, "Timeout begins in %d seconds!", 1, timeout_leadtime);
+
+ self.nextthink = time + 1; // think again in one second
+ timeout_leadtime -= 1; // decrease the time counter
+ }
+ else // time to begin the timeout
+ {
+ timeout_status = TIMEOUT_ACTIVE;
+
+ // set the slowmo value to the timeout default slowmo value
+ cvar_set("slowmo", ftos(TIMEOUT_SLOWMO_VALUE));
+
+ // reset all the flood variables
+ FOR_EACH_CLIENT(tmp_player)
+ tmp_player.nickspamcount = tmp_player.nickspamtime = tmp_player.floodcontrol_chat =
+ tmp_player.floodcontrol_chatteam = tmp_player.floodcontrol_chattell =
+ tmp_player.floodcontrol_voice = tmp_player.floodcontrol_voiceteam = 0;
+
+ // copy .v_angle to .lastV_angle for every player in order to fix their view during pause (see PlayerPreThink)
+ FOR_EACH_REALPLAYER(tmp_player)
+ tmp_player.lastV_angle = tmp_player.v_angle;
+
+ self.nextthink = time; // think again next frame to handle it under TIMEOUT_ACTIVE code
+ }
+
+ return;
+ }
+
+
+ case TIMEOUT_INACTIVE:
+ default:
+ {
+ timeout_handler_reset();
+ return;
+ }
+ }
+}
+
+
// ===================================================
// Common commands used in both sv_cmd.qc and cmd.qc
}
}
-void CommonCommand_info(float request, entity caller, float argc) // todo: figure out how this works?
+void CommonCommand_info(float request, entity caller, float argc) // legacy
{
switch(request)
{
case CMD_REQUEST_COMMAND:
{
- string command;
+ string command = builtin_cvar_string(strcat("sv_info_", argv(1)));
- command = builtin_cvar_string(strcat("sv_info_", argv(1)));
if(command)
- wordwrap_sprint(command, 1111); // why 1111?
+ wordwrap_sprint(command, 1000);
else
print_to(caller, "ERROR: unsupported info command");
}
}
+/*
void GameCommand_rankings(float request) // this is OLD.... jeez.
{
switch(request)
}
}
}
+*/
void CommonCommand_rankings(float request, entity caller)
{
}
}
-void CommonCommand_records(float request, entity caller) // TODO: Isn't this flooding with the sprint messages? Old code, but perhaps bad?
+void CommonCommand_records(float request, entity caller)
{
switch(request)
{
{
case CMD_REQUEST_COMMAND:
{
- print_to(caller, strcat("time = ", ftos(time), "\n"));
- print_to(caller, strcat("frame start = ", ftos(gettime(GETTIME_FRAMESTART)), "\n"));
- print_to(caller, strcat("realtime = ", ftos(gettime(GETTIME_REALTIME)), "\n"));
- print_to(caller, strcat("hires = ", ftos(gettime(GETTIME_HIRES)), "\n"));
- print_to(caller, strcat("uptime = ", ftos(gettime(GETTIME_UPTIME)), "\n"));
- print_to(caller, strcat("localtime = ", strftime(TRUE, "%a %b %e %H:%M:%S %Z %Y"), "\n")); // todo: Why is strftime broken? is engine problem, I think.
- print_to(caller, strcat("gmtime = ", strftime(FALSE, "%a %b %e %H:%M:%S %Z %Y"), "\n"));
+ print_to(caller, strcat("time = ", ftos(time)));
+ print_to(caller, strcat("frame start = ", ftos(gettime(GETTIME_FRAMESTART))));
+ print_to(caller, strcat("realtime = ", ftos(gettime(GETTIME_REALTIME))));
+ print_to(caller, strcat("hires = ", ftos(gettime(GETTIME_HIRES))));
+ print_to(caller, strcat("uptime = ", ftos(gettime(GETTIME_UPTIME))));
+ print_to(caller, strcat("localtime = ", strftime(TRUE, "%a %b %e %H:%M:%S %Z %Y")));
+ print_to(caller, strcat("gmtime = ", strftime(FALSE, "%a %b %e %H:%M:%S %Z %Y")));
return;
}
}
}
-void CommonCommand_timein(float request, entity caller) // todo entirely re-write this
+void CommonCommand_timein(float request, entity caller)
{
switch(request)
{
case CMD_REQUEST_COMMAND:
{
- if(caller.flags & FL_CLIENT)
+ if(autocvar_sv_timeout)
{
- if(autocvar_sv_timeout)
+ if not(timeout_status) { print_to(caller, "^7Error: There is no active timeout called."); }
+ else if(caller && (caller != timeout_caller)) { print_to(caller, "^7Error: You are not allowed to stop the active timeout."); }
+
+ else // everything should be okay, continue aborting timeout
{
- if (!timeoutStatus)
- return print_to(caller, "^7Error: There is no active timeout which could be aborted!");
- if (caller != timeoutInitiator)
- return print_to(caller, "^7Error: You may not abort the active timeout. Only the player who called it can do that!");
-
- if (timeoutStatus == 1)
- {
- remainingTimeoutTime = timeoutStatus = 0;
- timeoutHandler.nextthink = time; //timeoutHandler has to take care of it immediately
- bprint(strcat("^7The timeout was aborted by ", caller.netname, " !\n"));
- }
- else if (timeoutStatus == 2)
+ switch(timeout_status)
{
- //only shorten the remainingTimeoutTime if it makes sense
- if( remainingTimeoutTime > (autocvar_sv_timeout_resumetime + 1) )
+ case TIMEOUT_LEADTIME:
{
+ timeout_status = TIMEOUT_INACTIVE;
+ timeout_time = 0;
+ timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
+ bprint(strcat("^7The timeout was aborted by ", caller.netname, " !\n"));
+ return;
+ }
+
+ case TIMEOUT_ACTIVE:
+ {
+ timeout_time = autocvar_sv_timeout_resumetime;
+ timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
bprint(strcat("^1Attention: ^7", caller.netname, " resumed the game! Prepare for battle!\n"));
- remainingTimeoutTime = autocvar_sv_timeout_resumetime;
- timeoutHandler.nextthink = time; //timeoutHandler has to take care of it immediately
+ return;
}
- else
- print_to(caller, "^7Error: Your resumegame call was discarded!");
+
+ default: dprint("timeout status was inactive, but this code was executed anyway?"); return;
}
}
}
{
case CMD_REQUEST_COMMAND:
{
- if(caller.flags & FL_CLIENT)
+ if(autocvar_sv_timeout)
{
- if(autocvar_sv_timeout)
- {
- if(caller.classname == "player")
- {
- if(vote_called)
- print_to(caller, "^7Error: you can not call a timeout while a vote is active!");
- else
- {
- if (inWarmupStage && !g_warmup_allow_timeout)
- return print_to(caller, "^7Error: You can not call a timeout in warmup-stage!");
- if (time < game_starttime )
- return print_to(caller, "^7Error: You can not call a timeout while the map is being restarted!");
-
- if (timeoutStatus != 2) {
- //if the map uses a timelimit make sure that timeout cannot be called right before the map ends
- if (autocvar_timelimit) {
- //a timelimit was used
- float myTl;
- myTl = autocvar_timelimit;
-
- float lastPossibleTimeout;
- lastPossibleTimeout = (myTl*60) - autocvar_sv_timeout_leadtime - 1;
-
- if (lastPossibleTimeout < time - game_starttime)
- return print_to(caller, "^7Error: It is too late to call a timeout now!");
- }
- }
-
- //player may not call a timeout if he has no calls left
- if (caller.allowedTimeouts < 1)
- return print_to(caller, "^7Error: You already used all your timeout calls for this map!");
-
-
- //now all required checks are passed
- caller.allowedTimeouts -= 1;
- bprint(caller.netname, " ^7called a timeout (", ftos(caller.allowedTimeouts), " timeouts left)!\n"); //write a bprint who started the timeout (and how many he has left)
- remainingTimeoutTime = autocvar_sv_timeout_length;
- remainingLeadTime = autocvar_sv_timeout_leadtime;
- timeoutInitiator = caller;
- if (timeoutStatus == 0) { //if another timeout was already active, don't change its status (which was 1 or 2) to 1, only change it to 1 if no timeout was active yet
- timeoutStatus = 1;
- //create the timeout indicator which centerprints the information to all players and takes care of pausing/unpausing
- timeoutHandler = spawn();
- timeoutHandler.think = timeoutHandler_Think;
- }
- timeoutHandler.nextthink = time; //always let the entity think asap
-
- //inform all connected clients about the timeout call
- Announce("timeoutcalled");
- }
- }
- else
- print_to(caller, "^7Error: only players can call a timeout!");
+ float last_possible_timeout = ((autocvar_timelimit * 60) - autocvar_sv_timeout_leadtime - 1);
+
+ if(timeout_status) { print_to(caller, "^7Error: A timeout is already active."); }
+ else if(vote_called) { print_to(caller, "^7Error: You can not call a timeout while a vote is active."); }
+ else if(inWarmupStage && !g_warmup_allow_timeout) { print_to(caller, "^7Error: You can not call a timeout in warmup-stage."); }
+ else if(time < game_starttime) { print_to(caller, "^7Error: You can not call a timeout while the map is being restarted."); }
+ else if(caller && (caller.allowed_timeouts < 1)) { print_to(caller, "^7Error: You already used all your timeout calls for this map."); }
+ else if(caller && (caller.classname != "player")) { print_to(caller, "^7Error: You must be a player to call a timeout."); }
+ else if((autocvar_timelimit) && (last_possible_timeout < time - game_starttime)) { print_to(caller, "^7Error: It is too late to call a timeout now!"); }
+
+ else // everything should be okay, proceed with starting the timeout
+ {
+ if(caller) { caller.allowed_timeouts -= 1; }
+
+ 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)
+
+ timeout_status = TIMEOUT_LEADTIME;
+ timeout_caller = caller;
+ timeout_time = autocvar_sv_timeout_length;
+ timeout_leadtime = autocvar_sv_timeout_leadtime;
+
+ timeout_handler = spawn();
+ timeout_handler.think = timeout_handler_think;
+ timeout_handler.nextthink = time; // always let the entity think asap
+
+ Announce("timeoutcalled");
}
}
return; // never fall through to usage
case CMD_REQUEST_COMMAND:
{
float total_listed_players, tmp_hours, tmp_minutes, tmp_seconds, is_bot;
- entity tmp_player;
+ entity tmp_player;
- string separator = strcat((argv(1) ? argv(1) : " "), "^7");
float privacy = (caller && autocvar_sv_status_privacy);
+ string separator = strreplace("%", " ", strcat((argv(1) ? argv(1) : " "), "^7"));
+ string tmp_netaddress, tmp_crypto_idfp;
print_to(caller, strcat("List of client information", (privacy ? " (some data is hidden for privacy)" : string_null), ":"));
print_to(caller, sprintf(strreplace(" ", separator, " %-4s %-20s %-5s %-3s %-9s %-16s %s "),
{
is_bot = (clienttype(tmp_player) == CLIENTTYPE_BOT);
+ if(is_bot)
+ {
+ tmp_netaddress = "null/botclient";
+ tmp_crypto_idfp = "null/botclient";
+ }
+ else if(privacy)
+ {
+ tmp_netaddress = "hidden";
+ tmp_crypto_idfp = "hidden";
+ }
+ else
+ {
+ tmp_netaddress = tmp_player.netaddress;
+ tmp_crypto_idfp = tmp_player.crypto_idfp;
+ }
+
tmp_hours = tmp_minutes = tmp_seconds = 0;
tmp_seconds = floor(time - tmp_player.jointime);
if(tmp_minutes) { tmp_seconds -= (tmp_minutes * 60); }
if(tmp_hours) { tmp_minutes -= (tmp_hours * 60); }
- print_to(caller, sprintf(strreplace(" ", separator, " %-4s %-20.20s %-5d %-3d %-9s %-16s %s "),
- strcat("#", ftos(num_for_edict(tmp_player))),
+ print_to(caller, sprintf(strreplace(" ", separator, " #%-3d %-20.20s %-5d %-3d %-9s %-16s %s "),
+ num_for_edict(tmp_player),
tmp_player.netname,
tmp_player.ping,
tmp_player.ping_packetloss,
sprintf("%02d:%02d:%02d", tmp_hours, tmp_minutes, tmp_seconds),
- (is_bot ? "null/botclient" : (privacy ? "hidden" : tmp_player.netaddress)),
- (is_bot ? "null/botclient" : (privacy ? "hidden" : tmp_player.crypto_idfp))));
-
+ tmp_netaddress,
+ tmp_crypto_idfp));
+
++total_listed_players;
}
}
}
-/* use this when creating a new command, making sure to place it in alphabetical order.
+/* use this when creating a new command, making sure to place it in alphabetical order... also,
+** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
void CommonCommand_(float request, entity caller)
{
switch(request)
}
}
}
-*/
\ No newline at end of file
+*/
+
+
+// ==================================
+// Macro system for common commands
+// ==================================
+
+// Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
+#define COMMON_COMMANDS(request,arguments,command) \
+ COMMON_COMMAND("cvar_changes", CommonCommand_cvar_changes(request, world), "Prints a list of all changed server cvars") \
+ COMMON_COMMAND("cvar_purechanges", CommonCommand_cvar_purechanges(request, world), "Prints a list of all changed gameplay cvars") \
+ COMMON_COMMAND("info", CommonCommand_info(request, world, arguments), "Request for unique server information set up by admin") \
+ COMMON_COMMAND("ladder", CommonCommand_ladder(request, world), "Get information about top players if supported") \
+ COMMON_COMMAND("lsmaps", CommonCommand_lsmaps(request, world), "List maps which can be used with the current game mode") \
+ COMMON_COMMAND("lsnewmaps", CommonCommand_lsnewmaps(request, world), "List maps which have no records or are seemingly unplayed yet") \
+ COMMON_COMMAND("maplist", CommonCommand_maplist(request, world), "Display full server maplist reply") \
+ COMMON_COMMAND("rankings", CommonCommand_rankings(request, world), "Print information about rankings") \
+ COMMON_COMMAND("records", CommonCommand_records(request, world), "List top 10 records for the current map") \
+ COMMON_COMMAND("teamstatus", CommonCommand_teamstatus(request, world), "Show information about player and team scores") \
+ COMMON_COMMAND("time", CommonCommand_time(request, world), "Print different formats/readouts of time") \
+ COMMON_COMMAND("timein", CommonCommand_timein(request, world), "Resume the game from being paused with a timeout") \
+ COMMON_COMMAND("timeout", CommonCommand_timeout(request, world), "Call a timeout which pauses the game for certain amount of time unless unpaused") \
+ COMMON_COMMAND("vote", VoteCommand(request, world, arguments, command), "Request an action to be voted upon by players") \
+ COMMON_COMMAND("who", CommonCommand_who(request, world, arguments), "Display detailed client information about all players") \
+ /* nothing */
+
+void CommonCommand_macro_help()
+{
+ #define COMMON_COMMAND(name,function,description) \
+ { print(" ^2", name, "^7: ", description, "\n"); }
+
+ COMMON_COMMANDS(0, 0, "")
+ #undef COMMON_COMMAND
+
+ return;
+}
+
+float CommonCommand_macro_command(float argc, string command)
+{
+ #define COMMON_COMMAND(name,function,description) \
+ { if(name == strtolower(argv(0))) { function; return TRUE; } }
+
+ COMMON_COMMANDS(CMD_REQUEST_COMMAND, argc, command)
+ #undef COMMON_COMMAND
+
+ return FALSE;
+}
+
+float CommonCommand_macro_usage(float argc)
+{
+ #define COMMON_COMMAND(name,function,description) \
+ { if(name == strtolower(argv(1))) { function; return TRUE; } }
+
+ COMMON_COMMANDS(CMD_REQUEST_USAGE, argc, "")
+ #undef COMMON_COMMAND
+
+ return FALSE;
+}