|
dvander@367
|
1 |
/** |
|
dvander@367
|
2 |
* vim: set ts=4 : |
|
dvander@367
|
3 |
* ====================================================== |
|
dvander@367
|
4 |
* Metamod:Source |
|
dvander@367
|
5 |
* Copyright (C) 2004-2007 AlliedModders LLC and authors. |
|
dvander@367
|
6 |
* All rights reserved. |
|
dvander@367
|
7 |
* ====================================================== |
|
dvander@367
|
8 |
* |
|
dvander@367
|
9 |
* This software is provided 'as-is', without any express or implied warranty. |
|
dvander@367
|
10 |
* In no event will the authors be held liable for any damages arising from |
|
dvander@367
|
11 |
* the use of this software. |
|
dvander@367
|
12 |
* |
|
dvander@367
|
13 |
* Permission is granted to anyone to use this software for any purpose, |
|
dvander@367
|
14 |
* including commercial applications, and to alter it and redistribute it |
|
dvander@367
|
15 |
* freely, subject to the following restrictions: |
|
dvander@367
|
16 |
* |
|
dvander@367
|
17 |
* 1. The origin of this software must not be misrepresented; you must not |
|
dvander@367
|
18 |
* claim that you wrote the original software. If you use this software in a |
|
dvander@367
|
19 |
* product, an acknowledgment in the product documentation would be |
|
dvander@367
|
20 |
* appreciated but is not required. |
|
dvander@367
|
21 |
* 2. Altered source versions must be plainly marked as such, and must not be |
|
dvander@367
|
22 |
* misrepresented as being the original software. |
|
dvander@367
|
23 |
* 3. This notice may not be removed or altered from any source distribution. |
|
dvander@367
|
24 |
* |
|
dvander@367
|
25 |
* Version: $Id$ |
|
dvander@367
|
26 |
*/ |
|
dvander@347
|
27 |
|
|
dvander@347
|
28 |
#ifndef _INCLUDE_ISMM_API_H |
|
dvander@347
|
29 |
#define _INCLUDE_ISMM_API_H |
|
dvander@347
|
30 |
|
|
dvander@347
|
31 |
/** |
|
dvander@347
|
32 |
* @brief External API interface |
|
dvander@347
|
33 |
* @file ISmmAPI.h |
|
dvander@347
|
34 |
*/ |
|
dvander@347
|
35 |
|
|
dvander@347
|
36 |
#include <interface.h> |
|
dvander@347
|
37 |
#include <eiface.h> |
|
dvander@359
|
38 |
#include <sourcehook.h> |
|
dvander@347
|
39 |
#include "IPluginManager.h" |
|
dvander@347
|
40 |
|
|
dvander@347
|
41 |
#if defined __GNUC__ |
|
dvander@347
|
42 |
#if ((__GNUC__ == 3) && (__GNUC_MINOR__ < 4)) || (__GNUC__ < 3) |
|
dvander@347
|
43 |
#error "You must compile with at least GCC 3.4! If you know what you are doing, you can remove this message." |
|
dvander@347
|
44 |
#endif //version check |
|
dvander@347
|
45 |
#endif //__GNUC__ |
|
dvander@347
|
46 |
|
|
dvander@347
|
47 |
class IMetamodListener; |
|
dvander@347
|
48 |
class ISmmPluginManager; |
|
dvander@347
|
49 |
class ISmmPlugin; |
|
dvander@347
|
50 |
|
|
dvander@347
|
51 |
#define MMIFACE_SOURCEHOOK "ISourceHook" /**< ISourceHook Pointer */ |
|
dvander@347
|
52 |
#define MMIFACE_PLMANAGER "IPluginManager" /**< SourceMM Plugin Functions */ |
|
dvander@351
|
53 |
#define IFACE_MAXNUM 999 /**< Maximum interface version */ |
|
dvander@351
|
54 |
|
|
dvander@352
|
55 |
#define SOURCE_ENGINE_UNKNOWN 0 /**< Could not determine the engine version */ |
|
dvander@352
|
56 |
#define SOURCE_ENGINE_ORIGINAL 1 /**< Original Source Engine (used by The Ship) */ |
|
dvander@352
|
57 |
#define SOURCE_ENGINE_EPISODEONE 2 /**< Episode 1 Source Engine (second major SDK) */ |
|
dvander@352
|
58 |
#define SOURCE_ENGINE_ORANGEBOX 3 /**< Orange Box Source Engine (third major SDK) */ |
|
dvander@347
|
59 |
|
|
dvander@347
|
60 |
class ISmmAPI |
|
dvander@347
|
61 |
{ |
|
dvander@347
|
62 |
public: |
|
dvander@347
|
63 |
/** |
|
dvander@347
|
64 |
* @brief Logs a message through the HL2 log system. |
|
dvander@347
|
65 |
* Note: Newlines are appended automatically. |
|
dvander@347
|
66 |
* |
|
dvander@347
|
67 |
* @param pl Plugin API pointer (used for tagging message) |
|
dvander@347
|
68 |
* @param msg Formatted string. |
|
dvander@347
|
69 |
*/ |
|
dvander@347
|
70 |
virtual void LogMsg(ISmmPlugin *pl, const char *msg, ...) =0; |
|
dvander@347
|
71 |
public: |
|
dvander@347
|
72 |
/** |
|
dvander@347
|
73 |
* @brief Returns an interface factory for the HL2 engine. |
|
dvander@347
|
74 |
* |
|
dvander@347
|
75 |
* @param syn If syn is true, the synthetic wrapper is returned. |
|
dvander@347
|
76 |
* If syn is false, the true function is returned. |
|
dvander@347
|
77 |
* @return CreateInterfaceFn function pointer. |
|
dvander@347
|
78 |
*/ |
|
dvander@347
|
79 |
virtual CreateInterfaceFn engineFactory(bool syn=true) =0; |
|
dvander@347
|
80 |
|
|
dvander@347
|
81 |
/** |
|
dvander@347
|
82 |
* @brief Returns an interface factory for the HL2 physics engine. |
|
dvander@347
|
83 |
* |
|
dvander@347
|
84 |
* @param syn If syn is true, the synthetic wrapper is returned. |
|
dvander@347
|
85 |
* If syn is false, the true function is returned. |
|
dvander@347
|
86 |
* @return CreateInterfaceFn function pointer. |
|
dvander@347
|
87 |
*/ |
|
dvander@347
|
88 |
virtual CreateInterfaceFn physicsFactory(bool syn=true) =0; |
|
dvander@347
|
89 |
|
|
dvander@347
|
90 |
/** |
|
dvander@347
|
91 |
* @brief Returns an interface factory for the HL2 file system. |
|
dvander@347
|
92 |
* |
|
dvander@347
|
93 |
* @param syn If syn is true, the synthetic wrapper is returned. |
|
dvander@347
|
94 |
* If syn is false, the true function is returned. |
|
dvander@347
|
95 |
* @return CreateInterfaceFn function pointer. |
|
dvander@347
|
96 |
*/ |
|
dvander@347
|
97 |
virtual CreateInterfaceFn fileSystemFactory(bool syn=true) =0; |
|
dvander@347
|
98 |
|
|
dvander@347
|
99 |
/** |
|
dvander@347
|
100 |
* @brief Returns an interface factory for the GameDLL. |
|
dvander@347
|
101 |
* |
|
dvander@347
|
102 |
* @param syn If syn is true, the synthetic wrapper is returned. |
|
dvander@347
|
103 |
* If syn is false, the true function is returned. |
|
dvander@347
|
104 |
* @return CreateInterfaceFn function pointer. |
|
dvander@347
|
105 |
*/ |
|
dvander@347
|
106 |
virtual CreateInterfaceFn serverFactory(bool syn=true) =0; |
|
dvander@347
|
107 |
|
|
dvander@347
|
108 |
/** |
|
dvander@347
|
109 |
* @brief Returns a CGlobalVars pointer from the HL2 Engine. |
|
dvander@347
|
110 |
* |
|
dvander@347
|
111 |
* @return CGlobalVars pointer. |
|
dvander@347
|
112 |
*/ |
|
dvander@347
|
113 |
virtual CGlobalVars *pGlobals() =0; |
|
dvander@347
|
114 |
|
|
dvander@347
|
115 |
/** |
|
dvander@347
|
116 |
* @brief Used with SourceHook, sets teh last meta return value. |
|
dvander@347
|
117 |
* Note: Do not call this directly, use the Metamod macros. |
|
dvander@347
|
118 |
* |
|
dvander@347
|
119 |
* @param res META_RETURN value to set. |
|
dvander@347
|
120 |
*/ |
|
dvander@347
|
121 |
virtual void SetLastMetaReturn(META_RES res) =0; |
|
dvander@347
|
122 |
|
|
dvander@347
|
123 |
/** |
|
dvander@347
|
124 |
* @brief Used with SourceHook, returns the last meta return value. |
|
dvander@347
|
125 |
* Note: This is only valid inside a hook function. |
|
dvander@347
|
126 |
* |
|
dvander@347
|
127 |
* @return Last META_RETURN value set by a plugin. |
|
dvander@347
|
128 |
*/ |
|
dvander@347
|
129 |
virtual META_RES GetLastMetaReturn() =0; |
|
dvander@347
|
130 |
|
|
dvander@347
|
131 |
public: // Added in 1.00-RC2 (0:0) |
|
dvander@347
|
132 |
/** |
|
dvander@347
|
133 |
* @brief Allows access to Metamod's ConCommandBaseAccessor. |
|
dvander@347
|
134 |
* |
|
dvander@347
|
135 |
* @return Returns IConCommandBaseAccessor pointer. |
|
dvander@347
|
136 |
*/ |
|
dvander@347
|
137 |
virtual IConCommandBaseAccessor *GetCvarBaseAccessor() =0; |
|
dvander@347
|
138 |
|
|
dvander@347
|
139 |
/** |
|
dvander@347
|
140 |
* @brief Registers a ConCommandBase. |
|
dvander@347
|
141 |
* |
|
dvander@347
|
142 |
* @param plugin Parent plugin API pointer. |
|
dvander@347
|
143 |
* @param pCommand ConCommandBase to register. |
|
dvander@351
|
144 |
* @return True if successful, false otherwise. |
|
dvander@347
|
145 |
*/ |
|
dvander@347
|
146 |
virtual bool RegisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0; |
|
dvander@347
|
147 |
|
|
dvander@347
|
148 |
/** |
|
dvander@347
|
149 |
* @brief Unregisters a ConCommandBase. |
|
dvander@347
|
150 |
* |
|
dvander@347
|
151 |
* @param plugin Parent plugin API pointer. |
|
dvander@347
|
152 |
* @param pCommand ConCommandBase to unlink. |
|
dvander@347
|
153 |
*/ |
|
dvander@347
|
154 |
virtual void UnregisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0; |
|
dvander@347
|
155 |
|
|
dvander@347
|
156 |
/** |
|
dvander@347
|
157 |
* @brief Prints an unformatted string to the remote server console. |
|
dvander@351
|
158 |
* |
|
dvander@347
|
159 |
* Note: Newlines are not added automatically. |
|
dvander@347
|
160 |
* |
|
dvander@347
|
161 |
* @param str Message string. |
|
dvander@347
|
162 |
*/ |
|
dvander@347
|
163 |
virtual void ConPrint(const char *str) =0; |
|
dvander@347
|
164 |
|
|
dvander@347
|
165 |
/** |
|
dvander@347
|
166 |
* @brief Prints a formatted message to the remote server console. |
|
dvander@351
|
167 |
* |
|
dvander@347
|
168 |
* Note: Newlines are not added automatically. |
|
dvander@347
|
169 |
* |
|
dvander@347
|
170 |
* @param fmt Formatted message. |
|
dvander@347
|
171 |
*/ |
|
dvander@347
|
172 |
virtual void ConPrintf(const char *fmt, ...) =0; |
|
dvander@347
|
173 |
|
|
dvander@347
|
174 |
public: // Added in 1.1.0 (1:0) |
|
dvander@347
|
175 |
/** |
|
dvander@347
|
176 |
* @brief Checks if ConPrint/ConPrintf will mirror to rcon. |
|
dvander@347
|
177 |
* |
|
dvander@347
|
178 |
* @return True if remote printing available, false otherwise. |
|
dvander@347
|
179 |
*/ |
|
dvander@347
|
180 |
virtual bool RemotePrintingAvailable() =0; |
|
dvander@347
|
181 |
|
|
dvander@347
|
182 |
/** |
|
dvander@347
|
183 |
* @brief Returns the Metamod Version numbers as major version and minor (API) version. |
|
dvander@347
|
184 |
* Changes to minor version are guaranteed to be backwards compatible. |
|
dvander@347
|
185 |
* Changes to major version are not. |
|
dvander@347
|
186 |
* |
|
dvander@347
|
187 |
* @param major Filled with the major API version number. |
|
dvander@347
|
188 |
* @param minor Filled with the minor API version number. |
|
dvander@347
|
189 |
* @param plvers Filled with the current plugin API version number. |
|
dvander@347
|
190 |
* @param plmin Filled with the minimum plugin API version number supported. |
|
dvander@347
|
191 |
*/ |
|
dvander@347
|
192 |
virtual void GetApiVersions(int &major, int &minor, int &plvers, int &plmin) =0; |
|
dvander@347
|
193 |
|
|
dvander@347
|
194 |
/** |
|
dvander@347
|
195 |
* @brief Returns sourcehook API version and implementation version. |
|
dvander@347
|
196 |
* |
|
dvander@347
|
197 |
* @param shvers Filled with the SourceHook API version number. |
|
dvander@347
|
198 |
* @param shimpl Filled with the SourceHook implementation number. |
|
dvander@347
|
199 |
*/ |
|
dvander@347
|
200 |
virtual void GetShVersions(int &shvers, int &shimpl) =0; |
|
dvander@347
|
201 |
|
|
dvander@347
|
202 |
/** |
|
dvander@347
|
203 |
* @brief Adds a Metamod listener. |
|
dvander@347
|
204 |
* |
|
dvander@347
|
205 |
* @param plugin Plugin interface pointer. |
|
dvander@347
|
206 |
* @param pListener Listener interface pointer to add. |
|
dvander@347
|
207 |
*/ |
|
dvander@347
|
208 |
virtual void AddListener(ISmmPlugin *plugin, IMetamodListener *pListener) =0; |
|
dvander@347
|
209 |
|
|
dvander@347
|
210 |
/** |
|
dvander@347
|
211 |
* @brief Queries the metamod factory |
|
dvander@347
|
212 |
* |
|
dvander@347
|
213 |
* @param iface String containing interface name |
|
dvander@347
|
214 |
* @param ret Optional pointer to store return status |
|
dvander@347
|
215 |
* @param id Optional pointer to store id of plugin that overrode interface, 0 if none |
|
dvander@347
|
216 |
* @return Returned pointer |
|
dvander@347
|
217 |
*/ |
|
dvander@347
|
218 |
virtual void *MetaFactory(const char *iface, int *ret, PluginId *id) =0; |
|
dvander@347
|
219 |
|
|
dvander@347
|
220 |
public: // Added in 1.1.2 (1:1) |
|
dvander@347
|
221 |
/** |
|
dvander@347
|
222 |
* @brief Given a base interface name, such as ServerGameDLL or ServerGameDLL003, |
|
dvander@347
|
223 |
* reformats the string to increase the number, then returns the new number. |
|
dvander@347
|
224 |
* This is the base function to InterfaceSearch() and VInterfaceMatch(). |
|
dvander@347
|
225 |
* |
|
dvander@347
|
226 |
* @param iface Input/output interface name. Must be writable. |
|
dvander@347
|
227 |
* @param maxlength Maximum length of iface buffer. Must be at least strlen(iface)+4 chars. |
|
dvander@347
|
228 |
* @return The newly incremented iface version number. |
|
dvander@347
|
229 |
*/ |
|
dvander@347
|
230 |
virtual int FormatIface(char iface[], unsigned int maxlength) =0; |
|
dvander@347
|
231 |
|
|
dvander@347
|
232 |
public: // Added in 1.2 (1:2) |
|
dvander@347
|
233 |
/** |
|
dvander@351
|
234 |
* @brief Searches for an interface, eliminating the need to loop through FormatIface(). |
|
dvander@347
|
235 |
* |
|
dvander@347
|
236 |
* @param fn InterfaceFactory function. |
|
dvander@347
|
237 |
* @param iface Interface string name. |
|
dvander@347
|
238 |
* @param max Maximum version to look up. |
|
dvander@347
|
239 |
* @param ret Last return code from interface factory function. |
|
dvander@347
|
240 |
* @return Interface pointer, or NULL if not found. |
|
dvander@347
|
241 |
*/ |
|
dvander@347
|
242 |
virtual void *InterfaceSearch(CreateInterfaceFn fn, const char *iface, int max, int *ret) =0; |
|
dvander@347
|
243 |
|
|
dvander@347
|
244 |
/** |
|
dvander@347
|
245 |
* @brief Returns the base directory of the game/server, equivalent to |
|
dvander@351
|
246 |
* IVEngineServer::GetGameDir(), except the path is absolute. |
|
dvander@347
|
247 |
* |
|
dvander@347
|
248 |
* @return Static pointer to game's absolute basedir. |
|
dvander@347
|
249 |
*/ |
|
dvander@347
|
250 |
virtual const char *GetBaseDir() =0; |
|
dvander@347
|
251 |
|
|
dvander@347
|
252 |
/** |
|
dvander@351
|
253 |
* @brief Formats a file path to the local OS. |
|
dvander@351
|
254 |
* |
|
dvander@351
|
255 |
* Does not include any base directories. Note that all slashes and black |
|
dvander@351
|
256 |
* slashes are reverted to the local OS's expectancy. |
|
dvander@347
|
257 |
* |
|
dvander@347
|
258 |
* @param buffer Destination buffer to store path. |
|
dvander@347
|
259 |
* @param len Maximum length of buffer, including null terminator. |
|
dvander@347
|
260 |
* @param fmt Formatted string. |
|
dvander@347
|
261 |
*/ |
|
dvander@347
|
262 |
virtual void PathFormat(char *buffer, size_t len, const char *fmt, ...) =0; |
|
dvander@347
|
263 |
|
|
dvander@347
|
264 |
public: // Added in 1.2.2 (1:3) |
|
dvander@347
|
265 |
/** |
|
dvander@351
|
266 |
* @brief Prints text in the specified client's console. Same as |
|
dvander@351
|
267 |
* IVEngineServer::ClientPrintf except that it allows for string formatting. |
|
dvander@347
|
268 |
* |
|
dvander@347
|
269 |
* @param client Client edict pointer. |
|
dvander@347
|
270 |
* @param fmt Formatted string to print to the client. |
|
dvander@347
|
271 |
*/ |
|
dvander@347
|
272 |
virtual void ClientConPrintf(edict_t *client, const char *fmt, ...) =0; |
|
dvander@347
|
273 |
|
|
dvander@347
|
274 |
public: // Added in 1.3 (1:4) |
|
dvander@347
|
275 |
/** |
|
dvander@347
|
276 |
* @brief Wrapper around InterfaceSearch(). Assumes no maximum. |
|
dvander@347
|
277 |
* This is designed to replace the fact that searches only went upwards. |
|
dvander@347
|
278 |
* The "V" is intended to convey that this is for Valve formatted interface strings. |
|
dvander@347
|
279 |
* |
|
dvander@347
|
280 |
* @param fn Interface factory function. |
|
dvander@347
|
281 |
* @param iface Interface string. |
|
dvander@351
|
282 |
* @param min Minimum value to search from. If zero, searching |
|
dvander@351
|
283 |
* begins from the first available version regardless |
|
dvander@351
|
284 |
* of the interface. Note that this can return |
|
dvander@351
|
285 |
* interfaces EARLIER than the version specified. A |
|
dvander@351
|
286 |
* value of -1 (default) specifies the string version |
|
dvander@351
|
287 |
* as the minimum. Any other value specifices the |
|
dvander@351
|
288 |
* minimum value to search from. |
|
dvander@347
|
289 |
* @return Interface pointer, or NULL if not found. |
|
dvander@347
|
290 |
*/ |
|
dvander@347
|
291 |
virtual void *VInterfaceMatch(CreateInterfaceFn fn, const char *iface, int min=-1) =0; |
|
dvander@347
|
292 |
|
|
dvander@347
|
293 |
public: // Added in 1.4 (1:5) |
|
dvander@347
|
294 |
/** |
|
dvander@347
|
295 |
* @brief Tells SourceMM to add VSP hooking capability to plugins. |
|
dvander@347
|
296 |
* |
|
dvander@351
|
297 |
* Since this potentially uses more resources than it would otherwise, |
|
dvander@351
|
298 |
* plugins have to explicitly enable the feature. Whether requested or |
|
dvander@351
|
299 |
* not, if it is enabled, all plugins will get a pointer to the VSP |
|
dvander@351
|
300 |
* listener through IMetamodListener. This will not be called more than |
|
dvander@351
|
301 |
* once for a given plugin; if it is requested more than once, each |
|
dvander@351
|
302 |
* successive call will only give the pointer to plugins which have not |
|
dvander@351
|
303 |
* yet received it. |
|
dvander@347
|
304 |
*/ |
|
dvander@347
|
305 |
virtual void EnableVSPListener() =0; |
|
dvander@347
|
306 |
|
|
dvander@347
|
307 |
/** |
|
dvander@351
|
308 |
* @brief Returns the interface version of the GameDLL's IServerGameDLL |
|
dvander@351
|
309 |
* implementation. |
|
dvander@347
|
310 |
* |
|
dvander@347
|
311 |
* @return Interface version of the loaded IServerGameDLL. |
|
dvander@347
|
312 |
*/ |
|
dvander@347
|
313 |
virtual int GetGameDLLVersion() =0; |
|
dvander@347
|
314 |
|
|
dvander@347
|
315 |
/** |
|
dvander@347
|
316 |
* @brief Returns the number of user messages in the GameDLL. |
|
dvander@347
|
317 |
* |
|
dvander@351
|
318 |
* @return Number of user messages, or -1 if SourceMM has |
|
dvander@351
|
319 |
* failed to get user message list. |
|
dvander@347
|
320 |
*/ |
|
dvander@347
|
321 |
virtual int GetUserMessageCount() =0; |
|
dvander@347
|
322 |
|
|
dvander@347
|
323 |
/** |
|
dvander@347
|
324 |
* @brief Returns the index of the specified user message. |
|
dvander@347
|
325 |
* |
|
dvander@347
|
326 |
* @param name User message name. |
|
dvander@347
|
327 |
* @param size Optional pointer to store size of user message. |
|
dvander@347
|
328 |
* @return Message index, or -1 on failure. |
|
dvander@347
|
329 |
*/ |
|
dvander@347
|
330 |
virtual int FindUserMessage(const char *name, int *size=NULL) =0; |
|
dvander@347
|
331 |
|
|
dvander@347
|
332 |
/** |
|
dvander@347
|
333 |
* @brief Returns the name of the specified user message. |
|
dvander@347
|
334 |
* |
|
dvander@347
|
335 |
* @param index User message index. |
|
dvander@347
|
336 |
* @param size Optional pointer to store size of user message. |
|
dvander@347
|
337 |
* @return Message name, or NULL on failure. |
|
dvander@347
|
338 |
*/ |
|
dvander@347
|
339 |
virtual const char *GetUserMessage(int index, int *size=NULL) =0; |
|
dvander@351
|
340 |
|
|
dvander@348
|
341 |
public: // Added in 1.5.0 (1:6) |
|
dvander@348
|
342 |
/** |
|
dvander@351
|
343 |
* @brief Returns the highest interface version of IServerPluginCallbacks |
|
dvander@351
|
344 |
* that the engine supports. This is useful for games that run on older |
|
dvander@351
|
345 |
* versions of the Source engine, such as The Ship. |
|
dvander@348
|
346 |
* |
|
dvander@348
|
347 |
* @return Highest interface version of IServerPluginCallbacks. |
|
dvander@351
|
348 |
* Returns 0 if SourceMM's VSP listener isn't currently |
|
dvander@351
|
349 |
* enabled. |
|
dvander@348
|
350 |
*/ |
|
dvander@348
|
351 |
virtual int GetVSPVersion() =0; |
|
dvander@351
|
352 |
|
|
dvander@351
|
353 |
public: // Added in 1.6.0 (1:7) |
|
dvander@351
|
354 |
/** |
|
dvander@351
|
355 |
* @brief Returns the engine interface that MM:S is using as a backend. |
|
dvander@351
|
356 |
* |
|
dvander@351
|
357 |
* The values will be one of the SOURCE_ENGINE_* constants from the top |
|
dvander@351
|
358 |
* of this file. |
|
dvander@351
|
359 |
* |
|
dvander@351
|
360 |
* @return A SOURCE_ENGINE_* constant value. |
|
dvander@351
|
361 |
*/ |
|
dvander@351
|
362 |
virtual int GetSourceEngineBuild() =0; |
|
dvander@366
|
363 |
|
|
dvander@366
|
364 |
/** |
|
dvander@366
|
365 |
* @brief Returns the VSP listener loaded. |
|
dvander@366
|
366 |
* |
|
dvander@366
|
367 |
* This is useful for late-loading plugins which need to decide whether |
|
dvander@366
|
368 |
* to add a listener or not (or need to get the pointer at all). |
|
dvander@366
|
369 |
* |
|
dvander@366
|
370 |
* @param Optional pointer to store the VSP version. |
|
dvander@366
|
371 |
* @return IServerPluginCallbacks pointer, or NULL if an |
|
dvander@366
|
372 |
* IMetamodListener event has yet to occur for |
|
dvander@366
|
373 |
* EnableVSPListener(). |
|
dvander@366
|
374 |
*/ |
|
dvander@366
|
375 |
virtual IServerPluginCallbacks *GetVSPInfo(int *pVersion) =0; |
|
dvander@347
|
376 |
}; |
|
dvander@347
|
377 |
|
|
dvander@347
|
378 |
|
|
dvander@347
|
379 |
/** |
|
dvander@347
|
380 |
* Version History |
|
dvander@347
|
381 |
* |
|
dvander@347
|
382 |
* 1.1.0 Bumped API to 1:0. The breaking changes occurred in SourceHook and the plugin API. |
|
dvander@347
|
383 |
* 1.1.2 Added API call for generating iface names. |
|
dvander@347
|
384 |
* 1.2 Added API more helper functions and new SourceHook version. |
|
dvander@347
|
385 |
* 1.2.2 Added API for printing to client console (with string formatting). |
|
dvander@347
|
386 |
* 1.3 Added new interface search API. |
|
dvander@347
|
387 |
* 1.4 Added VSP listener and user message API. |
|
dvander@348
|
388 |
* 1.5.0 Added API for getting highest supported version of IServerPluginCallbacks. |
|
dvander@351
|
389 |
* 1.6.0 Added API for Orange Box. |
|
dvander@347
|
390 |
*/ |
|
dvander@347
|
391 |
|
|
dvander@347
|
392 |
#endif //_INCLUDE_ISMM_API_H |
|
dvander@355
|
393 |
|