3 * ======================================================
5 * Copyright (C) 2004-2008 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.
28 #ifndef _INCLUDE_ISMM_API_H
29 #define _INCLUDE_ISMM_API_H
32 * @brief Core API calls that are provided to plugins.
37 #include <sourcehook.h>
38 #include <IPluginManager.h>
40 #if defined META_NO_HL2SDK
42 class IServerPluginCallbacks;
49 #include <ISmmPlugin.h>
50 #include <ISmmPluginExt.h>
53 #if ((__GNUC__ == 3) && (__GNUC_MINOR__ < 4)) || (__GNUC__ < 3)
54 #error "You must compile with at least GCC 3.4! If you know what you are doing, you can remove this message."
55 #endif //version check
58 #define MMIFACE_SOURCEHOOK "ISourceHook" /**< ISourceHook Pointer */
59 #define MMIFACE_PLMANAGER "IPluginManager" /**< SourceMM Plugin Functions */
60 #define MMIFACE_SH_HOOKMANAUTOGEN "IHookManagerAutoGen" /**< SourceHook::IHookManagerAutoGen Pointer */
61 #define IFACE_MAXNUM 999 /**< Maximum interface version */
63 typedef void* (*CreateInterfaceFn)(const char *pName, int *pReturnCode);
68 class IMetamodListener;
71 * The core API that Metamod:Source provides to plugins.
77 * @brief Logs a message through the HL2 log system.
78 * Note: Newlines are appended automatically.
80 * @param pl Plugin API pointer (used for tagging message)
81 * @param msg Formatted string.
83 virtual void LogMsg(ISmmPlugin *pl, const char *msg, ...) =0;
86 * @brief Returns an interface factory for the HL2 engine.
88 * @param syn If syn is true, the synthetic wrapper is returned.
89 * If syn is false, the true function is returned.
90 * @return CreateInterfaceFn function pointer.
92 virtual CreateInterfaceFn GetEngineFactory(bool syn=true) =0;
95 * @brief Returns an interface factory for the HL2 physics engine.
97 * @param syn If syn is true, the synthetic wrapper is returned.
98 * If syn is false, the true function is returned.
99 * @return CreateInterfaceFn function pointer.
101 virtual CreateInterfaceFn GetPhysicsFactory(bool syn=true) =0;
104 * @brief Returns an interface factory for the HL2 file system.
106 * @param syn If syn is true, the synthetic wrapper is returned.
107 * If syn is false, the true function is returned.
108 * @return CreateInterfaceFn function pointer.
110 virtual CreateInterfaceFn GetFileSystemFactory(bool syn=true) =0;
113 * @brief Returns an interface factory for the GameDLL.
115 * If syn is false, the true function is returned.
116 * @return CreateInterfaceFn function pointer.
118 virtual CreateInterfaceFn GetServerFactory(bool syn=true) =0;
121 * @brief Returns a CGlobalVars pointer from the HL2 Engine.
123 * @return CGlobalVars pointer.
125 virtual CGlobalVars *GetCGlobals() =0;
128 * @brief Registers a ConCommandBase.
130 * @param plugin Parent plugin API pointer.
131 * @param pCommand ConCommandBase to register.
132 * @return True if successful, false otherwise.
134 virtual bool RegisterConCommandBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0;
137 * @brief Unregisters a ConCommandBase.
139 * @param plugin Parent plugin API pointer.
140 * @param pCommand ConCommandBase to unlink.
142 virtual void UnregisterConCommandBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0;
145 * @brief Prints an unformatted string to the remote server console.
147 * Note: Newlines are not added automatically.
149 * @param str Message string.
151 virtual void ConPrint(const char *str) =0;
154 * @brief Prints a formatted message to the remote server console.
156 * Note: Newlines are not added automatically.
158 * @param fmt Formatted message.
160 virtual void ConPrintf(const char *fmt, ...) =0;
163 * @brief Returns the Metamod Version numbers as major version and
164 * minor (API) version. Changes to minor version are guaranteed to be
165 * backwards compatible. Changes to major version are not.
167 * @param major Filled with the major API version number.
168 * @param minor Filled with the minor API version number.
169 * @param plvers Filled with the current plugin API version number.
170 * @param plmin Filled with the minimum plugin API version number
173 virtual void GetApiVersions(int &major, int &minor, int &plvers, int &plmin) =0;
176 * @brief Returns sourcehook API version and implementation version.
178 * @param shvers Filled with the SourceHook API version number.
179 * @param shimpl Filled with the SourceHook implementation number.
181 virtual void GetShVersions(int &shvers, int &shimpl) =0;
184 * @brief Adds a Metamod listener.
186 * @param plugin Plugin interface pointer.
187 * @param pListener Listener interface pointer to add.
189 virtual void AddListener(ISmmPlugin *plugin, IMetamodListener *pListener) =0;
192 * @brief Queries the metamod factory
194 * @param iface String containing interface name
195 * @param ret Optional pointer to store return status
196 * @param id Optional pointer to store id of plugin that
197 * overrode interface, 0 if none
198 * @return Returned pointer
200 virtual void *MetaFactory(const char *iface, int *ret, PluginId *id) =0;
203 * @brief Given a base interface name, such as ServerGameDLL or
204 * ServerGameDLL003, reformats the string to increase the number, then
205 * returns the new number. This is the base function to InterfaceSearch()
206 * and VInterfaceMatch().
208 * @param iface Input/output interface name. Must be writable.
209 * @param maxlength Maximum length of iface buffer. Must be at least
210 * strlen(iface)+4 chars.
211 * @return The newly incremented iface version number.
212 * @deprecated Use InterfaceSearch() or VInterfaceMatch instead.
214 virtual int FormatIface(char iface[], unsigned int maxlength) =0;
217 * @brief Searches for an interface, eliminating the need to loop
218 * through FormatIface().
220 * @param fn InterfaceFactory function.
221 * @param iface Interface string name.
222 * @param max Maximum version to look up.
223 * @param ret Last return code from interface factory function.
224 * @return Interface pointer, or NULL if not found.
226 virtual void *InterfaceSearch(CreateInterfaceFn fn,
232 * @brief Returns the base directory of the game/server, equivalent to
233 * IVEngineServer::GetGameDir(), except the path is absolute.
235 * @return Static pointer to game's absolute basedir.
237 virtual const char *GetBaseDir() =0;
240 * @brief Formats a file path to the local OS.
242 * Does not include any base directories. Note that all slashes and
243 * black slashes are reverted to the local OS's expectancy.
245 * @param buffer Destination buffer to store path.
246 * @param len Maximum length of buffer, including null
248 * @param fmt Formatted string.
249 * @param ... Arguments in the string.
250 * @return Number of bytes written, not including the null
253 virtual size_t PathFormat(char *buffer, size_t len, const char *fmt, ...) =0;
256 * @brief Prints text in the specified client's console. Same as
257 * IVEngineServer::ClientPrintf except that it allows for string
260 * @param client Client edict pointer.
261 * @param fmt Formatted string to print to the client.
263 virtual void ClientConPrintf(edict_t *client, const char *fmt, ...) =0;
266 * @brief Wrapper around InterfaceSearch(). Assumes no maximum.
267 * This is designed to replace the fact that searches only went upwards.
268 * The "V" is intended to convey that this is for Valve formatted
271 * @param fn Interface factory function.
272 * @param iface Interface string.
273 * @param min Minimum value to search from. If zero, searching
274 * begins from the first available version regardless
275 * of the interface. Note that this can return
276 * interfaces EARLIER than the version specified. A
277 * value of -1 (default) specifies the string version
278 * as the minimum. Any other value specifices the
279 * minimum value to search from.
280 * @return Interface pointer, or NULL if not found.
282 virtual void *VInterfaceMatch(CreateInterfaceFn fn,
287 * @brief Tells SourceMM to add VSP hooking capability to plugins.
289 * Since this potentially uses more resources than it would otherwise,
290 * plugins have to explicitly enable the feature. Whether requested or
291 * not, if it is enabled, all plugins will get a pointer to the VSP
292 * listener through IMetamodListener. This will not be called more than
293 * once for a given plugin; if it is requested more than once, each
294 * successive call will only give the pointer to plugins which have not
297 virtual void EnableVSPListener() =0;
300 * @brief Returns the interface version of the GameDLL's IServerGameDLL
303 * @return Interface version of the loaded IServerGameDLL.
305 virtual int GetGameDLLVersion() =0;
308 * @brief Returns the number of user messages in the GameDLL.
310 * @return Number of user messages, or -1 if SourceMM has
311 * failed to get user message list.
313 virtual int GetUserMessageCount() =0;
316 * @brief Returns the index of the specified user message.
318 * @param name User message name.
319 * @param size Optional pointer to store size of user message.
320 * @return Message index, or -1 on failure.
322 virtual int FindUserMessage(const char *name, int *size=NULL) =0;
325 * @brief Returns the name of the specified user message.
327 * @param index User message index.
328 * @param size Optional pointer to store size of user message.
329 * @return Message name, or NULL on failure.
331 virtual const char *GetUserMessage(int index, int *size=NULL) =0;
334 * @brief Returns the highest interface version of IServerPluginCallbacks
335 * that the engine supports. This is useful for games that run on older
336 * versions of the Source engine, such as The Ship.
338 * @return Highest interface version of IServerPluginCallbacks.
339 * Returns 0 if SourceMM's VSP listener isn't
341 * @deprecated Use GetVSPInfo() instead.
343 virtual int GetVSPVersion() =0;
346 * @brief Returns the engine interface that MM:S is using as a backend.
348 * The values will be one of the SOURCE_ENGINE_* constants from the top
351 * @return A SOURCE_ENGINE_* constant value.
353 virtual int GetSourceEngineBuild() =0;
356 * @brief Returns the VSP listener loaded.
358 * This is useful for late-loading plugins which need to decide whether
359 * to add a listener or not (or need to get the pointer at all).
361 * @param pVersion Optional pointer to store the VSP version.
362 * @return IServerPluginCallbacks pointer, or NULL if an
363 * IMetamodListener event has yet to occur for
364 * EnableVSPListener().
366 virtual IServerPluginCallbacks *GetVSPInfo(int *pVersion) =0;
369 * @brief Formats a string. This is a platform safe wrapper around
370 * snprintf/_snprintf.
372 * @param buffer Buffer to write to.
373 * @param maxlength Maximum length of the buffer.
374 * @param format Format specifiers.
375 * @param ... Format arguments.
376 * @return Number of bytes actually written, not including
377 * the null terminator.
379 virtual size_t Format(char *buffer,
385 * @brief Formats a string. This is a platform safe wrapper around
386 * vsnprintf/_vsnprintf.
388 * @param buffer Buffer to write to.
389 * @param maxlength Maximum length of the buffer.
390 * @param format Format specifiers.
391 * @param ap Format argument list.
392 * @return Number of bytes actually written, not including the
395 virtual size_t FormatArgs(char *buffer,
402 #if !defined METAMOD_NO_AUTO_NAMESPACE
403 using namespace SourceMM;
409 * 1.1.0 Bumped API to 1:0. The breaking changes occurred in SourceHook and the plugin API.
410 * 1.1.2 Added API call for generating iface names.
411 * 1.2 Added API more helper functions and new SourceHook version.
412 * 1.2.2 Added API for printing to client console (with string formatting).
413 * 1.3 Added new interface search API.
414 * 1.4 Added VSP listener and user message API.
415 * 1.5.0 Added API for getting highest supported version of IServerPluginCallbacks.
416 * 1.6.0 Added API for Orange Box. Broke backwards compatibility.
419 #endif //_INCLUDE_ISMM_API_H