dvander@398: /** dvander@398: * vim: set ts=4 : dvander@398: * ====================================================== dvander@398: * Metamod:Source dvander@398: * Copyright (C) 2004-2007 AlliedModders LLC and authors. dvander@398: * All rights reserved. dvander@398: * ====================================================== dvander@398: * dvander@398: * This software is provided 'as-is', without any express or implied warranty. dvander@398: * In no event will the authors be held liable for any damages arising from dvander@398: * the use of this software. dvander@398: * dvander@398: * Permission is granted to anyone to use this software for any purpose, dvander@398: * including commercial applications, and to alter it and redistribute it dvander@398: * freely, subject to the following restrictions: dvander@398: * dvander@398: * 1. The origin of this software must not be misrepresented; you must not dvander@398: * claim that you wrote the original software. If you use this software in a dvander@398: * product, an acknowledgment in the product documentation would be dvander@398: * appreciated but is not required. dvander@398: * 2. Altered source versions must be plainly marked as such, and must not be dvander@398: * misrepresented as being the original software. dvander@398: * 3. This notice may not be removed or altered from any source distribution. dvander@398: * dvander@398: * Version: $Id$ dvander@398: */ dvander@398: dvander@398: #ifndef _INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_ dvander@405: #define _INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_ dvander@405: dvander@405: #define SOURCE_ENGINE_UNKNOWN 0 /**< Could not determine the engine version */ dvander@405: #define SOURCE_ENGINE_ORIGINAL 1 /**< Original Source Engine (used by The Ship) */ dvander@405: #define SOURCE_ENGINE_EPISODEONE 2 /**< Episode 1 Source Engine (second major SDK) */ dvander@405: #define SOURCE_ENGINE_ORANGEBOX 3 /**< Orange Box Source Engine (third major SDK) */ dvander@405: dvander@405: #define METAMOD_PLAPI_VERSION 14 /**< Version of this header file */ dvander@405: #define METAMOD_PLAPI_NAME "ISmmPlugin" /**< Name of the plugin interface */ dvander@398: dvander@398: namespace SourceMM dvander@398: { dvander@400: class ISmmPlugin; dvander@398: } dvander@398: dvander@400: typedef SourceMM::ISmmPlugin METAMOD_PLUGIN; dvander@400: dvander@398: /** dvander@398: * @file ISmmPluginExt.h Definitions for extended plugin exposure syntax. dvander@398: * @brief Provides an alternate method for loading plugins, without needing to dvander@398: * include the default headers and all their Half-Life baggage. dvander@398: */ dvander@398: dvander@398: /** dvander@398: * @brief Contains version information. dvander@398: */ dvander@398: struct MetamodVersionInfo dvander@398: { dvander@398: int api_major; /**< ISmmAPI major version */ dvander@398: int api_minor; /**< ISmmAPI minor version */ dvander@398: int sh_iface; /**< SourceHook interface version */ dvander@398: int sh_impl; /**< SourceHook implementation version */ dvander@398: int pl_min; /**< Plugin API minimum version */ dvander@398: int pl_max; /**< Plugin API maximum version */ dvander@398: int source_engine; /**< Source Engine version (SOURCE_* constants) */ dvander@398: }; dvander@398: dvander@398: /** dvander@398: * @brief Contains information about loading a plugin. dvander@398: */ dvander@398: struct MetamodLoaderInfo dvander@398: { dvander@398: const char *pl_file; /**< File path to the plugin being loaded. */ dvander@398: const char *pl_path; /**< Folder path containing the plugin. */ dvander@398: }; dvander@398: dvander@398: /** dvander@398: * @brief If a function of this type is exposed as "CreateInterface_MMS", then dvander@398: * Metamod:Source will attempt to call this function before calling dvander@398: * CreateInterface. If this function returns a valid ISmmPlugin pointer, then dvander@398: * CreateInterface will not be called. dvander@398: * dvander@398: * This is useful for implementing a mini-loader plugin for multiple versions. dvander@398: * dvander@398: * @param mvi MetamodVersionInfo structure. dvander@398: * @param mli MetamodLoaderInfo structure. dvander@398: * @return ISmmAPI pointer, or NULL if none. dvander@398: */ dvander@400: typedef METAMOD_PLUGIN *(*METAMOD_FN_LOAD)(const MetamodVersionInfo *mvi, dvander@400: const MetamodLoaderInfo *mli); dvander@398: dvander@398: /** dvander@398: * @brief If a function of this type is exposed as "UnloadInterface_MMS", then dvander@398: * Metamod:Source will attempt to call this function after calling dvander@398: * ISmmAPI::Unload(), and before closing the library. This lets loader plugins dvander@398: * clean up before exiting. dvander@400: * dvander@400: * Note: This function will be ignored unless CreateInterfce_MMS was exposed. dvander@400: * It may be called even if ISmmAPI::Unload() could not be called. dvander@398: */ dvander@398: typedef void (*METAMOD_FN_UNLOAD)(); dvander@398: dvander@406: /** dvander@406: * @brief Original type of load function. CreateInterfaceFn from Valve. dvander@406: * dvander@406: * Plugins will expose this as "CreateInterface". dvander@406: */ dvander@406: typedef void *(*METAMOD_FN_ORIG_LOAD)(const char *, int *); dvander@406: dvander@398: #endif //INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_ dvander@398: