plugins/include/console.inc
author David Anderson <dvander@alliedmods.net>
Fri Feb 22 21:01:08 2008 +0000 (2008-02-22)
changeset 1889 5b4d6acc4d82
parent 1852 cfb14481b84d
child 1893 1cad3d4fd53c
permissions -rw-r--r--
deprecated LoadMaps() and its usage in three plugins
renamed basefun* to fun*
removed map file list cvars
     1 /**
     2  * vim: set ts=4 :
     3  * =============================================================================
     4  * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
     5  * =============================================================================
     6  *
     7  * This file is part of the SourceMod/SourcePawn SDK.
     8  *
     9  * This program is free software; you can redistribute it and/or modify it under
    10  * the terms of the GNU General Public License, version 3.0, as published by the
    11  * Free Software Foundation.
    12  * 
    13  * This program is distributed in the hope that it will be useful, but WITHOUT
    14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    16  * details.
    17  *
    18  * You should have received a copy of the GNU General Public License along with
    19  * this program.  If not, see <http://www.gnu.org/licenses/>.
    20  *
    21  * As a special exception, AlliedModders LLC gives you permission to link the
    22  * code of this program (as well as its derivative works) to "Half-Life 2," the
    23  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
    24  * by the Valve Corporation.  You must obey the GNU General Public License in
    25  * all respects for all other code used.  Additionally, AlliedModders LLC grants
    26  * this exception to all derivative works.  AlliedModders LLC defines further
    27  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
    28  * or <http://www.sourcemod.net/license.php>.
    29  *
    30  * Version: $Id$
    31  */
    32  
    33 #if defined _console_included
    34  #endinput
    35 #endif
    36 #define _console_included
    37 
    38 #define INVALID_FCVAR_FLAGS		(-1)
    39 
    40 /**
    41  * Console variable bound values used with Get/SetConVarBounds()
    42  */
    43 enum ConVarBounds
    44 {
    45 	ConVarBound_Upper = 0,
    46 	ConVarBound_Lower
    47 };
    48 
    49 /**
    50  * Console variable query helper values.
    51  */
    52 enum QueryCookie
    53 {
    54 	QUERYCOOKIE_FAILED = 0,
    55 };
    56 
    57 /**
    58  * Reply sources for commands.
    59  */
    60 enum ReplySource
    61 {
    62 	SM_REPLY_TO_CONSOLE = 0,
    63 	SM_REPLY_TO_CHAT = 1,
    64 };
    65 
    66 /**
    67  * Console variable query result values.
    68  */
    69 enum ConVarQueryResult
    70 {
    71 	ConVarQuery_Okay = 0,				/**< Retrieval of client convar value was successful. */
    72 	ConVarQuery_NotFound,				/**< Client convar was not found. */
    73 	ConVarQuery_NotValid,				/**< A console command with the same name was found, but there is no convar. */
    74 	ConVarQuery_Protected				/**< Client convar was found, but it is protected. The server cannot retrieve its value. */
    75 };
    76 
    77 /**
    78  * @section Flags for console commands and console variables.  The descriptions 
    79  * for each constant come directly from the Source SDK.
    80  */
    81 #define FCVAR_NONE				0		/**< The default, no flags at all */
    82 #define FCVAR_UNREGISTERED		(1<<0)	/**< If this is set, don't add to linked list, etc. */
    83 #define FCVAR_LAUNCHER			(1<<1)	/**< Defined by launcher. */
    84 #define FCVAR_GAMEDLL			(1<<2)	/**< Defined by the game DLL. */
    85 #define FCVAR_CLIENTDLL			(1<<3)	/**< Defined by the client DLL. */
    86 #define FCVAR_MATERIAL_SYSTEM	(1<<4)	/**< Defined by the material system. */
    87 #define FCVAR_PROTECTED			(1<<5)	/**< It's a server cvar, but we don't send the data since it's a password, etc. Sends 1 if it's not bland/zero, 0 otherwise as value. */
    88 #define FCVAR_SPONLY			(1<<6)	/**< This cvar cannot be changed by clients connected to a multiplayer server. */
    89 #define	FCVAR_ARCHIVE			(1<<7)	/**< Set to cause it to be saved to vars.rc */
    90 #define	FCVAR_NOTIFY			(1<<8)	/**< Notifies players when changed. */
    91 #define	FCVAR_USERINFO			(1<<9)	/**< Changes the client's info string. */
    92 #define FCVAR_PRINTABLEONLY		(1<<10)	/**< This cvar's string cannot contain unprintable characters (e.g., used for player name, etc.) */
    93 #define FCVAR_UNLOGGED			(1<<11)	/**< If this is a FCVAR_SERVER, don't log changes to the log file / console if we are creating a log */
    94 #define FCVAR_NEVER_AS_STRING	(1<<12)	/**< Never try to print that cvar. */
    95 #define FCVAR_REPLICATED		(1<<13)	/**< Server setting enforced on clients. */
    96 #define FCVAR_CHEAT				(1<<14)	/**< Only useable in singleplayer / debug / multiplayer & sv_cheats */
    97 #define FCVAR_STUDIORENDER		(1<<15)	/**< Defined by the studiorender system. */
    98 #define FCVAR_DEMO				(1<<16)	/**< Record this cvar when starting a demo file. */
    99 #define FCVAR_DONTRECORD		(1<<17)	/**< Don't record these command in demo files. */
   100 #define FCVAR_PLUGIN			(1<<18)	/**< Defined by a 3rd party plugin. */
   101 #define FCVAR_DATACACHE			(1<<19)	/**< Defined by the datacache system. */
   102 #define FCVAR_TOOLSYSTEM		(1<<20)	/**< Defined by an IToolSystem library */
   103 #define FCVAR_FILESYSTEM		(1<<21)	/**< Defined by the file system. */
   104 #define FCVAR_NOT_CONNECTED		(1<<22)	/**< Cvar cannot be changed by a client that is connected to a server. */
   105 #define FCVAR_SOUNDSYSTEM		(1<<23)	/**< Defined by the soundsystem library. */
   106 #define FCVAR_ARCHIVE_XBOX		(1<<24)	/**< Cvar written to config.cfg on the Xbox. */
   107 #define FCVAR_INPUTSYSTEM		(1<<25)	/**< Defined by the inputsystem DLL. */
   108 #define FCVAR_NETWORKSYSTEM		(1<<26)	/**< Defined by the network system. */
   109 #define FCVAR_VPHYSICS			(1<<27)	/**< Defined by vphysics. */
   110 
   111 /**
   112  * @endsection
   113  */
   114 
   115 /**
   116  * Executes a server command as if it were on the server console (or RCON)
   117  *
   118  * @param format		Formatting rules.
   119  * @param ...			Variable number of format parameters.
   120  * @noreturn
   121  */
   122 native ServerCommand(const String:format[], any:...);
   123 
   124 /**
   125  * Inserts a server command at the beginning of the server command buffer.
   126  *
   127  * @param format		Formatting rules.
   128  * @param ...			Variable number of format parameters.
   129  * @noreturn
   130  */
   131 native InsertServerCommand(const String:format[], any:...);
   132 
   133 /**
   134  * Executes every command in the server's command buffer, rather than once per frame.
   135  *
   136  * @noreturn
   137  */
   138 native ServerExecute();
   139 
   140 /**
   141  * Executes a client command.  Note that this will not work on clients unless
   142  * they have cl_restrict_server_commands set to 0.
   143  *
   144  * @param client		Index of the client.
   145  * @param fmt			Format of the client command.
   146  * @param ...			Format parameters/
   147  * @noreturn
   148  * @error				Invalid client index, or client not connected.
   149  */
   150 native ClientCommand(client, const String:fmt[], any:...);
   151 
   152 /**
   153  * Executes a client command on the server without being networked.
   154  *
   155  * FakeClientCommand() overwrites the command tokenization buffer.  This can 
   156  * cause undesired effects because future calls to GetCmdArg* will return 
   157  * data from the FakeClientCommand(), not the parent command.  If you are in 
   158  * a hook where this matters (for example, a "say" hook), you should use 
   159  * FakeClientCommandEx() instead.
   160  *
   161  * @param client		Index of the client.
   162  * @param fmt			Format of the client command.
   163  * @param ...			Format parameters
   164  * @noreturn
   165  * @error				Invalid client index, or client not connected.
   166  */
   167 native FakeClientCommand(client, const String:fmt[], any:...);
   168 
   169 /**
   170  * Executes a client command on the server without being networked.  The 
   171  * execution of the client command is delayed by one frame to prevent any 
   172  * re-entrancy issues that might surface with FakeClientCommand().
   173  *
   174  * @param client		Index of the client.
   175  * @param fmt			Format of the client command.
   176  * @param ...			Format parameters
   177  * @noreturn
   178  * @error				Invalid client index, or client not connected.
   179  */
   180 native FakeClientCommandEx(client, const String:fmt[], any:...);
   181 
   182 /**
   183  * Sends a message to the server console.
   184  *
   185  * @param format		Formatting rules.
   186  * @param ...			Variable number of format parameters.
   187  * @noreturn
   188  */
   189 native PrintToServer(const String:format[], any:...);
   190 
   191 /**
   192  * Sends a message to a client's console.
   193  *
   194  * @param client		Client index.
   195  * @param format		Formatting rules.
   196  * @param ...			Variable number of format parameters.
   197  * @noreturn
   198  * @error				If the client is not connected an error will be thrown.
   199  */
   200 native PrintToConsole(client, const String:format[], any:...);
   201 
   202 /**
   203  * Reples to a message in a command.
   204  *
   205  * A client index of 0 will use PrintToServer().
   206  * If the command was from the console, PrintToConsole() is used.
   207  * If the command was from chat, PrintToChat() is used.
   208  *
   209  * @param client		Client index, or 0 for server.
   210  * @param format		Formatting rules.
   211  * @param ...			Variable number of format parameters.
   212  * @noreturn
   213  * @error				If the client is not connected or invalid.
   214  */
   215 native ReplyToCommand(client, const String:format[], any:...);
   216 
   217 /**
   218  * Returns the current reply source of a command.
   219  *
   220  * @return				ReplySource value.
   221  */
   222 native ReplySource:GetCmdReplySource();
   223 
   224 /**
   225  * Sets the current reply source of a command.
   226  *
   227  * Only use this if you know what you are doing.  You should save the old value
   228  * and restore it once you are done.
   229  *
   230  * @param source		New ReplySource value.
   231  * @return				Old ReplySource value.
   232  */
   233 native ReplySource:SetCmdReplySource(ReplySource:source);
   234 
   235 /**
   236  * Returns whether the current say hook is a chat trigger.
   237  *
   238  * This function is only meaningful inside say or say_team hooks.
   239  *
   240  * @return				True if a chat trigger, false otherwise.
   241  */
   242 native bool:IsChatTrigger();
   243 
   244 /**
   245  * Displays usage of an admin command to users depending on the 
   246  * setting of the sm_show_activity cvar.  All users receive a message 
   247  * in their chat text, except for the originating client, who receives 
   248  * the message based on the current ReplySource.
   249  *
   250  * @param client		Client index doing the action, or 0 for server.
   251  * @param tag			Tag to prepend to the message.
   252  * @param format		Formatting rules.
   253  * @param ...			Variable number of format parameters.
   254  * @noreturn
   255  * @error
   256  */
   257 native ShowActivity2(client, const String:tag[], const String:format[], any:...);
   258 
   259 /**
   260  * Displays usage of an admin command to users depending on the 
   261  * setting of the sm_show_activity cvar.  
   262  *
   263  * This version does not display a message to the originating client 
   264  * if used from chat triggers or menus.  If manual replies are used 
   265  * for these cases, then this function will suffice.  Otherwise, 
   266  * ShowActivity2() is slightly more useful.
   267  *
   268  * @param client		Client index doing the action, or 0 for server.
   269  * @param format		Formatting rules.
   270  * @param ...			Variable number of format parameters.
   271  * @noreturn
   272  * @error
   273  */
   274 native ShowActivity(client, const String:format[], any:...);
   275 
   276 /**
   277  * Same as ShowActivity(), except the tag parameter is used instead of
   278  * "[SM] " (note that you must supply any spacing).
   279  *
   280  * @param client		Client index doing the action, or 0 for server.
   281  * @param tag			Tag to display with.
   282  * @param format		Formatting rules.
   283  * @param ...			Variable number of format parameters.
   284  * @noreturn
   285  * @error
   286  */
   287 native ShowActivityEx(client, const String:tag[], const String:format[], any:...);
   288 
   289 /**
   290  * Called when a server-only command is invoked.  
   291  *
   292  * @params args			Number of arguments that were in the argument string.
   293  * @return				An Action value.  Not handling the command
   294  *						means that Source will report it as "not found."
   295  */
   296 functag SrvCmd Action:public(args);
   297 
   298 /**
   299  * Creates a server-only console command, or hooks an already existing one.  
   300  *
   301  * @param cmd			Name of the command to hook or create.
   302  * @param callback		A function to use as a callback for when the command is invoked.
   303  * @param description	Optional description to use for command creation.
   304  * @param flags			Optional flags to use for command creation.
   305  * @noreturn
   306  * @error				Command name is the same as an existing convar.
   307  */
   308 native RegServerCmd(const String:cmd[], SrvCmd:callback, const String:description[]="", flags=0);
   309 
   310 /**
   311  * Called when a generic console command is invoked.
   312  *
   313  * @param client		Index of the client, or 0 from the server.
   314  * @param args			Number of arguments that were in the argument string.
   315  * @return				An Action value.  Not handling the command
   316  *						means that Source will report it as "not found."
   317  */
   318 functag ConCmd Action:public(client, args);
   319 
   320 /**
   321  * Creates a console command, or hooks an already existing one.
   322  *
   323  * @param cmd			Name of the command to hook or create.
   324  * @param callback		A function to use as a callback for when the command is invoked.
   325  * @param description	Optional description to use for command creation.
   326  * @param flags			Optional flags to use for command creation.
   327  * @noreturn
   328  * @error				Command name is the same as an existing convar.
   329  */
   330 native RegConsoleCmd(const String:cmd[], ConCmd:callback, const String:description[]="", flags=0);
   331 
   332 /**
   333  * Creates a console command as an administrative command.  If the command does not exist,
   334  * it is created.  When this command is invoked, the access rights of the player are 
   335  * automatically checked before allowing it to continue.
   336  *
   337  * @param cmd			String containing command to register.
   338  * @param callback		A function to use as a callback for when the command is invoked.
   339  * @param adminflags	Administrative flags (bitstring) to use for permissions.
   340  * @param group			String containing the command group to use.  If empty,
   341  * 						the plugin's filename will be used instead.
   342  * @param description	Optional description to use for help.
   343  * @param flags			Optional console flags.
   344  * @noreturn
   345  * @error				Command name is the same as an existing convar.
   346  */
   347 native RegAdminCmd(const String:cmd[],
   348 					ConCmd:callback,
   349 					adminflags,
   350 					const String:description[]="",
   351 					const String:group[]="",
   352 					flags=0);
   353 					
   354 /**
   355  * Returns the number of arguments from the current console or server command.
   356  * @note Unlike the HL2 engine call, this does not include the command itself.
   357  *
   358  * @return				Number of arguments to the current command.
   359  */
   360 native GetCmdArgs();
   361 
   362 /**
   363  * Retrieves a command argument given its index, from the current console or 
   364  * server command.
   365  * @note Argument indexes start at 1; 0 retrieves the command name.
   366  *
   367  * @param argnum		Argument number to retrieve.
   368  * @param buffer		Buffer to use for storing the string.
   369  * @param maxlength		Maximum length of the buffer.
   370  * @return				Length of string written to buffer.
   371  */
   372 native GetCmdArg(argnum, String:buffer[], maxlength);
   373 
   374 /**
   375  * Retrieves the entire command argument string in one lump from the current 
   376  * console or server command.
   377  *
   378  * @param buffer		Buffer to use for storing the string.
   379  * @param maxlength		Maximum length of the buffer.
   380  * @return				Length of string written to buffer.
   381  */
   382 native GetCmdArgString(String:buffer[], maxlength);
   383 
   384 /**
   385  * Creates a new console variable.
   386  *
   387  * @param name			Name of new convar.
   388  * @param defaultValue	String containing the default value of new convar.
   389  * @param description	Optional description of the convar.
   390  * @param flags			Optional bitstring of flags determining how the convar should be handled. See FCVAR_* constants for more details.
   391  * @param hasMin		Optional boolean that determines if the convar has a minimum value.
   392  * @param min			Minimum floating point value that the convar can have if hasMin is true.
   393  * @param hasMax		Optional boolean that determines if the convar has a maximum value.
   394  * @param max			Maximum floating point value that the convar can have if hasMax is true.
   395  * @return				A handle to the newly created convar. If the convar already exists, INVALID_HANDLE is returned.
   396  * @error				Convar name is blank or is the same as an existing console command.
   397  */
   398 native Handle:CreateConVar(const String:name[], const String:defaultValue[], const String:description[]="", flags=0, bool:hasMin=false, Float:min=0.0, bool:hasMax=false, Float:max=0.0);
   399 
   400 /**
   401  * Searches for a console variable.
   402  *
   403  * @param name			Name of convar to find.
   404  * @return				A handle to the convar if it is found. INVALID_HANDLE otherwise.
   405  */
   406 native Handle:FindConVar(const String:name[]);
   407 
   408 /**
   409  * Called when a console variable's value is changed.
   410  *
   411  * @param convar		Handle to the convar that was changed.
   412  * @param oldValue		String containing the value of the convar before it was changed.
   413  * @param newValue		String containing the new value of the convar.
   414  * @noreturn
   415  */
   416 functag ConVarChanged public(Handle:convar, const String:oldValue[], const String:newValue[]);
   417 
   418 /**
   419  * Creates a hook for when a console variable's value is changed.
   420  *
   421  * @param convar		Handle to the convar.
   422  * @param callback		An OnConVarChanged function pointer.
   423  * @noreturn
   424  * @error				Invalid or corrupt Handle or invalid callback function.
   425  */
   426 native HookConVarChange(Handle:convar, ConVarChanged:callback);
   427 
   428 /**
   429  * Removes a hook for when a console variable's value is changed.
   430  *
   431  * @param convar		Handle to the convar.
   432  * @param callback		An OnConVarChanged function pointer.
   433  * @noreturn
   434  * @error				Invalid or corrupt Handle, invalid callback function, or no active hook on convar.
   435  */
   436 native UnhookConVarChange(Handle:convar, ConVarChanged:callback);
   437 
   438 /**
   439  * Returns the boolean value of a console variable.
   440  *
   441  * @param convar		Handle to the convar.
   442  * @return				The boolean value of the convar.
   443  * @error				Invalid or corrupt Handle.
   444  */
   445 native bool:GetConVarBool(Handle:convar);
   446 
   447 /**
   448  * Sets the boolean value of a console variable.
   449  *
   450  * @param convar		Handle to the convar.
   451  * @param value			New boolean value.
   452  * @param replicate		If set to true, the new convar value will be set on all clients.
   453  *						This will only work if the convar has the FCVAR_REPLICATED flag
   454  *						and actually exists on clients.
   455  * @param notify		If set to true, clients will be notified that the convar has changed.
   456  *						This will only work if the convar has the FCVAR_NOTIFY flag.
   457  * @noreturn
   458  * @error				Invalid or corrupt Handle.
   459  */
   460 native SetConVarBool(Handle:convar, bool:value, bool:replicate=false, bool:notify=false);
   461 
   462 /**
   463  * Returns the integer value of a console variable.
   464  *
   465  * @param convar		Handle to the convar.
   466  * @return				The integer value of the convar.
   467  * @error				Invalid or corrupt Handle.
   468  */
   469 native GetConVarInt(Handle:convar);
   470 
   471 /**
   472  * Sets the integer value of a console variable.
   473  *
   474  * @param convar		Handle to the convar.
   475  * @param value			New integer value.
   476  * @param replicate		If set to true, the new convar value will be set on all clients.
   477  *						This will only work if the convar has the FCVAR_REPLICATED flag
   478  *						and actually exists on clients.
   479  * @param notify		If set to true, clients will be notified that the convar has changed.
   480  *						This will only work if the convar has the FCVAR_NOTIFY flag.
   481  * @noreturn
   482  * @error				Invalid or corrupt Handle.
   483  */
   484 native SetConVarInt(Handle:convar, value, bool:replicate=false, bool:notify=false);
   485 
   486 /**
   487  * Returns the floating point value of a console variable.
   488  *
   489  * @param convar		Handle to the convar.
   490  * @return				The floating point value of the convar.
   491  * @error				Invalid or corrupt Handle.
   492  */
   493 native Float:GetConVarFloat(Handle:convar);
   494 
   495 /**
   496  * Sets the floating point value of a console variable.
   497  *
   498  * @param convar		Handle to the convar.
   499  * @param value			New floating point value.
   500  * @param replicate		If set to true, the new convar value will be set on all clients.
   501  *						This will only work if the convar has the FCVAR_REPLICATED flag
   502  *						and actually exists on clients.
   503  * @param notify		If set to true, clients will be notified that the convar has changed.
   504  *						This will only work if the convar has the FCVAR_NOTIFY flag.
   505  * @noreturn
   506  * @error				Invalid or corrupt Handle.
   507  */
   508 native SetConVarFloat(Handle:convar, Float:value, bool:replicate=false, bool:notify=false);
   509 
   510 /**
   511  * Retrieves the string value of a console variable.
   512  *
   513  * @param convar		Handle to the convar.
   514  * @param value			Buffer to store the value of the convar.
   515  * @param maxlength		Maximum length of string buffer.
   516  * @noreturn
   517  * @error				Invalid or corrupt Handle.     
   518  */
   519 native GetConVarString(Handle:convar, String:value[], maxlength);
   520 
   521 /**
   522  * Sets the string value of a console variable.
   523  *
   524  * @param convar		Handle to the convar.
   525  * @param value			New string value.
   526  * @param replicate		If set to true, the new convar value will be set on all clients.
   527  *						This will only work if the convar has the FCVAR_REPLICATED flag
   528  *						and actually exists on clients.
   529  * @param notify		If set to true, clients will be notified that the convar has changed.
   530  *						This will only work if the convar has the FCVAR_NOTIFY flag.
   531  * @noreturn
   532  * @error				Invalid or corrupt Handle.
   533  */
   534 native SetConVarString(Handle:convar, const String:value[], bool:replicate=false, bool:notify=false);
   535 
   536 /**
   537  * Resets the console variable to its default value.
   538  *
   539  * @param convar		Handle to the convar.
   540  * @param replicate		If set to true, the new convar value will be set on all clients.
   541  *						This will only work if the convar has the FCVAR_REPLICATED flag
   542  *						and actually exists on clients.
   543  * @param notify		If set to true, clients will be notified that the convar has changed.
   544  *						This will only work if the convar has the FCVAR_NOTIFY flag.
   545  * @noreturn
   546  * @error				Invalid or corrupt Handle.
   547  */
   548 native ResetConVar(Handle:convar, bool:replicate=false, bool:notify=false);
   549 
   550 /**
   551  * Returns the bitstring of flags on a console variable.
   552  *
   553  * @param convar		Handle to the convar.
   554  * @return				A bitstring containing the FCVAR_* flags that are enabled.
   555  * @error				Invalid or corrupt Handle.
   556  */
   557 native GetConVarFlags(Handle:convar);
   558 
   559 /**
   560  * Sets the bitstring of flags on a console variable.
   561  *
   562  * @param convar		Handle to the convar.
   563  * @param flags			A bitstring containing the FCVAR_* flags to enable.
   564  * @noreturn
   565  * @error				Invalid or corrupt Handle.
   566  */
   567 native SetConVarFlags(Handle:convar, flags);
   568 
   569 /**
   570  * Retrieves the specified bound of a console variable.
   571  *
   572  * @param convar		Handle to the convar.
   573  * @param type			Type of bound to retrieve, ConVarBound_Lower or ConVarBound_Upper.
   574  * @param value			By-reference cell to store the specified floating point bound value.
   575  * @return				True if the convar has the specified bound set, false otherwise.
   576  * @error				Invalid or corrupt Handle.
   577  */
   578 native bool:GetConVarBounds(Handle:convar, ConVarBounds:type, &Float:value);
   579 
   580 /**
   581  * Sets the specified bound of a console variable.
   582  *
   583  * @param convar		Handle to the convar.
   584  * @param type			Type of bound to set, ConVarBound_Lower or ConVarBound_Upper
   585  * @param set			If set to true, convar will use specified bound. If false, bound will be removed.
   586  * @param value			Floating point value to use as the specified bound.
   587  * @noreturn
   588  * @error				Invalid or corrupt Handle.
   589  */
   590 native SetConVarBounds(Handle:convar, ConVarBounds:type, bool:set, Float:value=0.0);
   591 
   592 /**
   593  * Retrieves the name of a console variable.
   594  *
   595  * @param convar		Handle to the convar.
   596  * @param value			Buffer to store the name of the convar.
   597  * @param maxlength		Maximum length of string buffer.
   598  * @noreturn
   599  * @error				Invalid or corrupt Handle.     
   600  */
   601 native GetConVarName(Handle:convar, const String:name[], maxlength);
   602 
   603 funcenum ConVarQueryFinished
   604 {	
   605 	/**
   606 	 * Called when a query to retrieve a client's console variable has finished.
   607 	 *
   608 	 * @param cookie		Unique identifier of query.
   609 	 * @param client		Player index.
   610 	 * @param result		Result of query that tells one whether or not query was successful.
   611 	 *						See ConVarQueryResult enum for more details.
   612 	 * @param convarName	Name of client convar that was queried.
   613 	 * @param convarValue	Value of client convar that was queried if successful. This will be "" if it was not.
   614 	 * @param value			Value that was passed when query was started.
   615 	 * @noreturn
   616 	 */
   617 	public(QueryCookie:cookie, client, ConVarQueryResult:result, const String:cvarName[], const String:cvarValue[], any:value),
   618 	
   619 	/**
   620 	 * Called when a query to retrieve a client's console variable has finished.
   621 	 *
   622 	 * @param cookie		Unique identifier of query.
   623 	 * @param client		Player index.
   624 	 * @param result		Result of query that tells one whether or not query was successful.
   625 	 *						See ConVarQueryResult enum for more details.
   626 	 * @param convarName	Name of client convar that was queried.
   627 	 * @param convarValue	Value of client convar that was queried if successful. This will be "" if it was not.
   628 	 * @noreturn
   629 	 */
   630 	public(QueryCookie:cookie, client, ConVarQueryResult:result, const String:cvarName[], const String:cvarValue[])
   631 };
   632 
   633 /**
   634  * Starts a query to retrieve the value of a client's console variable.
   635  *
   636  * @param client		Player index.
   637  * @param name			Name of client convar to query.
   638  * @param callback		A function to use as a callback when the query has finished.
   639  * @param value			Optional value to pass to the callback function.
   640  * @return				A cookie that uniquely identifies the query. 
   641  *						Returns QUERYCOOKIE_FAILED on failure, such as when used on a bot.
   642  */
   643 native QueryCookie:QueryClientConVar(client, const String:cvarName[], ConVarQueryFinished:callback, any:value=0);
   644 
   645 /**
   646  * Gets a command iterator.  Must be freed with CloseHandle().
   647  *
   648  * @return				A new command iterator.
   649  */
   650 native Handle:GetCommandIterator();
   651 
   652 /**
   653  * Reads a command iterator, then advances to the next command if any.
   654  * Only SourceMod specific commands are returned.
   655  *
   656  * @param iter			Command iterator Handle.
   657  * @param name			Name buffer.
   658  * @param nameLen		Name buffer size.
   659  * @param eflags		Effective default flags of a command.
   660  * @param desc			Command description buffer.
   661  * @param descLen		Command description buffer size.
   662  * @return				True on success, false if there are no more commands.
   663  */
   664 native bool:ReadCommandIterator(Handle:iter, 
   665 								String:name[], 
   666 								nameLen, 
   667 								&eflags=0, 
   668 								String:desc[]="", 
   669 								descLen=0);
   670 
   671 /**
   672  * Returns whether a client has access to a given command string.  The string 
   673  * can also be any override string, as overrides can be independent of 
   674  * commands.  This important feature essentially allows you to create custom 
   675  * flags using the override system.
   676  *
   677  * @param client		Client index.
   678  * @param command		Command name.  If the command is not found, the default 
   679  *						flags are used.
   680  * @param flags			Flag string to use as a default, if the command or override 
   681  *						is not found.
   682  * @param override_only	If true, SourceMod will not attempt to find a matching 
   683  *						command, and it will only use the default flags specified.
   684  *						Otherwise, SourceMod will ignore the default flags if 
   685  *						there is a matching admin command.
   686  * @return				True if the client has access, false otherwise.
   687  */
   688 native bool:CheckCommandAccess(client, 
   689 							   const String:command[],
   690 							   flags,
   691 							   bool:override_only=false);
   692 
   693 /**
   694  * Returns true if the supplied character is valid in a ConVar name.
   695  *
   696  * @param c			Character to validate.
   697  * @return			True is valid for ConVars, false otherwise
   698  */
   699 stock bool:IsValidConVarChar(c)
   700 {
   701 	return (c == '_' || IsCharAlpha(c) || IsCharNumeric(c));
   702 }
   703 
   704 /**
   705  * Returns the bitstring of flags of a command.
   706  *
   707  * @param name		Name of the command.
   708  * @return			A bitstring containing the FCVAR_* flags that are enabled 
   709  *					or INVALID_FCVAR_FLAGS if command not found.
   710  */
   711 native GetCommandFlags(const String:name[]);
   712 
   713 /**
   714  * Sets the bitstring of flags of a command.
   715  *
   716  * @param name		Name of the command.
   717  * @param flags		A bitstring containing the FCVAR_* flags to enable.
   718  * @return			True on success, otherwise false.
   719  */
   720 native bool:SetCommandFlags(const String:name[], flags);
   721 
   722 /**
   723  * Starts a ConCommandBase search, traversing the list of ConVars and 
   724  * ConCommands.  If a Handle is returned, the next entry must be read 
   725  * via FindNextConCommand().  The order of the list is undefined.
   726  *
   727  * @param buffer		Buffer to store entry name.
   728  * @param max_size		Maximum size of the buffer.
   729  * @param isCommand		Variable to store whether the entry is a command. 
   730  *						If it is not a command, it is a ConVar.
   731  * @param flags			Variable to store entry flags.
   732  * @return				On success, a ConCmdIter Handle is returned, which 
   733  *						can be read via FindNextConCommand(), and must be 
   734  *						closed via CloseHandle().  Additionally, the output 
   735  *						parameters will be filled with information of the 
   736  *						first ConCommandBase entry.
   737  *						On failure, INVALID_HANDLE is returned, and the 
   738  *						contents of outputs is undefined.
   739  */
   740 native Handle:FindFirstConCommand(String:buffer[], max_size, &bool:isCommand, &flags=0);
   741 
   742 /**
   743  * Reads the next entry in a ConCommandBase iterator.
   744  *
   745  * @param search		ConCmdIter Handle to search.
   746  * @param buffer		Buffer to store entry name.
   747  * @param max_size		Maximum size of the buffer.
   748  * @param isCommand		Variable to store whether the entry is a command.
   749  *						If it is not a command, it is a ConVar.
   750  * @param flags			Variable to store entry flags.
   751  * @return				On success, the outputs are filled, the iterator is 
   752  *						advanced to the next entry, and true is returned.  
   753  *						If no more entries exist, false is returned, and the 
   754  *						contents of outputs is undefined.
   755  */
   756 native bool:FindNextConCommand(Handle:search, String:buffer[], max_size, &bool:isCommand, &flags=0);
   757 
   758 /**
   759  * Replicates a convar value to a specific client. This does not change the actual convar value.
   760  *
   761  * @param client		Client index
   762  * @param convar		ConVar handle
   763  * @param value			String value to send
   764  * @return				True on success, false on failure
   765  * @error 				Invalid client index, client not in game, or client is fake
   766  */
   767 native bool:SendConVarValue(client, Handle:convar, const String:value[]);