qcsrc/server/command/common.qh

   1 #ifndef COMMAND_COMMON_H
   2 #define COMMAND_COMMON_H
   3
   4 #include "vote.qh"
   5
   6 #include "../../common/command/generic.qh"
   7 #include "../../common/command/shared_defs.qh"
   8
   9 // ============================================================
  10 //  Shared declarations for server commands, written by Samual
  11 //  Last updated: December 30th, 2011
  12 // ============================================================
  13
  14 // client verification results
  15 const float CLIENT_ACCEPTABLE = 1;
  16 const float CLIENT_DOESNT_EXIST = -1;
  17 const float CLIENT_NOT_REAL = -2;
  18 const float CLIENT_NOT_BOT = -3;
  19
  20 // definitions for timeouts
  21 const float TIMEOUT_INACTIVE = 0;
  22 const float TIMEOUT_LEADTIME = 1;
  23 const float TIMEOUT_ACTIVE = 2;
  24
  25 // timeout which pauses the game by setting the slowmo value extremely low.
  26 const float TIMEOUT_SLOWMO_VALUE = 0.0001;
  27
  28 // global timeout information declarations
  29 entity timeout_caller; // contains the entity of the player who started the last timeout
  30 entity timeout_handler; // responsible for centerprinting the timeout countdowns and playing sounds
  31 float sys_frametime; // gets initialised in worldspawn, saves the value from autocvar_sys_ticrate
  32 float orig_slowmo; // contains the value of autocvar_slowmo so that, after timeout finished, it isn't set to slowmo 1 necessarily
  33 float timeout_time; // contains the time in seconds that the active timeout has left
  34 float timeout_leadtime; // contains the number of seconds left of the leadtime (before the timeout starts)
  35 float timeout_status; // (values: 0, 1, 2) contains whether a timeout is not active (0), was called but still at leadtime (1) or is active (2)
  36 .float allowed_timeouts; // contains the number of allowed timeouts for each player
  37 .vector lastV_angle; //used when pausing the game in order to force the player to keep his old view angle fixed
  38
  39 // allow functions to be used in other code like g_world.qc and teamplay.qc
  40 void timeout_handler_think();
  41
  42 // used by common/command/generic.qc:GenericCommand_dumpcommands to list all commands into a .txt file
  43 void CommonCommand_macro_write_aliases(float fh);
  44
  45 // keep track of the next token to use for argc
  46 float next_token;
  47
  48 // select the proper prefix for usage and other messages
  49 string GetCommandPrefix(entity caller);
  50
  51 // if client return player nickname, or if server return admin nickname
  52 string GetCallerName(entity caller);
  53
  54 // verify that the client provided is acceptable for kicking
  55 float VerifyKickableEntity(entity client);
  56
  57 // verify that the client provided is acceptable for use
  58 float VerifyClientEntity(entity client, float must_be_real, float must_be_bots);
  59
  60 // if the client is not acceptable, return a string to be used for error messages
  61 string GetClientErrorString(float clienterror, string original_input);
  62
  63 // is this entity number even in the possible range of entities?
  64 float VerifyClientNumber(float tmp_number);
  65
  66 entity GetIndexedEntity(float argc, float start_index);
  67
  68 // find a player which matches the input string, and return their entity
  69 entity GetFilteredEntity(string input);
  70
  71 // same thing, but instead return their edict number
  72 float GetFilteredNumber(string input);
  73
  74 // switch between sprint and print depending on whether the receiver is the server or a player
  75 void print_to(entity to, string input);
  76
  77 // ==========================================
  78 //  Supporting functions for common commands
  79 // ==========================================
  80
  81 // used by CommonCommand_timeout() and CommonCommand_timein() to handle game pausing and messaging and such.
  82 void timeout_handler_reset();
  83
  84 void timeout_handler_think();
  85
  86 // ===================================================
  87 //  Common commands used in both sv_cmd.qc and cmd.qc
  88 // ===================================================
  89
  90 void CommonCommand_cvar_changes(float request, entity caller);
  91
  92 void CommonCommand_cvar_purechanges(float request, entity caller);
  93
  94 void CommonCommand_info(float request, entity caller, float argc);
  95
  96 void CommonCommand_ladder(float request, entity caller);
  97
  98 void CommonCommand_lsmaps(float request, entity caller);
  99
 100 void CommonCommand_printmaplist(float request, entity caller);
 101
 102 void CommonCommand_rankings(float request, entity caller);
 103
 104 void CommonCommand_records(float request, entity caller);
 105
 106 void CommonCommand_teamstatus(float request, entity caller);
 107
 108 void CommonCommand_time(float request, entity caller);
 109
 110 void CommonCommand_timein(float request, entity caller);
 111
 112 void CommonCommand_timeout(float request, entity caller);
 113
 114 void CommonCommand_who(float request, entity caller, float argc);
 115
 116
 117 // ==================================
 118 //  Macro system for common commands
 119 // ==================================
 120
 121 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
 122 #define COMMON_COMMANDS(request,caller,arguments,command) \
 123         COMMON_COMMAND("cvar_changes", CommonCommand_cvar_changes(request, caller), "Prints a list of all changed server cvars") \
 124         COMMON_COMMAND("cvar_purechanges", CommonCommand_cvar_purechanges(request, caller), "Prints a list of all changed gameplay cvars") \
 125         COMMON_COMMAND("info", CommonCommand_info(request, caller, arguments), "Request for unique server information set up by admin") \
 126         COMMON_COMMAND("ladder", CommonCommand_ladder(request, caller), "Get information about top players if supported") \
 127         COMMON_COMMAND("lsmaps", CommonCommand_lsmaps(request, caller), "List maps which can be used with the current game mode") \
 128         COMMON_COMMAND("printmaplist", CommonCommand_printmaplist(request, caller), "Display full server maplist reply") \
 129         COMMON_COMMAND("rankings", CommonCommand_rankings(request, caller), "Print information about rankings") \
 130         COMMON_COMMAND("records", CommonCommand_records(request, caller), "List top 10 records for the current map") \
 131         COMMON_COMMAND("teamstatus", CommonCommand_teamstatus(request, caller), "Show information about player and team scores") \
 132         COMMON_COMMAND("time", CommonCommand_time(request, caller), "Print different formats/readouts of time") \
 133         COMMON_COMMAND("timein", CommonCommand_timein(request, caller), "Resume the game from being paused with a timeout") \
 134         COMMON_COMMAND("timeout", CommonCommand_timeout(request, caller), "Call a timeout which pauses the game for certain amount of time unless unpaused") \
 135         COMMON_COMMAND("vote", VoteCommand(request, caller, arguments, command), "Request an action to be voted upon by players") \
 136         COMMON_COMMAND("who", CommonCommand_who(request, caller, arguments), "Display detailed client information about all players") \
 137         /* nothing */
 138
 139 void CommonCommand_macro_help(entity caller)
 140 {
 141         #define COMMON_COMMAND(name,function,description) \
 142                 { print_to(caller, strcat("  ^2", name, "^7: ", description)); }
 143
 144         COMMON_COMMANDS(0, caller, 0, "");
 145         #undef COMMON_COMMAND
 146
 147         return;
 148 }
 149
 150 float CommonCommand_macro_command(float argc, entity caller, string command)
 151 {
 152         #define COMMON_COMMAND(name,function,description) \
 153                 { if(name == strtolower(argv(0))) { function; return true; } }
 154
 155         COMMON_COMMANDS(CMD_REQUEST_COMMAND, caller, argc, command);
 156         #undef COMMON_COMMAND
 157
 158         return false;
 159 }
 160
 161 float CommonCommand_macro_usage(float argc, entity caller)
 162 {
 163         #define COMMON_COMMAND(name,function,description) \
 164                 { if(name == strtolower(argv(1))) { function; return true; } }
 165
 166         COMMON_COMMANDS(CMD_REQUEST_USAGE, caller, argc, "");
 167         #undef COMMON_COMMAND
 168
 169         return false;
 170 }
 171
 172 void CommonCommand_macro_write_aliases(float fh)
 173 {
 174         #define COMMON_COMMAND(name,function,description) \
 175                 { CMD_Write_Alias("qc_cmd_svcmd", name, description); }
 176
 177         COMMON_COMMANDS(0, world, 0, "");
 178         #undef COMMON_COMMAND
 179
 180         return;
 181 }
 182
 183
 184 #endif