dvander@513: /* ds@669: * vim: set ts=4 sw=4 tw=99 noet : dvander@513: * ====================================================== dvander@513: * Metamod:Source ds@669: * Copyright (C) 2004-2009 AlliedModders LLC and authors. dvander@513: * All rights reserved. dvander@513: * ====================================================== dvander@513: * dvander@513: * This software is provided 'as-is', without any express or implied warranty. dvander@513: * In no event will the authors be held liable for any damages arising from dvander@513: * the use of this software. dvander@513: * dvander@513: * Permission is granted to anyone to use this software for any purpose, dvander@513: * including commercial applications, and to alter it and redistribute it dvander@513: * freely, subject to the following restrictions: dvander@513: * dvander@513: * 1. The origin of this software must not be misrepresented; you must not dvander@513: * claim that you wrote the original software. If you use this software in a dvander@513: * product, an acknowledgment in the product documentation would be dvander@513: * appreciated but is not required. dvander@513: * 2. Altered source versions must be plainly marked as such, and must not be dvander@513: * misrepresented as being the original software. dvander@513: * 3. This notice may not be removed or altered from any source distribution. dvander@513: */ dvander@513: dvander@513: #ifndef _INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_ dvander@513: #define _INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_ dvander@513: dvander@513: #include dvander@513: asherkin@790: // Interface return status, binary-compatible with HL2SDK's IFACE_OK and IFACE_FAILED. asherkin@790: enum asherkin@790: { asherkin@790: META_IFACE_OK = 0, asherkin@790: META_IFACE_FAILED asherkin@790: }; asherkin@790: dvander@513: /** dvander@513: * @file ISmmPluginExt.h Provides an alternate method for loading plugins, dvander@513: * without needing to include the default headers and all their Half-Life baggage. dvander@513: * dvander@513: * @brief Definitions for extended plugin loading. dvander@513: */ dvander@513: dvander@513: #define SOURCE_ENGINE_UNKNOWN 0 /**< Could not determine the engine version */ dvander@513: #define SOURCE_ENGINE_ORIGINAL 1 /**< Original Source Engine (used by The Ship) */ dvander@513: #define SOURCE_ENGINE_EPISODEONE 2 /**< Episode 1 Source Engine (second major SDK) */ dvander@513: #define SOURCE_ENGINE_ORANGEBOX 3 /**< Orange Box Source Engine (third major SDK) */ ds@537: #define SOURCE_ENGINE_LEFT4DEAD 4 /**< Left 4 Dead */ ds@637: #define SOURCE_ENGINE_DARKMESSIAH 5 /**< Dark Messiah Multiplayer (based on original engine) */ skamonkey@850: #define SOURCE_ENGINE_ORANGEBOXVALVE_DEPRECATED 6 /**< Orange Box Source Engine for Valve games (TF2/DOD:S/HL2DM) */ skamonkey@793: #define SOURCE_ENGINE_LEFT4DEAD2 7 /**< Left 4 Dead 2 */ skamonkey@793: #define SOURCE_ENGINE_ALIENSWARM 8 /**< Alien Swarm */ skamonkey@793: #define SOURCE_ENGINE_BLOODYGOODTIME 9 /**< Bloody Good Time */ skamonkey@793: #define SOURCE_ENGINE_EYE 10 /**< E.Y.E Divine Cybermancy */ skamonkey@793: #define SOURCE_ENGINE_PORTAL2 11 /**< Portal 2 */ skamonkey@793: #define SOURCE_ENGINE_CSGO 12 /**< Counter-Strike: Global Offensive */ skamonkey@793: #define SOURCE_ENGINE_CSS 13 /**< Counter-Strike: Source (sometimes older version of Orange Box Valve) */ skamonkey@818: #define SOURCE_ENGINE_DOTA 14 /**< Dota 2 */ skamonkey@850: #define SOURCE_ENGINE_HL2DM 15 /**< Half-Life 2 Deathmatch */ skamonkey@850: #define SOURCE_ENGINE_DODS 16 /**< Day of Defeat: Source */ skamonkey@850: #define SOURCE_ENGINE_TF2 17 /**< Team Fortress 2 */ skamonkey@850: #define SOURCE_ENGINE_NUCLEARDAWN 18 /**< Nuclear Dawn */ skamonkey@856: #define SOURCE_ENGINE_SDK2013 19 /**< Source SDK 2013 */ skamonkey@857: #define SOURCE_ENGINE_BLADE 20 /**< Blade Symphony */ skamonkey@858: #define SOURCE_ENGINE_INSURGENCY 21 /**< Insurgency */ skamonkey@909: #define SOURCE_ENGINE_CONTAGION 22 /**< Contagion */ dvander@513: ds@674: #define METAMOD_PLAPI_VERSION 15 /**< Version of this header file */ dvander@513: #define METAMOD_PLAPI_NAME "ISmmPlugin" /**< Name of the plugin interface */ dvander@513: dvander@513: namespace SourceMM dvander@513: { dvander@513: class ISmmPlugin; dvander@513: class ISmmAPI; dvander@513: dvander@487: /** dvander@487: * @brief Used to uniquely identify plugins. dvander@487: */ dvander@513: typedef int PluginId; dvander@513: dvander@513: #define METAMOD_FAIL_API_V1 7 /**< Minimum API version to detect for V1 */ dvander@513: #define METAMOD_FAIL_API_V2 14 /**< Minimum API version to detect for V2 */ dvander@513: dvander@513: /** dvander@513: * Use this to instantiate a plugin that will always fail. dvander@513: * This class definition works against major API versions 1 and 2. dvander@513: */ dvander@513: class ISmmFailPlugin dvander@513: { dvander@513: public: dvander@513: /** dvander@513: * @brief You must return METAMOD_FAIL_API_V1 or METAMOD_FAIL_API_V2 here, dvander@513: * depending on which Metamod:Source version you detected. dvander@513: */ dvander@513: virtual int GetApiVersion() = 0; dvander@513: dvander@513: /** dvander@513: * @brief Do not change. dvander@513: */ dvander@513: virtual ~ISmmFailPlugin() dvander@513: { dvander@513: } dvander@513: dvander@513: /** dvander@513: * @brief Return false here -- fill in the error buffer appropriately. dvander@513: * dvander@513: * Do not ever return true. If you do, MM:S will crash because the class layout is dvander@513: * incomplete against ISmmPlugin. dvander@513: * dvander@513: * @param id Ignore. dvander@513: * @param ismm Ignore. dvander@513: * @param error Error buffer (must be filled). dvander@513: * @param maxlength Maximum size of error buffer. dvander@513: * @param late Ignore. dvander@513: * @return Must return false. dvander@513: */ dvander@513: virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late) =0; dvander@513: }; dvander@513: } dvander@513: dvander@513: typedef SourceMM::ISmmPlugin METAMOD_PLUGIN; dvander@513: dvander@513: /** dvander@513: * @brief Contains version information. dvander@513: */ dvander@513: struct MetamodVersionInfo dvander@513: { dvander@513: int api_major; /**< ISmmAPI major version */ dvander@513: int api_minor; /**< ISmmAPI minor version */ dvander@513: int sh_iface; /**< SourceHook interface version */ dvander@513: int sh_impl; /**< SourceHook implementation version */ dvander@513: int pl_min; /**< Plugin API minimum version */ dvander@513: int pl_max; /**< Plugin API maximum version */ dvander@513: int source_engine; /**< Source Engine version (SOURCE_* constants) */ ds@674: const char *game_dir; /**< Game directory name */ dvander@675: dvander@675: /** dvander@675: * @brief Returns the game folder. dvander@675: * dvander@675: * @return Game folder, or NULL if not available on this version dvander@675: * of Metamod:Source. dvander@675: */ dvander@675: inline const char *GetGameDir() const dvander@675: { skamonkey@855: if (pl_max < 15) dvander@675: return NULL; dvander@675: return game_dir; dvander@675: } dvander@513: }; dvander@513: dvander@513: /** dvander@513: * @brief Contains information about loading a plugin. dvander@513: */ dvander@513: struct MetamodLoaderInfo dvander@513: { dvander@513: const char *pl_file; /**< File path to the plugin being loaded. */ dvander@513: const char *pl_path; /**< Folder path containing the plugin. */ dvander@513: }; dvander@513: dvander@513: /** dvander@513: * @brief If a function of this type is exposed as "CreateInterface_MMS", then dvander@513: * Metamod:Source will attempt to call this function before calling dvander@513: * CreateInterface. If this function returns a valid ISmmPlugin pointer, then dvander@513: * CreateInterface will not be called. dvander@513: * dvander@513: * This is useful for implementing a mini-loader plugin for multiple versions. dvander@513: * dvander@513: * @param mvi MetamodVersionInfo structure. dvander@513: * @param mli MetamodLoaderInfo structure. dvander@513: * @return ISmmAPI pointer, or NULL if none. dvander@513: */ dvander@513: typedef METAMOD_PLUGIN *(*METAMOD_FN_LOAD)(const MetamodVersionInfo *mvi, dvander@513: const MetamodLoaderInfo *mli); dvander@513: dvander@513: /** dvander@513: * @brief If a function of this type is exposed as "UnloadInterface_MMS", then dvander@513: * Metamod:Source will attempt to call this function after calling dvander@513: * ISmmAPI::Unload(), and before closing the library. This lets loader plugins dvander@513: * clean up before exiting. dvander@513: * dvander@513: * Note: This function will be ignored unless CreateInterfce_MMS was exposed. dvander@513: * It may be called even if ISmmAPI::Unload() could not be called. dvander@513: */ dvander@513: typedef void (*METAMOD_FN_UNLOAD)(); dvander@513: dvander@513: /** dvander@513: * @brief Original type of load function. CreateInterfaceFn from Valve. dvander@513: * dvander@513: * Plugins will expose this as "CreateInterface". dvander@513: */ dvander@513: typedef void *(*METAMOD_FN_ORIG_LOAD)(const char *, int *); dvander@513: dvander@513: #endif //INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_ dvander@513: