3 * =============================================================================
4 * SourceMod (C)2004-2008 AlliedModders LLC. All rights reserved.
5 * =============================================================================
7 * This file is part of the SourceMod/SourcePawn SDK.
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.
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
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/>.
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>.
33 #if defined _sourcemod_included
36 #define _sourcemod_included
39 * Plugin public information.
43 const String:name[], /**< Plugin Name */
44 const String:description[], /**< Plugin Description */
45 const String:author[], /**< Plugin Author */
46 const String:version[], /**< Plugin Version */
47 const String:url[], /**< Plugin URL */
68 #include <usermessages>
74 #include <commandfilters>
77 * Declare this as a struct in your plugin to expose its information.
80 * public Plugin:myinfo =
89 * Called when the plugin is fully initialized and all known external references
90 * are resolved. This is only called once in the lifetime of the plugin, and is
91 * paired with OnPluginEnd().
93 * If any run-time error is thrown during this callback, the plugin will be marked
96 * It is not necessary to close any handles or remove hooks in this function.
97 * SourceMod guarantees that plugin shutdown automatically and correctly releases
102 forward OnPluginStart();
105 * Called before OnPluginStart, in case the plugin wants to check for load failure.
106 * This is called even if the plugin type is "private." Any natives from modules are
107 * not available at this point. Thus, this forward should only be used for explicit
108 * pre-emptive things, such as adding dynamic natives, or setting certain types of load filters.
110 * @note It is not safe to call externally resolved natives until OnPluginStart().
111 * @note Any sort of RTE in this function will cause the plugin to fail loading.
112 * @note You MUST remember to return SOMETHING here. The act of not returning is
113 * equivalent to returning 0 (false). If you forgot to return, it will
114 * cause your plugin to not load with a very strange error message.
116 * @param myself Handle to the plugin.
117 * @param late Whether or not the plugin was loaded "late" (after map load).
118 * @param error Error message buffer in case load failed.
119 * @param err_max Maximum number of characters for error message buffer.
120 * @return True if load success, false otherwise.
122 forward bool:AskPluginLoad(Handle:myself, bool:late, String:error[], err_max);
125 * Called when the plugin is about to be unloaded.
129 forward OnPluginEnd();
132 * Called when the plugin's pause status is changing.
134 * @param pause True if the plugin is being paused, false otherwise.
137 forward OnPluginPauseChange(bool:pause);
140 * Called before every server frame. Note that you should avoid
141 * doing expensive computations here, and you should declare large
142 * local arrays using 'decl' instead of 'new'.
144 forward OnGameFrame();
147 * Called when the map is loaded.
149 * @note This used to be OnServerLoad(), which is now deprecated.
150 * Plugins still using the old forward will work.
152 forward OnMapStart();
155 * Called right before a map ends.
160 * Called when the map has loaded, servercfgfile (server.cfg) has been
161 * executed, and all plugin configs are done executing. This is the best
162 * place to initialize plugin functions which are based on cvar data.
164 * @note This will always be called once and only once per map. It will be
165 * called after OnMapStart().
169 forward OnConfigsExecuted();
172 * This is called once, right after OnMapStart() but any time before
173 * OnConfigsExecuted(). It is called after the "exec sourcemod.cfg"
174 * command and all AutoExecConfig() exec commands have been added to
175 * the ServerCommand() buffer.
177 * If you need to load per-map settings that override default values,
178 * adding commands to the ServerCommand() buffer here will guarantee
179 * that they're set before OnConfigsExecuted().
181 * Unlike OnMapStart() and OnConfigsExecuted(), this is not called on
182 * late loads that occur after OnMapStart().
186 forward OnAutoConfigsBuffered();
189 * @deprecated Use OnConfigsExecuted() instead.
191 #pragma deprecated Use OnConfigsExecuted() instead
192 forward OnServerCfg();
195 * Called after all plugins have been loaded. This is called once for
196 * every plugin. If a plugin late loads, it will be called immediately
197 * after OnPluginStart().
199 forward OnAllPluginsLoaded();
202 * Returns the calling plugin's Handle.
204 * @return Handle of the calling plugin.
206 native Handle:GetMyHandle();
209 * Returns an iterator that can be used to search through plugins.
211 * @return Handle to iterate with. Must be closed via
213 * @error Invalid Handle.
215 native Handle:GetPluginIterator();
218 * Returns whether there are more plugins available in the iterator.
220 * @param iter Handle to the plugin iterator.
221 * @return True on more plugins, false otherwise.
222 * @error Invalid Handle.
224 native bool:MorePlugins(Handle:iter);
227 * Returns the current plugin in the iterator and advances the iterator.
229 * @param iter Handle to the plugin iterator.
230 * @return Current plugin the iterator is at, before
231 * the iterator is advanced.
232 * @error Invalid Handle.
234 native Handle:ReadPlugin(Handle:iter);
237 * Returns a plugin's status.
239 * @param plugin Plugin Handle (INVALID_HANDLE uses the calling plugin).
240 * @return Status code for the plugin.
241 * @error Invalid Handle.
243 native PluginStatus:GetPluginStatus(Handle:plugin);
246 * Retrieves a plugin's file name relative to the plugins folder.
248 * @param plugin Plugin Handle (INVALID_HANDLE uses the calling plugin).
249 * @param buffer Buffer to the store the file name.
250 * @param maxlength Maximum length of the name buffer.
252 * @error Invalid Handle.
254 native GetPluginFilename(Handle:plugin, String:buffer[], maxlength);
257 * Retrieves whether or not a plugin is being debugged.
259 * @param plugin Plugin Handle (INVALID_HANDLE uses the calling plugin).
260 * @return True if being debugged, false otherwise.
261 * @error Invalid Handle.
263 native bool:IsPluginDebugging(Handle:hndl);
266 * Retrieves a plugin's public info.
268 * @param plugin Plugin Handle (INVALID_HANDLE uses the calling plugin).
269 * @param info Plugin info property to retrieve.
270 * @param buffer Buffer to store info in.
271 * @param maxlength Maximum length of buffer.
272 * @return True on success, false if property is not available.
273 * @error Invalid Handle.
275 native bool:GetPluginInfo(Handle:plugin, PluginInfo:info, String:buffer[], maxlength);
278 * Finds a plugin by its order in the list from the "plugins list" server
279 * "sm" command. You should not use this function to loop through all plugins,
280 * use the iterator instead. Looping through all plugins using this native
281 * is O(n^2), whereas using the iterator is O(n).
283 * @param order_num Number of the plugin as it appears in "sm plugins list".
284 * @return Plugin Handle on success, INVALID_HANDLE if no plugin
285 * matches the given number.
287 native Handle:FindPluginByNumber(order_num);
290 * Causes the plugin to enter a failed state. An error will be thrown and
291 * the plugin will be paused until it is unloaded or reloaded.
293 * For backwards compatibility, if no extra arguments are passed, no
294 * formatting is applied. If one or more additional arguments is passed,
295 * the string is formatted using Format(). If any errors are encountered
296 * during formatting, both the format specifier string and an additional
297 * error message are written.
299 * This function does not return, and no further code in the plugin is
302 * @param string Format specifier string.
303 * @param ... Formatting arguments.
305 * @error Always throws SP_ERROR_ABORT.
307 native SetFailState(const String:string[], any:...);
310 * Aborts the current callback and throws an error. This function
311 * does not return in that no code is executed following it.
313 * @param format String format.
314 * @param ... Format arguments.
318 native ThrowError(const String:fmt[], any:...);
321 * Gets the system time as a unix timestamp.
323 * @param bigStamp Optional array to store the 64bit timestamp in.
324 * @return 32bit timestamp (number of seconds since unix epoch).
326 native GetTime(bigStamp[2]={0,0});
329 * Produces a date and/or time string value for a timestamp.
331 * See this URL for valid parameters:
332 * http://cplusplus.com/reference/clibrary/ctime/strftime.html
334 * @param buffer Destination string buffer.
335 * @param maxlength Maximum length of output string buffer.
336 * @param format Formatting rules (passing NULL_STRING will use the rules defined in sm_datetime_format).
337 * @param stamp Optional time stamp.
339 * @error Buffer too small or invalid time format.
341 native FormatTime(String:buffer[], maxlength, const String:format[], stamp=-1);
344 * Loads a game config file.
346 * @param file File to load. The path must be relative to the 'gamedata' folder under the config folder
347 * and the extension should be omitted.
348 * @return A handle to the game config file or INVALID_HANDLE in failure.
350 native Handle:LoadGameConfigFile(const String:file[]);
353 * Returns an offset value.
355 * @param gc Game config handle.
356 * @param key Key to retrieve from the offset section.
357 * @return An offset, or -1 on failure.
359 native GameConfGetOffset(Handle:gc, const String:key[]);
362 * Gets the value of a key from the "Keys" section.
364 * @param gc Game config handle.
365 * @param key Key to retrieve from the Keys section.
366 * @param buffer Destination string buffer.
367 * @param maxlen Maximum length of output string buffer.
368 * @return True if key existed, false otherwise.
370 native bool:GameConfGetKeyValue(Handle:gc, const String:key[], String:buffer[], maxlen);
373 * Returns the operating system's "tick count," which is a number of
374 * milliseconds since the operating system loaded. This can be used
375 * for basic benchmarks.
377 * @return Tick count in milliseconds.
379 native GetSysTickCount();
382 * Specifies that the given config file should be executed after plugin load.
383 * OnConfigsExecuted() will not be called until the config file has executed,
384 * but it will be called if the execution fails.
386 * @param autoCreate If true, and the config file does not exist, such a config
387 * file will be automatically created and populated with
388 * information from the plugin's registered cvars.
389 * @param name Name of the config file, excluding the .cfg extension.
390 * If empty, <plugin.filename.cfg> is assumed.
391 * @param folder Folder under cfg/ to use. By default this is "sourcemod."
394 native AutoExecConfig(bool:autoCreate=true, const String:name[]="", const String:folder[]="sourcemod");
397 * Sets a native as optional, such that if it is unloaded, removed,
398 * or otherwise non-existent, the plugin will still work. Calling
399 * removed natives results in a run-time error.
401 * @param name Native name.
404 native MarkNativeAsOptional(const String:name[]);
407 * Registers a library name for identifying as a dependency to
410 * @param name Library name.
413 native RegPluginLibrary(const String:name[]);
416 * Returns whether a library exists. This function should be considered
417 * expensive; it should only be called on plugin to determine availability
418 * of resources. Use OnLibraryAdded()/OnLibraryRemoved() to detect changes
419 * in optional resources.
421 * @param name Library name of a plugin or extension.
422 * @return True if exists, false otherwise.
424 native bool:LibraryExists(const String:name[]);
427 * Returns the status of an extension, by filename.
429 * @param name Extension name (like "sdktools.ext").
430 * @param error Optional error message buffer.
431 * @param maxlength Length of optional error message buffer.
432 * @return -2 if the extension was not found.
433 * -1 if the extension was found but failed to load.
434 * 0 if the extension loaded but reported an error.
435 * 1 if the extension is running without error.
437 native GetExtensionFileStatus(const String:name[], String:error[]="", maxlength=0);
440 * Called after a library is added that the current plugin references
441 * optionally. A library is either a plugin name or extension name, as
442 * exposed via its include file.
444 * @param name Library name.
446 forward OnLibraryAdded(const String:name[]);
449 * Called right before a library is removed that the current plugin references
450 * optionally. A library is either a plugin name or extension name, as
451 * exposed via its include file.
453 * @param name Library name.
455 forward OnLibraryRemoved(const String:name[]);
457 #define MAPLIST_FLAG_MAPSFOLDER (1<<0) /**< On failure, use all maps in the maps folder. */
458 #define MAPLIST_FLAG_CLEARARRAY (1<<1) /**< If an input array is specified, clear it before adding. */
459 #define MAPLIST_FLAG_NO_DEFAULT (1<<2) /**< Do not read "default" or "mapcyclefile" on failure. */
462 * Loads a map list to an ADT Array.
464 * A map list is a list of maps from a file. SourceMod allows easy configuration of
465 * maplists through addons/sourcemod/configs/maplists.cfg. Each entry is given a
466 * name and a file (for example, "rtv" => "rtv.cfg"), or a name and a redirection
467 * (for example, "rtv" => "default"). This native will read a map list entry,
468 * cache the file, and return the list of maps it holds.
470 * Serial change numbers are used to identify if a map list has changed. Thus, if
471 * you pass a serial change number and it's equal to what SourceMod currently knows
472 * about the map list, then SourceMod won't reparse the file.
474 * If the maps end up being read from the maps folder (MAPLIST_FLAG_MAPSFOLDER), they
475 * are automatically sorted in alphabetical, ascending order.
477 * Arrays created by this function are temporary and must be freed via CloseHandle().
478 * Modifying arrays created by this function will not affect future return values or
479 * or the contents of arrays returned to other plugins.
481 * @param array Array to store the map list. If INVALID_HANDLE, a new blank
482 * array will be created. The blocksize should be at least 16;
483 * otherwise results may be truncated. Items are added to the array
484 * as strings. The array is never checked for duplicates, and it is
485 * not read beforehand. Only the serial number is used to detect
487 * @param serial Serial number to identify last known map list change. If -1, the
488 * the value will not be checked. If the map list has since changed,
489 * the serial is updated (even if -1 was passed). If there is an error
490 * finding a valid maplist, then the serial is set to -1.
491 * @param str Config name, or "default" for the default map list. Config names
492 * should be somewhat descriptive. For example, the admin menu uses
493 * a config name of "admin menu". The list names can be configured
494 * by users in addons/sourcemod/configs/maplists.cfg.
495 * @param flags MAPLIST_FLAG flags.
496 * @return On failure:
497 * INVALID_HANDLE is returned, the serial is set to -1, and the input
498 * array (if any) is left unchanged.
500 INVALID_HANDLE is returned, the serial is unchanged, and the input
501 array (if any) is left unchanged.
503 * A valid array Handle is returned, containing at least one map string.
504 * If an array was passed, the return value is equal to the passed Array
505 * Handle. If the passed array was not cleared, it will have grown by at
506 * least one item. The serial number is updated to a positive number.
507 * @error Invalid array Handle that is not INVALID_HANDLE.
509 native Handle:ReadMapList(Handle:array=INVALID_HANDLE,
511 const String:str[]="default",
512 flags=MAPLIST_FLAG_CLEARARRAY);
515 * Makes a compatibility binding for map lists. For example, if a function previously used
516 * "clam.cfg" for map lists, this function will insert a "fake" binding to "clam.cfg" that
517 * will be overridden if it's in the maplists.cfg file.
519 * @param name Configuration name that would be used with ReadMapList().
520 * @param file Default file to use.
523 native SetMapListCompatBind(const String:name[], const String:file[]);
526 * Called when a client has sent chat text. This must return either true or
527 * false to indicate that a client is or is not spamming the server.
529 * The return value is a hint only. Core or another plugin may decide
532 * @param client Client index. The server (0) will never be passed.
533 * @return True if client is spamming the server, false otherwise.
535 forward bool:OnClientFloodCheck(client);
538 * Called after a client's flood check has been computed. This can be used
539 * by antiflood algorithms to decay/increase flooding weights.
541 * Since the result from "OnClientFloodCheck" isn't guaranteed to be the
542 * final result, it is generally a good idea to use this to play with other
545 * @param client Client index. The server (0) will never be passed.
546 * @param blocked True if client flooded last "say", false otherwise.
549 forward OnClientFloodResult(client, bool:blocked);
553 #include <entity_prop_stocks>
