3 * ======================================================
5 * Copyright (C) 2004-2007 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 External API interface
37 #include <interface.h>
39 #include <sourcehook.h>
40 #include <IPluginManager.h>
41 #include <ISmmPlugin.h>
44 #if ((__GNUC__ == 3) && (__GNUC_MINOR__ < 4)) || (__GNUC__ < 3)
45 #error "You must compile with at least GCC 3.4! If you know what you are doing, you can remove this message."
46 #endif //version check
49 #define MMIFACE_SOURCEHOOK "ISourceHook" /**< ISourceHook Pointer */
50 #define MMIFACE_PLMANAGER "IPluginManager" /**< SourceMM Plugin Functions */
51 #define IFACE_MAXNUM 999 /**< Maximum interface version */
53 #define SOURCE_ENGINE_UNKNOWN 0 /**< Could not determine the engine version */
54 #define SOURCE_ENGINE_ORIGINAL 1 /**< Original Source Engine (used by The Ship) */
55 #define SOURCE_ENGINE_EPISODEONE 2 /**< Episode 1 Source Engine (second major SDK) */
56 #define SOURCE_ENGINE_ORANGEBOX 3 /**< Orange Box Source Engine (third major SDK) */
61 class IMetamodListener;
67 * @brief Logs a message through the HL2 log system.
68 * Note: Newlines are appended automatically.
70 * @param pl Plugin API pointer (used for tagging message)
71 * @param msg Formatted string.
73 virtual void LogMsg(ISmmPlugin *pl, const char *msg, ...) =0;
76 * @brief Returns an interface factory for the HL2 engine.
78 * @param syn If syn is true, the synthetic wrapper is returned.
79 * If syn is false, the true function is returned.
80 * @return CreateInterfaceFn function pointer.
82 virtual CreateInterfaceFn GetEngineFactory(bool syn=true) =0;
85 * @brief Returns an interface factory for the HL2 physics engine.
87 * @param syn If syn is true, the synthetic wrapper is returned.
88 * If syn is false, the true function is returned.
89 * @return CreateInterfaceFn function pointer.
91 virtual CreateInterfaceFn GetPhysicsFactory(bool syn=true) =0;
94 * @brief Returns an interface factory for the HL2 file system.
96 * @param syn If syn is true, the synthetic wrapper is returned.
97 * If syn is false, the true function is returned.
98 * @return CreateInterfaceFn function pointer.
100 virtual CreateInterfaceFn GetFileSystemFactory(bool syn=true) =0;
103 * @brief Returns an interface factory for the GameDLL.
105 * If syn is false, the true function is returned.
106 * @return CreateInterfaceFn function pointer.
108 virtual CreateInterfaceFn GetServerFactory(bool syn=true) =0;
111 * @brief Returns a CGlobalVars pointer from the HL2 Engine.
113 * @return CGlobalVars pointer.
115 virtual CGlobalVars *GetCGlobals() =0;
118 * @brief Registers a ConCommandBase.
120 * @param plugin Parent plugin API pointer.
121 * @param pCommand ConCommandBase to register.
122 * @return True if successful, false otherwise.
124 virtual bool RegisterConCommandBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0;
127 * @brief Unregisters a ConCommandBase.
129 * @param plugin Parent plugin API pointer.
130 * @param pCommand ConCommandBase to unlink.
132 virtual void UnregisterConCommandBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0;
135 * @brief Prints an unformatted string to the remote server console.
137 * Note: Newlines are not added automatically.
139 * @param str Message string.
141 virtual void ConPrint(const char *str) =0;
144 * @brief Prints a formatted message to the remote server console.
146 * Note: Newlines are not added automatically.
148 * @param fmt Formatted message.
150 virtual void ConPrintf(const char *fmt, ...) =0;
153 * @brief Returns the Metamod Version numbers as major version and
154 * minor (API) version. Changes to minor version are guaranteed to be
155 * backwards compatible. Changes to major version are not.
157 * @param major Filled with the major API version number.
158 * @param minor Filled with the minor API version number.
159 * @param plvers Filled with the current plugin API version number.
160 * @param plmin Filled with the minimum plugin API version number
163 virtual void GetApiVersions(int &major, int &minor, int &plvers, int &plmin) =0;
166 * @brief Returns sourcehook API version and implementation version.
168 * @param shvers Filled with the SourceHook API version number.
169 * @param shimpl Filled with the SourceHook implementation number.
171 virtual void GetShVersions(int &shvers, int &shimpl) =0;
174 * @brief Adds a Metamod listener.
176 * @param plugin Plugin interface pointer.
177 * @param pListener Listener interface pointer to add.
179 virtual void AddListener(ISmmPlugin *plugin, IMetamodListener *pListener) =0;
182 * @brief Queries the metamod factory
184 * @param iface String containing interface name
185 * @param ret Optional pointer to store return status
186 * @param id Optional pointer to store id of plugin that
187 * overrode interface, 0 if none
188 * @return Returned pointer
190 virtual void *MetaFactory(const char *iface, int *ret, PluginId *id) =0;
193 * @brief Given a base interface name, such as ServerGameDLL or
194 * ServerGameDLL003, reformats the string to increase the number, then
195 * returns the new number. This is the base function to InterfaceSearch()
196 * and VInterfaceMatch().
198 * @param iface Input/output interface name. Must be writable.
199 * @param maxlength Maximum length of iface buffer. Must be at least
200 * strlen(iface)+4 chars.
201 * @return The newly incremented iface version number.
203 virtual int FormatIface(char iface[], unsigned int maxlength) =0;
206 * @brief Searches for an interface, eliminating the need to loop
207 * through FormatIface().
209 * @param fn InterfaceFactory function.
210 * @param iface Interface string name.
211 * @param max Maximum version to look up.
212 * @param ret Last return code from interface factory function.
213 * @return Interface pointer, or NULL if not found.
215 virtual void *InterfaceSearch(CreateInterfaceFn fn,
221 * @brief Returns the base directory of the game/server, equivalent to
222 * IVEngineServer::GetGameDir(), except the path is absolute.
224 * @return Static pointer to game's absolute basedir.
226 virtual const char *GetBaseDir() =0;
229 * @brief Formats a file path to the local OS.
231 * Does not include any base directories. Note that all slashes and
232 * black slashes are reverted to the local OS's expectancy.
234 * @param buffer Destination buffer to store path.
235 * @param len Maximum length of buffer, including null
237 * @param fmt Formatted string.
239 virtual void PathFormat(char *buffer, size_t len, const char *fmt, ...) =0;
242 * @brief Prints text in the specified client's console. Same as
243 * IVEngineServer::ClientPrintf except that it allows for string
246 * @param client Client edict pointer.
247 * @param fmt Formatted string to print to the client.
249 virtual void ClientConPrintf(edict_t *client, const char *fmt, ...) =0;
252 * @brief Wrapper around InterfaceSearch(). Assumes no maximum.
253 * This is designed to replace the fact that searches only went upwards.
254 * The "V" is intended to convey that this is for Valve formatted
257 * @param fn Interface factory function.
258 * @param iface Interface string.
259 * @param min Minimum value to search from. If zero, searching
260 * begins from the first available version regardless
261 * of the interface. Note that this can return
262 * interfaces EARLIER than the version specified. A
263 * value of -1 (default) specifies the string version
264 * as the minimum. Any other value specifices the
265 * minimum value to search from.
266 * @return Interface pointer, or NULL if not found.
268 virtual void *VInterfaceMatch(CreateInterfaceFn fn,
273 * @brief Tells SourceMM to add VSP hooking capability to plugins.
275 * Since this potentially uses more resources than it would otherwise,
276 * plugins have to explicitly enable the feature. Whether requested or
277 * not, if it is enabled, all plugins will get a pointer to the VSP
278 * listener through IMetamodListener. This will not be called more than
279 * once for a given plugin; if it is requested more than once, each
280 * successive call will only give the pointer to plugins which have not
283 virtual void EnableVSPListener() =0;
286 * @brief Returns the interface version of the GameDLL's IServerGameDLL
289 * @return Interface version of the loaded IServerGameDLL.
291 virtual int GetGameDLLVersion() =0;
294 * @brief Returns the number of user messages in the GameDLL.
296 * @return Number of user messages, or -1 if SourceMM has
297 * failed to get user message list.
299 virtual int GetUserMessageCount() =0;
302 * @brief Returns the index of the specified user message.
304 * @param name User message name.
305 * @param size Optional pointer to store size of user message.
306 * @return Message index, or -1 on failure.
308 virtual int FindUserMessage(const char *name, int *size=NULL) =0;
311 * @brief Returns the name of the specified user message.
313 * @param index User message index.
314 * @param size Optional pointer to store size of user message.
315 * @return Message name, or NULL on failure.
317 virtual const char *GetUserMessage(int index, int *size=NULL) =0;
320 * @brief Returns the highest interface version of IServerPluginCallbacks
321 * that the engine supports. This is useful for games that run on older
322 * versions of the Source engine, such as The Ship.
324 * @return Highest interface version of IServerPluginCallbacks.
325 * Returns 0 if SourceMM's VSP listener isn't
328 virtual int GetVSPVersion() =0;
331 * @brief Returns the engine interface that MM:S is using as a backend.
333 * The values will be one of the SOURCE_ENGINE_* constants from the top
336 * @return A SOURCE_ENGINE_* constant value.
338 virtual int GetSourceEngineBuild() =0;
341 * @brief Returns the VSP listener loaded.
343 * This is useful for late-loading plugins which need to decide whether
344 * to add a listener or not (or need to get the pointer at all).
346 * @param Optional pointer to store the VSP version.
347 * @return IServerPluginCallbacks pointer, or NULL if an
348 * IMetamodListener event has yet to occur for
349 * EnableVSPListener().
351 virtual IServerPluginCallbacks *GetVSPInfo(int *pVersion) =0;
354 * @brief Formats a string. This is a platform safe wrapper around
355 * snprintf/_snprintf.
357 * @param buffer Buffer to write to.
358 * @param maxlength Maximum length of the buffer.
359 * @param format Format specifiers.
360 * @param ... Format arguments.
361 * @return Number of bytes actually written, not including
362 * the null terminator.
364 virtual size_t Format(char *buffer,
370 * @brief Formats a string. This is a platform safe wrapper around
371 * vsnprintf/_vsnprintf.
373 * @param buffer Buffer to write to.
374 * @param maxlength Maximum length of the buffer.
375 * @param format Format specifiers.
376 * @param ap Format argument list.
377 * @return Number of bytes actually written, not including the
380 virtual size_t FormatArgs(char *buffer,
387 #if !defined METAMOD_NO_AUTO_NAMESPACE
388 using namespace SourceMM;
394 * 1.1.0 Bumped API to 1:0. The breaking changes occurred in SourceHook and the plugin API.
395 * 1.1.2 Added API call for generating iface names.
396 * 1.2 Added API more helper functions and new SourceHook version.
397 * 1.2.2 Added API for printing to client console (with string formatting).
398 * 1.3 Added new interface search API.
399 * 1.4 Added VSP listener and user message API.
400 * 1.5.0 Added API for getting highest supported version of IServerPluginCallbacks.
401 * 1.6.0 Added API for Orange Box. Broke backwards compatibility.
404 #endif //_INCLUDE_ISMM_API_H