dvander@429: /**
ds@475: * vim: set ts=4 :
ds@1330: * =============================================================================
dvander@429: * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
ds@1330: * =============================================================================
ds@1330: *
ds@1330: * This file is part of the SourceMod/SourcePawn SDK.
dvander@429: *
ds@1330: * This program is free software; you can redistribute it and/or modify it under
ds@1330: * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330: * Free Software Foundation.
ds@1330: *
ds@1330: * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
ds@1330: * details.
ds@1330: *
ds@1330: * You should have received a copy of the GNU General Public License along with
ds@1330: * this program. If not, see .
ds@1330: *
ds@1330: * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330: * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330: * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330: * by the Valve Corporation. You must obey the GNU General Public License in
ds@1330: * all respects for all other code used. Additionally, AlliedModders LLC grants
ds@1330: * this exception to all derivative works. AlliedModders LLC defines further
ds@1330: * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330: * or .
dvander@429: *
faluco@506: * Version: $Id$
dvander@429: */
dvander@429:
dvander@429: #if defined _sourcemod_included
dvander@429: #endinput
dvander@429: #endif
dvander@429: #define _sourcemod_included
dvander@429:
dvander@619: /**
dvander@619: * Plugin public information.
dvander@619: */
dvander@429: struct Plugin
dvander@429: {
dvander@619: const String:name[], /**< Plugin Name */
dvander@619: const String:description[], /**< Plugin Description */
dvander@619: const String:author[], /**< Plugin Author */
dvander@619: const String:version[], /**< Plugin Version */
dvander@619: const String:url[], /**< Plugin URL */
dvander@429: };
dvander@429:
dvander@429: #include
dvander@429: #include
dvander@1069: #include
ds@873: #include
dvander@429: #include
dvander@601: #include
ds@873: #include
dvander@643: #include
ds@873: #include
dvander@868: #include
ds@913: #include
ds@873: #include
ds@913: #include
ds@873: #include
ds@873: #include
ds@873: #include
ds@873: #include
ds@873: #include
ds@913: #include
ds@873: #include
ds@898: #include
dvander@1156: #include
dvander@1423: #include
dvander@1621: #include
ds@898:
dvander@429: /**
dvander@429: * Declare this as a struct in your plugin to expose its information.
dvander@429: * Example:
dvander@429: *
dvander@429: * public Plugin:myinfo =
dvander@429: * {
dvander@429: * name = "My Plugin",
dvander@429: * //etc
dvander@429: * };
dvander@429: */
dvander@429: public Plugin:myinfo;
dvander@429:
dvander@429: /**
dvander@429: * Called when the plugin is fully initialized and all known external references are resolved.
dvander@429: * This is called even if the plugin type is "private."
dvander@619: * @note Errors in this function will cause the plugin to stop running.
dvander@429: *
dvander@429: * @noreturn
dvander@429: */
dvander@536: forward OnPluginStart();
dvander@429:
dvander@429: /**
dvander@979: * Called before OnPluginStart, in case the plugin wants to check for load failure.
dvander@429: * This is called even if the plugin type is "private." Any natives from modules are
dvander@429: * not available at this point. Thus, this forward should only be used for explicit
dvander@429: * pre-emptive things, such as adding dynamic natives, or setting certain types of load filters.
dvander@429: *
dvander@619: * @note It is not safe to call externally resolved natives until OnPluginStart().
dvander@619: * @note Any sort of RTE in this function will cause the plugin to fail loading.
dvander@429: *
dvander@429: * @param myself Handle to the plugin.
dvander@429: * @param late Whether or not the plugin was loaded "late" (after map load).
dvander@429: * @param error Error message buffer in case load failed.
dvander@429: * @param err_max Maximum number of characters for error message buffer.
dvander@429: * @return True if load success, false otherwise.
dvander@429: */
dvander@429: forward bool:AskPluginLoad(Handle:myself, bool:late, String:error[], err_max);
dvander@429:
dvander@429: /**
dvander@429: * Called when the plugin is about to be unloaded.
dvander@429: *
dvander@429: * @noreturn
dvander@429: */
dvander@429: forward OnPluginEnd();
dvander@429:
dvander@429: /**
dvander@429: * Called when the plugin's pause status is changing.
dvander@429: *
ds@475: * @param pause True if the plugin is being paused, false otherwise.
dvander@429: * @noreturn
dvander@429: */
dvander@429: forward OnPluginPauseChange(bool:pause);
dvander@429:
dvander@429: /**
dvander@531: * Called before every server frame. Note that you should avoid
dvander@531: * doing expensive computations here, and you should declare large
dvander@531: * local arrays using 'decl' instead of 'new'.
dvander@531: */
dvander@531: forward OnGameFrame();
dvander@531:
dvander@531: /**
dvander@717: * Called when the map is loaded.
dvander@717: *
dvander@723: * @note This used to be OnServerLoad(), which is now deprecated.
dvander@717: * Plugins still using the old forward will work.
dvander@643: */
dvander@717: forward OnMapStart();
dvander@643:
dvander@643: /**
dvander@718: * Called right before a map ends.
dvander@718: */
dvander@718: forward OnMapEnd();
dvander@718:
dvander@718: /**
dvander@978: * Called when the map has loaded, servercfgfile (server.cfg) has been
dvander@978: * executed, and all plugin configs are done executing. This is the best
dvander@1732: * place to initialize plugin functions which are based on cvar data.
dvander@723: *
dvander@978: * @note This will always be called once and only once per map. It will be
dvander@978: * called after OnMapStart().
dvander@978: *
dvander@978: * @noreturn
dvander@723: */
dvander@978: forward OnConfigsExecuted();
dvander@723:
dvander@723: /**
dvander@979: * @deprecated Use OnConfigsExecuted() instead.
dvander@979: */
ds@1268: #pragma deprecated Use OnConfigsExecuted() instead
dvander@979: forward OnServerCfg();
dvander@979:
dvander@979: /**
dvander@1630: * Called after all plugins have been loaded. This is called once for
dvander@1630: * every plugin. If a plugin late loads, it will be called immediately
dvander@1630: * after OnPluginStart().
faluco@1221: */
faluco@1221: forward OnAllPluginsLoaded();
faluco@1221:
faluco@1221: /**
dvander@1378: * Called when an action is going to be logged.
dvander@1378: *
dvander@1378: * @param source Handle to the object logging the action, or INVALID_HANDLE
dvander@1378: * if Core is logging the action.
dvander@1378: * @param ident Type of object logging the action (plugin, ext, or core).
dvander@1378: * @param client Client the action is from; 0 for server, -1 if not applicable.
dvander@1378: * @param target Client the action is targetting, or -1 if not applicable.
dvander@1378: * @param message Message that is being logged.
dvander@1378: * @return Plugin_Continue will cause Core to defaulty log the message.
dvander@1378: * Plugin_Handled will stop Core from logging the message.
dvander@1378: * Plugin_Stop is the same as Handled, but prevents any other
dvander@1378: * plugins from handling the message.
dvander@1378: */
dvander@1378: forward Action:OnLogAction(Handle:source,
dvander@1378: Identity:ident,
dvander@1378: client,
dvander@1378: target,
dvander@1378: const String:message[]);
dvander@1378:
dvander@1378: /**
dvander@536: * Returns the calling plugin's Handle.
dvander@536: *
dvander@536: * @return Handle of the calling plugin.
dvander@536: */
dvander@536: native Handle:GetMyHandle();
dvander@536:
dvander@618: /**
dvander@618: * Returns an iterator that can be used to search through plugins.
dvander@618: *
dvander@618: * @return Handle to iterate with. Must be closed via
dvander@618: * CloseHandle().
dvander@618: * @error Invalid Handle.
dvander@618: */
dvander@618: native Handle:GetPluginIterator();
dvander@618:
dvander@618: /**
dvander@618: * Returns whether there are more plugins available in the iterator.
dvander@618: *
dvander@618: * @param iter Handle to the plugin iterator.
dvander@618: * @return True on more plugins, false otherwise.
dvander@618: * @error Invalid Handle.
dvander@618: */
dvander@618: native bool:MorePlugins(Handle:iter);
dvander@618:
dvander@618: /**
dvander@618: * Returns the current plugin in the iterator and advances the iterator.
dvander@618: *
dvander@618: * @param iter Handle to the plugin iterator.
dvander@618: * @return Current plugin the iterator is at, before
dvander@618: * the iterator is advanced.
dvander@618: * @error Invalid Handle.
dvander@618: */
dvander@618: native Handle:ReadPlugin(Handle:iter);
dvander@618:
dvander@618: /**
dvander@618: * Returns a plugin's status.
dvander@618: *
dvander@618: * @param plugin Plugin Handle (INVALID_HANDLE uses the calling plugin).
dvander@618: * @return Status code for the plugin.
dvander@618: * @error Invalid Handle.
dvander@618: */
dvander@618: native PluginStatus:GetPluginStatus(Handle:plugin);
dvander@618:
dvander@618: /**
dvander@618: * Retrieves a plugin's file name relative to the plugins folder.
dvander@618: *
dvander@618: * @param plugin Plugin Handle (INVALID_HANDLE uses the calling plugin).
dvander@618: * @param buffer Buffer to the store the file name.
dvander@618: * @param maxlength Maximum length of the name buffer.
dvander@618: * @noreturn
dvander@618: * @error Invalid Handle.
dvander@618: */
dvander@618: native GetPluginFilename(Handle:plugin, String:buffer[], maxlength);
dvander@618:
dvander@618: /**
dvander@618: * Retrieves whether or not a plugin is being debugged.
dvander@618: *
dvander@618: * @param plugin Plugin Handle (INVALID_HANDLE uses the calling plugin).
dvander@618: * @return True if being debugged, false otherwise.
dvander@618: * @error Invalid Handle.
dvander@618: */
dvander@618: native bool:IsPluginDebugging(Handle:hndl);
dvander@618:
dvander@618: /**
dvander@618: * Retrieves a plugin's public info.
dvander@618: *
dvander@618: * @param plugin Plugin Handle (INVALID_HANDLE uses the calling plugin).
dvander@618: * @param info Plugin info property to retrieve.
dvander@618: * @param buffer Buffer to store info in.
dvander@618: * @param maxlength Maximum length of buffer.
dvander@618: * @return True on success, false if property is not available.
dvander@618: * @error Invalid Handle.
dvander@618: */
dvander@618: native bool:GetPluginInfo(Handle:plugin, PluginInfo:info, String:buffer[], maxlength);
dvander@560:
dvander@560: /**
dvander@1798: * Finds a plugin by its order in the list from the "plugins list" server
dvander@1798: * "sm" command. You should not use this function to loop through all plugins,
dvander@1798: * use the iterator instead. Looping through all plugins using this native
dvander@1798: * is O(n^2), whereas using the iterator is O(n).
dvander@1798: *
dvander@1798: * @param order_num Number of the plugin as it appears in "sm plugins list".
dvander@1798: * @return Plugin Handle on success, INVALID_HANDLE if no plugin
dvander@1798: * matches the given number.
dvander@1798: */
dvander@1798: native Handle:FindPluginByNumber(order_num);
dvander@1798:
dvander@1798: /**
dvander@837: * Causes the plugin to enter a failed state. An error will be thrown and
dvander@837: * the plugin will be paused until it is unloaded or reloaded.
dvander@837: *
dvander@1833: * For backwards compatibility, if no extra arguments are passed, no
dvander@1833: * formatting is applied. If one or more additional arguments is passed,
dvander@1833: * the string is formatted using Format(). If any errors are encountered
dvander@1833: * during formatting, both the format specifier string and an additional
dvander@1833: * error message are written.
dvander@1833: *
dvander@1833: * This function does not return, and no further code in the plugin is
dvander@1833: * executed.
dvander@1833: *
dvander@1833: * @param string Format specifier string.
dvander@1833: * @param ... Formatting arguments.
dvander@837: * @noreturn
dvander@838: * @error Always throws SP_ERROR_ABORT.
dvander@837: */
dvander@1833: native SetFailState(const String:string[], any:...);
dvander@837:
dvander@837: /**
dvander@560: * Aborts the current callback and throws an error. This function
dvander@560: * does not return in that no code is executed following it.
dvander@560: *
dvander@560: * @param format String format.
dvander@560: * @param ... Format arguments.
dvander@560: * @noreturn
dvander@560: * @error Always!
dvander@560: */
ds@634: native ThrowError(const String:fmt[], any:...);
dvander@560:
dvander@536: /**
dvander@1378: * Logs a plugin message to the SourceMod logs. The log message will be
dvander@1378: * prefixed by the plugin's logtag (filename).
dvander@429: *
ds@475: * @param format String format.
ds@475: * @param ... Format arguments.
dvander@429: * @noreturn
dvander@429: */
ds@634: native LogMessage(const String:format[], any:...);
dvander@429:
dvander@429: /**
dvander@1378: * Logs a message to the SourceMod logs without any plugin logtag. This is
dvander@1378: * useful for re-routing messages from other plugins, for example, messages
dvander@1378: * from LogAction().
dvander@1378: *
dvander@1378: * @param format String format.
dvander@1378: * @param ... Format arguments.
dvander@1378: * @noreturn
dvander@1378: */
dvander@1378: native LogMessageEx(const String:format[], any:...);
dvander@1378:
dvander@1378: /**
dvander@1378: * Logs a message to any file. The log message will be in the normal
dvander@1378: * SourceMod format, with the plugin logtag prepended.
dvander@1378: *
dvander@1378: * @param file File to write the log message in.
dvander@1378: * @param format String format.
dvander@1378: * @param ... Format arguments.
dvander@1378: * @noreturn
dvander@1378: * @error File could not be opened/written.
dvander@1378: */
dvander@1378: native LogToFile(const String:file[], const String:format[], any:...);
dvander@1378:
dvander@1378: /**
dvander@1378: * Same as LogToFile(), except no plugin logtag is prepended.
dvander@1378: *
dvander@1378: * @param file File to write the log message in.
dvander@1378: * @param format String format.
dvander@1378: * @param ... Format arguments.
dvander@1378: * @noreturn
dvander@1378: * @error File could not be opened/written.
dvander@1378: */
dvander@1378: native LogToFileEx(const String:file[], const String:format[], any:...);
dvander@1378:
dvander@1378: /**
dvander@1378: * Logs an action from a command or event whereby interception and routing may
dvander@1378: * be important. This is intended to be a logging version of ShowActivity().
dvander@1378: *
dvander@1378: * @param client Client performing the action, 0 for server, or -1 if not
dvander@1378: * applicable.
dvander@1378: * @param target Client being targetted, or -1 if not applicable.
dvander@1378: * @param message Message format.
dvander@1378: * @param ... Message formatting parameters.
dvander@1378: * @noreturn
dvander@1378: */
dvander@1378: native LogAction(client, target, const String:message[], any:...);
dvander@1378:
dvander@1378: /**
dvander@429: * Logs a plugin error message to the SourceMod logs.
dvander@429: *
ds@475: * @param format String format.
ds@475: * @param ... Format arguments.
dvander@429: * @noreturn
dvander@429: */
ds@634: native LogError(const String:format[], any:...);
dvander@460:
dvander@530: /**
dvander@595: * Gets the system time as a unix timestamp.
dvander@595: *
dvander@595: * @param bigStamp Optional array to store the 64bit timestamp in.
dvander@595: * @return 32bit timestamp (number of seconds since unix epoch).
dvander@595: */
dvander@595: native GetTime(bigStamp[2]={0,0});
dvander@595:
dvander@595: /**
dvander@1334: * Produces a date and/or time string value for a timestamp.
dvander@1334: *
dvander@1334: * See this URL for valid parameters:
dvander@1334: * http://opengroup.org/onlinepubs/007908799/xsh/strftime.html
faluco@1037: *
faluco@1037: * @param buffer Destination string buffer.
faluco@1037: * @param maxlength Maximum length of output string buffer.
faluco@1359: * @param format Formatting rules (passing NULL_STRING will use the rules defined in sm_datetime_format).
faluco@1041: * @param stamp Optional time stamp.
faluco@1037: * @noreturn
dvander@1334: * @error Buffer too small or invalid time format.
faluco@1037: */
faluco@1041: native FormatTime(String:buffer[], maxlength, const String:format[], stamp=-1);
faluco@1037:
faluco@1037: /**
faluco@703: * Loads a game config file.
faluco@703: *
faluco@703: * @param file File to load. The path must be relative to the 'gamedata' folder under the config folder
faluco@703: * and the extension should be omitted.
faluco@703: * @return A handle to the game config file or INVALID_HANDLE in failure.
faluco@703: */
faluco@703: native Handle:LoadGameConfigFile(const String:file[]);
faluco@703:
faluco@703: /**
faluco@703: * Returns an offset value.
faluco@703: *
faluco@703: * @param gc Game config handle.
faluco@703: * @param key Key to retrieve from the offset section.
faluco@703: * @return An offset, or -1 on failure.
faluco@703: */
faluco@703: native GameConfGetOffset(Handle:gc, const String:key[]);
faluco@703:
faluco@703: /**
faluco@703: * Gets the value of a key from the "Keys" section.
faluco@703: *
faluco@703: * @param gc Game config handle.
faluco@703: * @param key Key to retrieve from the Keys section.
faluco@703: * @param buffer Destination string buffer.
faluco@703: * @param maxlen Maximum length of output string buffer.
dvander@886: * @return True if key existed, false otherwise.
faluco@703: */
faluco@703: native bool:GameConfGetKeyValue(Handle:gc, const String:key[], String:buffer[], maxlen);
faluco@703:
dvander@886: /**
dvander@886: * Returns the operating system's "tick count," which is a number of
dvander@886: * milliseconds since the operating system loaded. This can be used
dvander@886: * for basic benchmarks.
dvander@886: *
dvander@886: * @return Tick count in milliseconds.
dvander@886: */
dvander@886: native GetSysTickCount();
dvander@886:
dvander@978: /**
dvander@978: * Specifies that the given config file should be executed after plugin load.
dvander@978: * OnConfigsExecuted() will not be called until the config file has executed,
dvander@978: * but it will be called if the execution fails.
dvander@978: *
dvander@978: * @param autoCreate If true, and the config file does not exist, such a config
dvander@978: * file will be automatically created and populated with
dvander@978: * information from the plugin's registered cvars.
dvander@978: * @param name Name of the config file, excluding the .cfg extension.
dvander@978: * If empty, is assumed.
dvander@978: * @param folder Folder under cfg/ to use. By default this is "sourcemod."
dvander@978: * @noreturn
dvander@978: */
dvander@978: native AutoExecConfig(bool:autoCreate=true, const String:name[]="", const String:folder[]="sourcemod");
dvander@978:
faluco@1112: /**
faluco@1112: * Sets a native as optional, such that if it is unloaded, removed,
faluco@1112: * or otherwise non-existent, the plugin will still work. Calling
faluco@1112: * removed natives results in a run-time error.
faluco@1112: *
faluco@1112: * @param name Native name.
faluco@1112: * @noreturn
faluco@1112: */
faluco@1112: native MarkNativeAsOptional(const String:name[]);
faluco@1112:
faluco@1112: /**
faluco@1112: * Registers a library name for identifying as a dependency to
faluco@1112: * other plugins.
faluco@1112: *
faluco@1112: * @param name Library name.
faluco@1112: * @noreturn
faluco@1112: */
faluco@1112: native RegPluginLibrary(const String:name[]);
faluco@1112:
dvander@1124: /**
dvander@1573: * Returns whether a library exists. This function should be considered
dvander@1573: * expensive; it should only be called on plugin to determine availability
dvander@1573: * of resources. Use OnLibraryAdded()/OnLibraryRemoved() to detect changes
dvander@1573: * in optional resources.
dvander@1124: *
dvander@1573: * @param name Library name of a plugin or extension.
dvander@1124: * @return True if exists, false otherwise.
dvander@1124: */
dvander@1124: native bool:LibraryExists(const String:name[]);
dvander@1124:
dvander@1124: /**
dvander@1419: * Returns the status of an extension, by filename.
dvander@1419: *
dvander@1419: * @param name Extension name (like "sdktools.ext").
dvander@1419: * @param error Optional error message buffer.
dvander@1419: * @param maxlength Length of optional error message buffer.
dvander@1419: * @return -2 if the extension was not found.
dvander@1419: * -1 if the extension was found but failed to load.
dvander@1419: * 0 if the extension loaded but reported an error.
dvander@1419: * 1 if the extension is running without error.
dvander@1419: */
dvander@1419: native GetExtensionFileStatus(const String:name[], String:error[]="", maxlength=0);
dvander@1419:
dvander@1419: /**
dvander@1572: * Called after a library is added that the current plugin references
dvander@1572: * optionally. A library is either a plugin name or extension name, as
dvander@1572: * exposed via its include file.
dvander@1124: *
dvander@1124: * @param name Library name.
dvander@1124: */
dvander@1124: forward OnLibraryAdded(const String:name[]);
dvander@1124:
dvander@1124: /**
dvander@1572: * Called right before a library is removed that the current plugin references
dvander@1572: * optionally. A library is either a plugin name or extension name, as
dvander@1572: * exposed via its include file.
dvander@1124: *
dvander@1124: * @param name Library name.
dvander@1124: */
dvander@1124: forward OnLibraryRemoved(const String:name[]);
dvander@1124:
dvander@1738: #define MAPLIST_FLAG_MAPSFOLDER (1<<0) /**< On failure, use all maps in the maps folder. */
dvander@1738: #define MAPLIST_FLAG_CLEARARRAY (1<<1) /**< If an input array is specified, clear it before adding. */
dvander@1738: #define MAPLIST_FLAG_NO_DEFAULT (1<<2) /**< Do not read "default" or "mapcyclefile" on failure. */
dvander@1738:
dvander@1738: /**
dvander@1738: * Loads a map list to an ADT Array.
dvander@1738: *
dvander@1738: * A map list is a list of maps from a file. SourceMod allows easy configuration of
dvander@1738: * maplists through addons/sourcemod/configs/maplists.cfg. Each entry is given a
dvander@1738: * name and a file (for example, "rtv" => "rtv.cfg"), or a name and a redirection
dvander@1738: * (for example, "rtv" => "default"). This native will read a map list entry,
dvander@1738: * cache the file, and return the list of maps it holds.
dvander@1738: *
dvander@1738: * Serial change numbers are used to identify if a map list has changed. Thus, if
dvander@1738: * you pass a serial change number and it's equal to what SourceMod currently knows
dvander@1738: * about the map list, then SourceMod won't reparse the file.
dvander@1738: *
dvander@1738: * If the maps end up being read from the maps folder (MAPLIST_FLAG_MAPSFOLDER), they
dvander@1738: * are automatically sorted in alphabetical, ascending order.
dvander@1738: *
dvander@1739: * Arrays created by this function are temporary and must be freed via CloseHandle().
dvander@1739: * Modifying arrays created by this function will not affect future return values or
dvander@1739: * or the contents of arrays returned to other plugins.
dvander@1739: *
dvander@1738: * @param array Array to store the map list. If INVALID_HANDLE, a new blank
dvander@1738: * array will be created. The blocksize should be at least 16;
dvander@1738: * otherwise results may be truncated. Items are added to the array
dvander@1738: * as strings. The array is never checked for duplicates, and it is
dvander@1738: * not read beforehand. Only the serial number is used to detect
dvander@1738: * changes.
dvander@1772: * @param serial Serial number to identify last known map list change. If -1, the
dvander@1772: * the value will not be checked. If the map list has since changed,
dvander@1772: * the serial is updated (even if -1 was passed). If there is an error
dvander@1772: * finding a valid maplist, then the serial is set to -1.
dvander@1738: * @param str Config name, or "default" for the default map list. Config names
dvander@1738: * should be somewhat descriptive. For example, the admin menu uses
dvander@1738: * a config name of "admin menu". The list names can be configured
dvander@1738: * by users in addons/sourcemod/configs/maplists.cfg.
dvander@1738: * @param flags MAPLIST_FLAG flags.
dvander@1738: * @return On failure:
dvander@1738: * INVALID_HANDLE is returned, the serial is set to -1, and the input
dvander@1738: * array (if any) is left unchanged.
dvander@1738: * On no change:
dvander@1738: INVALID_HANDLE is returned, the serial is unchanged, and the input
dvander@1738: array (if any) is left unchanged.
dvander@1738: * On success:
dvander@1738: * A valid array Handle is returned, containing at least one map string.
dvander@1738: * If an array was passed, the return value is equal to the passed Array
dvander@1738: * Handle. If the passed array was not cleared, it will have grown by at
dvander@1738: * least one item. The serial number is updated to a positive number.
dvander@1738: * @error Invalid array Handle that is not INVALID_HANDLE.
dvander@1738: */
dvander@1738: native Handle:ReadMapList(Handle:array=INVALID_HANDLE,
dvander@1738: &serial=-1,
dvander@1738: const String:str[]="default",
dvander@1738: flags=MAPLIST_FLAG_CLEARARRAY);
dvander@1738:
dvander@1738: /**
dvander@1738: * Makes a compatibility binding for map lists. For example, if a function previously used
dvander@1738: * "clam.cfg" for map lists, this function will insert a "fake" binding to "clam.cfg" that
dvander@1738: * will be overridden if it's in the maplists.cfg file.
dvander@1738: *
dvander@1738: * @param name Configuration name that would be used with ReadMapList().
dvander@1738: * @param file Default file to use.
dvander@1738: * @noreturn
dvander@1738: */
dvander@1738: native SetMapListCompatBind(const String:name[], const String:file[]);
dvander@1738:
dvander@460: #include
dvander@560: #include
ferret99gt@1800: #include
dvander@1419: