Rewrote user message caching code to always use IServerGameDLL::GetUserMessageInfo (
bug 4117, r=dvander).
Games where the above function can crash are handled by detouring tier0's Error() function and jumping back to our own code. So in theory this should work on all games now.
2 * vim: set ts=4 sw=4 tw=99 noet :
3 * ======================================================
5 * Copyright (C) 2004-2009 AlliedModders LLC and authors.
7 * ======================================================
9 * This software is provided 'as-is', without any express or implied warranty.
10 * In no event will the authors be held liable for any damages arising from
11 * the use of this software.
13 * Permission is granted to anyone to use this software for any purpose,
14 * including commercial applications, and to alter it and redistribute it
15 * freely, subject to the following restrictions:
17 * 1. The origin of this software must not be misrepresented; you must not
18 * claim that you wrote the original software. If you use this software in a
19 * product, an acknowledgment in the product documentation would be
20 * appreciated but is not required.
21 * 2. Altered source versions must be plainly marked as such, and must not be
22 * misrepresented as being the original software.
23 * 3. This notice may not be removed or altered from any source distribution.
26 #ifndef _INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_
27 #define _INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_
32 * @file ISmmPluginExt.h Provides an alternate method for loading plugins,
33 * without needing to include the default headers and all their Half-Life baggage.
35 * @brief Definitions for extended plugin loading.
38 #define SOURCE_ENGINE_UNKNOWN 0 /**< Could not determine the engine version */
39 #define SOURCE_ENGINE_ORIGINAL 1 /**< Original Source Engine (used by The Ship) */
40 #define SOURCE_ENGINE_EPISODEONE 2 /**< Episode 1 Source Engine (second major SDK) */
41 #define SOURCE_ENGINE_ORANGEBOX 3 /**< Orange Box Source Engine (third major SDK) */
42 #define SOURCE_ENGINE_LEFT4DEAD 4 /**< Left 4 Dead */
43 #define SOURCE_ENGINE_DARKMESSIAH 5 /**< Dark Messiah Multiplayer (based on original engine) */
44 #define SOURCE_ENGINE_ORANGEBOXVALVE 6 /**< Orange Box Source Engine for Valve games (TF2/DOD:S) */
45 #define SOURCE_ENGINE_LEFT4DEAD2 7 /**< Left 4 Dead 2 */
47 #define METAMOD_PLAPI_VERSION 15 /**< Version of this header file */
48 #define METAMOD_PLAPI_NAME "ISmmPlugin" /**< Name of the plugin interface */
56 * @brief Used to uniquely identify plugins.
60 #define METAMOD_FAIL_API_V1 7 /**< Minimum API version to detect for V1 */
61 #define METAMOD_FAIL_API_V2 14 /**< Minimum API version to detect for V2 */
64 * Use this to instantiate a plugin that will always fail.
65 * This class definition works against major API versions 1 and 2.
71 * @brief You must return METAMOD_FAIL_API_V1 or METAMOD_FAIL_API_V2 here,
72 * depending on which Metamod:Source version you detected.
74 virtual int GetApiVersion() = 0;
77 * @brief Do not change.
79 virtual ~ISmmFailPlugin()
84 * @brief Return false here -- fill in the error buffer appropriately.
86 * Do not ever return true. If you do, MM:S will crash because the class layout is
87 * incomplete against ISmmPlugin.
91 * @param error Error buffer (must be filled).
92 * @param maxlength Maximum size of error buffer.
94 * @return Must return false.
96 virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late) =0;
100 typedef SourceMM::ISmmPlugin METAMOD_PLUGIN;
103 * @brief Contains version information.
105 struct MetamodVersionInfo
107 int api_major; /**< ISmmAPI major version */
108 int api_minor; /**< ISmmAPI minor version */
109 int sh_iface; /**< SourceHook interface version */
110 int sh_impl; /**< SourceHook implementation version */
111 int pl_min; /**< Plugin API minimum version */
112 int pl_max; /**< Plugin API maximum version */
113 int source_engine; /**< Source Engine version (SOURCE_* constants) */
114 const char *game_dir; /**< Game directory name */
117 * @brief Returns the game folder.
119 * @return Game folder, or NULL if not available on this version
122 inline const char *GetGameDir() const
131 * @brief Contains information about loading a plugin.
133 struct MetamodLoaderInfo
135 const char *pl_file; /**< File path to the plugin being loaded. */
136 const char *pl_path; /**< Folder path containing the plugin. */
140 * @brief If a function of this type is exposed as "CreateInterface_MMS", then
141 * Metamod:Source will attempt to call this function before calling
142 * CreateInterface. If this function returns a valid ISmmPlugin pointer, then
143 * CreateInterface will not be called.
145 * This is useful for implementing a mini-loader plugin for multiple versions.
147 * @param mvi MetamodVersionInfo structure.
148 * @param mli MetamodLoaderInfo structure.
149 * @return ISmmAPI pointer, or NULL if none.
151 typedef METAMOD_PLUGIN *(*METAMOD_FN_LOAD)(const MetamodVersionInfo *mvi,
152 const MetamodLoaderInfo *mli);
155 * @brief If a function of this type is exposed as "UnloadInterface_MMS", then
156 * Metamod:Source will attempt to call this function after calling
157 * ISmmAPI::Unload(), and before closing the library. This lets loader plugins
158 * clean up before exiting.
160 * Note: This function will be ignored unless CreateInterfce_MMS was exposed.
161 * It may be called even if ISmmAPI::Unload() could not be called.
163 typedef void (*METAMOD_FN_UNLOAD)();
166 * @brief Original type of load function. CreateInterfaceFn from Valve.
168 * Plugins will expose this as "CreateInterface".
170 typedef void *(*METAMOD_FN_ORIG_LOAD)(const char *, int *);
172 #endif //INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_