|
dvander@371
|
1 |
/** |
|
dvander@371
|
2 |
* vim: set ts=4 : |
|
dvander@371
|
3 |
* ====================================================== |
|
dvander@371
|
4 |
* Metamod:Source |
|
dvander@371
|
5 |
* Copyright (C) 2004-2007 AlliedModders LLC and authors. |
|
dvander@371
|
6 |
* All rights reserved. |
|
dvander@371
|
7 |
* ====================================================== |
|
dvander@371
|
8 |
* |
|
dvander@371
|
9 |
* This software is provided 'as-is', without any express or implied warranty. |
|
dvander@371
|
10 |
* In no event will the authors be held liable for any damages arising from |
|
dvander@371
|
11 |
* the use of this software. |
|
dvander@371
|
12 |
* |
|
dvander@371
|
13 |
* Permission is granted to anyone to use this software for any purpose, |
|
dvander@371
|
14 |
* including commercial applications, and to alter it and redistribute it |
|
dvander@371
|
15 |
* freely, subject to the following restrictions: |
|
dvander@371
|
16 |
* |
|
dvander@371
|
17 |
* 1. The origin of this software must not be misrepresented; you must not |
|
dvander@371
|
18 |
* claim that you wrote the original software. If you use this software in a |
|
dvander@371
|
19 |
* product, an acknowledgment in the product documentation would be |
|
dvander@371
|
20 |
* appreciated but is not required. |
|
dvander@371
|
21 |
* 2. Altered source versions must be plainly marked as such, and must not be |
|
dvander@371
|
22 |
* misrepresented as being the original software. |
|
dvander@371
|
23 |
* 3. This notice may not be removed or altered from any source distribution. |
|
dvander@371
|
24 |
* |
|
dvander@371
|
25 |
* Version: $Id$ |
|
dvander@371
|
26 |
*/ |
|
dvander@9
|
27 |
|
|
dvander@7
|
28 |
#ifndef _INCLUDE_ISMM_PLUGIN_H |
|
dvander@7
|
29 |
#define _INCLUDE_ISMM_PLUGIN_H |
|
dvander@7
|
30 |
|
|
dvander@9
|
31 |
/** |
|
dvander@9
|
32 |
* @brief Plugin API interface |
|
dvander@9
|
33 |
* @file ISmmPlugin.h |
|
dvander@9
|
34 |
*/ |
|
dvander@9
|
35 |
|
|
dvander@7
|
36 |
#include <interface.h> |
|
dvander@371
|
37 |
#include <sourcehook.h> |
|
dvander@396
|
38 |
#include <IPluginManager.h> |
|
dvander@396
|
39 |
#include <ISmmAPI.h> |
|
dvander@405
|
40 |
#include <ISmmPluginExt.h> |
|
dvander@7
|
41 |
|
|
dvander@396
|
42 |
namespace SourceMM |
|
dvander@7
|
43 |
{ |
|
dvander@396
|
44 |
class ISmmAPI; |
|
dvander@7
|
45 |
|
|
dvander@122
|
46 |
/** |
|
dvander@396
|
47 |
* @brief Callbacks that a plugin must expose. |
|
dvander@7
|
48 |
*/ |
|
dvander@396
|
49 |
class ISmmPlugin |
|
dvander@122
|
50 |
{ |
|
dvander@396
|
51 |
public: |
|
dvander@396
|
52 |
/** |
|
dvander@396
|
53 |
* @brief Called to request the plugin's API version. |
|
dvander@396
|
54 |
* |
|
dvander@396
|
55 |
* This is the first callback invoked, and always remains at the top |
|
dvander@396
|
56 |
* of the virtual table. |
|
dvander@396
|
57 |
* |
|
dvander@396
|
58 |
* @return Plugin API version. |
|
dvander@396
|
59 |
*/ |
|
dvander@396
|
60 |
virtual int GetApiVersion() |
|
dvander@396
|
61 |
{ |
|
dvander@396
|
62 |
return METAMOD_PLAPI_VERSION; |
|
dvander@396
|
63 |
} |
|
dvander@396
|
64 |
|
|
dvander@396
|
65 |
/** |
|
dvander@396
|
66 |
* @brief Virtual destructor so GCC doesn't complain. |
|
dvander@396
|
67 |
*/ |
|
dvander@396
|
68 |
virtual ~ISmmPlugin() |
|
dvander@396
|
69 |
{ |
|
dvander@396
|
70 |
} |
|
dvander@122
|
71 |
|
|
dvander@396
|
72 |
public: |
|
dvander@396
|
73 |
/** |
|
dvander@396
|
74 |
* @brief Called on plugin load. |
|
dvander@396
|
75 |
* |
|
dvander@396
|
76 |
* This is called as DLLInit() executes - after the parameters are |
|
dvander@396
|
77 |
* known, but before the original GameDLL function is called. |
|
dvander@396
|
78 |
* Therefore, you cannot hook it, but you don't need to - Load() is |
|
dvander@396
|
79 |
* basically your hook. You can override factories before the engine |
|
dvander@396
|
80 |
* and gamedll exchange them. However, take care to note that if your |
|
dvander@396
|
81 |
* plugin is unloaded, and the gamedll/engine have cached an interface |
|
dvander@396
|
82 |
* you've passed, something will definitely crash. Be careful. |
|
dvander@396
|
83 |
* |
|
dvander@396
|
84 |
* @param id Internal id of plugin. Saved globally by PLUGIN_SAVEVARS() |
|
dvander@396
|
85 |
* @param ismm External API for SourceMM. Saved globally by PLUGIN_SAVEVARS() |
|
dvander@396
|
86 |
* @param error Error message buffer |
|
dvander@396
|
87 |
* @param maxlength Size of error message buffer |
|
dvander@396
|
88 |
* @param late Set to true if your plugin was loaded late (not at server load). |
|
dvander@396
|
89 |
* @return True if successful, return false to reject the load. |
|
dvander@396
|
90 |
*/ |
|
dvander@396
|
91 |
virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late) =0; |
|
dvander@7
|
92 |
|
|
dvander@396
|
93 |
/** |
|
dvander@396
|
94 |
* @brief Called when all plugins have been loaded. |
|
dvander@396
|
95 |
* |
|
dvander@396
|
96 |
* This is called after DLLInit(), and thus the mod has been mostly initialized. |
|
dvander@396
|
97 |
* It is also safe to assume that all other (automatically loaded) plugins are now |
|
dvander@396
|
98 |
* ready to start interacting, because they are all loaded. |
|
dvander@396
|
99 |
*/ |
|
dvander@396
|
100 |
virtual void AllPluginsLoaded() |
|
dvander@396
|
101 |
{ |
|
dvander@396
|
102 |
} |
|
dvander@30
|
103 |
|
|
dvander@396
|
104 |
/** |
|
dvander@396
|
105 |
* @brief Called when your plugin is "queried". |
|
dvander@396
|
106 |
* |
|
dvander@396
|
107 |
* This is useful for rejecting a loaded state. For example, if your |
|
dvander@396
|
108 |
* plugin wants to stop operating, it can simply return false and copy |
|
dvander@396
|
109 |
* an error message. This will notify other plugins or MM:S of |
|
dvander@396
|
110 |
* something bad that happened. MM:S will not cache the return state, |
|
dvander@396
|
111 |
* so if you return false, your plugin will not actually be paused or |
|
dvander@396
|
112 |
* unloaded. This callback will be called when: |
|
dvander@396
|
113 |
* - Another plugin requests it |
|
dvander@396
|
114 |
* - Someone types "meta list", it will show up as "REFUSED" |
|
dvander@396
|
115 |
* - When Metamod need to re-check the plugin's status |
|
dvander@396
|
116 |
* - If the plugin does something like overload a factory, Metamod |
|
dvander@396
|
117 |
* will make sure the Query() returns true before calling it. |
|
dvander@396
|
118 |
* Also note that this query will only override Metamod when the |
|
dvander@396
|
119 |
* plugin is running and not paused. |
|
dvander@396
|
120 |
* |
|
dvander@396
|
121 |
* @param error Buffer for error message, or NULL if none. |
|
dvander@396
|
122 |
* @param maxlen Maximum length of error buffer. |
|
dvander@396
|
123 |
* @return Status code - true for okay, false for badness. |
|
dvander@396
|
124 |
*/ |
|
dvander@396
|
125 |
virtual bool QueryRunning(char *error, size_t maxlen) |
|
dvander@396
|
126 |
{ |
|
dvander@396
|
127 |
return true; |
|
dvander@396
|
128 |
} |
|
dvander@30
|
129 |
|
|
dvander@396
|
130 |
/** |
|
dvander@396
|
131 |
* @brief Called on plugin unload. You can return false if you know |
|
dvander@396
|
132 |
* your plugin is not capable of restoring critical states it modifies. |
|
dvander@396
|
133 |
* |
|
dvander@396
|
134 |
* @param error Error message buffer |
|
dvander@396
|
135 |
* @param maxlen Size of error message buffer |
|
dvander@396
|
136 |
* @return True on success, return false to request no unload. |
|
dvander@396
|
137 |
*/ |
|
dvander@396
|
138 |
virtual bool Unload(char *error, size_t maxlen) |
|
dvander@396
|
139 |
{ |
|
dvander@396
|
140 |
return true; |
|
dvander@396
|
141 |
} |
|
dvander@30
|
142 |
|
|
dvander@396
|
143 |
/** |
|
dvander@396
|
144 |
* @brief Called on plugin pause. |
|
dvander@396
|
145 |
* |
|
dvander@396
|
146 |
* @param error Error message buffer |
|
dvander@396
|
147 |
* @param maxlen Size of error message buffer |
|
dvander@396
|
148 |
* @return True on success, return false to request no pause. |
|
dvander@396
|
149 |
*/ |
|
dvander@396
|
150 |
virtual bool Pause(char *error, size_t maxlen) |
|
dvander@396
|
151 |
{ |
|
dvander@396
|
152 |
return true; |
|
dvander@396
|
153 |
} |
|
dvander@7
|
154 |
|
|
dvander@396
|
155 |
/** |
|
dvander@396
|
156 |
* @brief Called on plugin unpause. |
|
dvander@396
|
157 |
* |
|
dvander@396
|
158 |
* @param error Error message buffer |
|
dvander@396
|
159 |
* @param maxlen Size of error message buffer |
|
dvander@396
|
160 |
* @return True on success, return false to request no unpause. |
|
dvander@396
|
161 |
*/ |
|
dvander@396
|
162 |
virtual bool Unpause(char *error, size_t maxlen) |
|
dvander@396
|
163 |
{ |
|
dvander@396
|
164 |
return true; |
|
dvander@396
|
165 |
} |
|
dvander@396
|
166 |
public: |
|
dvander@396
|
167 |
/** @brief Return author as string */ |
|
dvander@396
|
168 |
virtual const char *GetAuthor() =0; |
|
dvander@396
|
169 |
|
|
dvander@396
|
170 |
/** @brief Return plugin name as string */ |
|
dvander@396
|
171 |
virtual const char *GetName() =0; |
|
dvander@396
|
172 |
|
|
dvander@396
|
173 |
/** @brief Return a description as string */ |
|
dvander@396
|
174 |
virtual const char *GetDescription() =0; |
|
dvander@396
|
175 |
|
|
dvander@396
|
176 |
/** @brief Return a URL as string */ |
|
dvander@396
|
177 |
virtual const char *GetURL() =0; |
|
dvander@396
|
178 |
|
|
dvander@396
|
179 |
/** @brief Return quick license code as string */ |
|
dvander@396
|
180 |
virtual const char *GetLicense() =0; |
|
dvander@396
|
181 |
|
|
dvander@396
|
182 |
/** @brief Return version as string */ |
|
dvander@396
|
183 |
virtual const char *GetVersion() =0; |
|
dvander@396
|
184 |
|
|
dvander@396
|
185 |
/** @brief Return author as string */ |
|
dvander@396
|
186 |
virtual const char *GetDate() =0; |
|
dvander@396
|
187 |
|
|
dvander@396
|
188 |
/** @brief Return author as string */ |
|
dvander@396
|
189 |
virtual const char *GetLogTag() =0; |
|
dvander@396
|
190 |
}; |
|
dvander@138
|
191 |
|
|
dvander@282
|
192 |
/** |
|
dvander@396
|
193 |
* @brief Various events that Metamod can fire. |
|
dvander@282
|
194 |
*/ |
|
dvander@396
|
195 |
class IMetamodListener |
|
dvander@371
|
196 |
{ |
|
dvander@396
|
197 |
public: |
|
dvander@396
|
198 |
/** |
|
dvander@396
|
199 |
* @brief Called when a plugin is loaded. |
|
dvander@396
|
200 |
* |
|
dvander@396
|
201 |
* @param id Id of the plugin. |
|
dvander@396
|
202 |
*/ |
|
dvander@396
|
203 |
virtual void OnPluginLoad(PluginId id) |
|
dvander@282
|
204 |
{ |
|
dvander@282
|
205 |
} |
|
dvander@282
|
206 |
|
|
dvander@396
|
207 |
/** |
|
dvander@396
|
208 |
* @brief Called when a plugin is unloaded. |
|
dvander@396
|
209 |
* |
|
dvander@396
|
210 |
* @param id Id of the plugin. |
|
dvander@396
|
211 |
*/ |
|
dvander@396
|
212 |
virtual void OnPluginUnload(PluginId id) |
|
dvander@396
|
213 |
{ |
|
dvander@396
|
214 |
} |
|
dvander@396
|
215 |
|
|
dvander@396
|
216 |
/** |
|
dvander@396
|
217 |
* @brief Called when a plugin is paused. |
|
dvander@396
|
218 |
* |
|
dvander@396
|
219 |
* @param id Id of the plugin. |
|
dvander@396
|
220 |
*/ |
|
dvander@396
|
221 |
virtual void OnPluginPause(PluginId id) |
|
dvander@396
|
222 |
{ |
|
dvander@396
|
223 |
} |
|
dvander@396
|
224 |
|
|
dvander@396
|
225 |
/** |
|
dvander@396
|
226 |
* @brief Called when a plugin is unpaused. |
|
dvander@396
|
227 |
* |
|
dvander@396
|
228 |
* @param id Id of the plugin. |
|
dvander@396
|
229 |
*/ |
|
dvander@396
|
230 |
virtual void OnPluginUnpause(PluginId id) |
|
dvander@396
|
231 |
{ |
|
dvander@396
|
232 |
} |
|
dvander@396
|
233 |
|
|
dvander@396
|
234 |
/** |
|
dvander@396
|
235 |
* @brief Called when the level is loaded (after GameInit, before |
|
dvander@396
|
236 |
* ServerActivate). |
|
dvander@396
|
237 |
* |
|
dvander@396
|
238 |
* To override this, hook IServerGameDLL::LevelInit(). |
|
dvander@396
|
239 |
* |
|
dvander@396
|
240 |
* @param pMapName Name of the map. |
|
dvander@396
|
241 |
* @param pMapEntities Lump string of the map entities, in KeyValues |
|
dvander@396
|
242 |
* format. |
|
dvander@396
|
243 |
* @param pOldLevel Unknown. |
|
dvander@396
|
244 |
* @param pLandmarkName Unknown. |
|
dvander@396
|
245 |
* @param loadGame Unknown. |
|
dvander@396
|
246 |
* @param background Unknown. |
|
dvander@396
|
247 |
*/ |
|
dvander@396
|
248 |
virtual void OnLevelInit(char const *pMapName, |
|
dvander@396
|
249 |
char const *pMapEntities, |
|
dvander@396
|
250 |
char const *pOldLevel, |
|
dvander@396
|
251 |
char const *pLandmarkName, |
|
dvander@396
|
252 |
bool loadGame, |
|
dvander@396
|
253 |
bool background) |
|
dvander@396
|
254 |
{ |
|
dvander@396
|
255 |
} |
|
dvander@138
|
256 |
|
|
dvander@396
|
257 |
/** |
|
dvander@396
|
258 |
* @brief Called when the level is shut down. May be called more than |
|
dvander@396
|
259 |
* once. |
|
dvander@396
|
260 |
*/ |
|
dvander@396
|
261 |
virtual void OnLevelShutdown() |
|
dvander@282
|
262 |
{ |
|
dvander@396
|
263 |
} |
|
dvander@396
|
264 |
|
|
dvander@396
|
265 |
/** |
|
dvander@396
|
266 |
* @brief Called when engineFactory() is used through Metamod:Source's |
|
dvander@396
|
267 |
* wrapper. This can be used to provide interfaces to other plugins or |
|
dvander@396
|
268 |
* the GameDLL. |
|
dvander@396
|
269 |
* |
|
dvander@396
|
270 |
* If ret is passed, you should fill it with IFACE_OK or IFACE_FAILED. |
|
dvander@396
|
271 |
* |
|
dvander@396
|
272 |
* @param iface Interface string. |
|
dvander@396
|
273 |
* @param ret Optional pointer to store return code. |
|
dvander@396
|
274 |
* @return Generic pointer to the interface, or NULL if |
|
dvander@396
|
275 |
* not found. |
|
dvander@396
|
276 |
*/ |
|
dvander@396
|
277 |
virtual void *OnEngineQuery(const char *iface, int *ret) |
|
dvander@396
|
278 |
{ |
|
dvander@396
|
279 |
if (ret) |
|
dvander@396
|
280 |
{ |
|
dvander@396
|
281 |
*ret = IFACE_FAILED; |
|
dvander@396
|
282 |
} |
|
dvander@396
|
283 |
|
|
dvander@396
|
284 |
return NULL; |
|
dvander@282
|
285 |
} |
|
dvander@282
|
286 |
|
|
dvander@396
|
287 |
/** |
|
dvander@396
|
288 |
* @brief Called when the physics factory is used through |
|
dvander@396
|
289 |
* Metamod:Source's wrapper. This can be used to provide interfaces to |
|
dvander@396
|
290 |
* other plugins. |
|
dvander@396
|
291 |
* |
|
dvander@396
|
292 |
* If ret is passed, you should fill it with IFACE_OK or IFACE_FAILED. |
|
dvander@396
|
293 |
* |
|
dvander@396
|
294 |
* @param iface Interface string. |
|
dvander@396
|
295 |
* @param ret Optional pointer to store return code. |
|
dvander@396
|
296 |
* @return Generic pointer to the interface, or NULL if |
|
dvander@396
|
297 |
* not found. |
|
dvander@396
|
298 |
*/ |
|
dvander@396
|
299 |
virtual void *OnPhysicsQuery(const char *iface, int *ret) |
|
dvander@282
|
300 |
{ |
|
dvander@396
|
301 |
if (ret) |
|
dvander@396
|
302 |
{ |
|
dvander@396
|
303 |
*ret = IFACE_FAILED; |
|
dvander@396
|
304 |
} |
|
dvander@396
|
305 |
|
|
dvander@396
|
306 |
return NULL; |
|
dvander@282
|
307 |
} |
|
dvander@138
|
308 |
|
|
dvander@396
|
309 |
/** |
|
dvander@396
|
310 |
* @brief Called when the filesystem factory is used through |
|
dvander@396
|
311 |
* Metamod:Source's wrapper. This can be used to provide interfaces to |
|
dvander@396
|
312 |
* other plugins. |
|
dvander@396
|
313 |
* |
|
dvander@396
|
314 |
* If ret is passed, you should fill it with IFACE_OK or IFACE_FAILED. |
|
dvander@396
|
315 |
* |
|
dvander@396
|
316 |
* @param iface Interface string. |
|
dvander@396
|
317 |
* @param ret Optional pointer to store return code. |
|
dvander@396
|
318 |
* @return Generic pointer to the interface, or NULL if not |
|
dvander@396
|
319 |
* found. |
|
dvander@396
|
320 |
*/ |
|
dvander@396
|
321 |
virtual void *OnFileSystemQuery(const char *iface, int *ret) |
|
dvander@282
|
322 |
{ |
|
dvander@396
|
323 |
if (ret) |
|
dvander@396
|
324 |
{ |
|
dvander@396
|
325 |
*ret = IFACE_FAILED; |
|
dvander@396
|
326 |
} |
|
dvander@396
|
327 |
|
|
dvander@396
|
328 |
return NULL; |
|
dvander@282
|
329 |
} |
|
dvander@282
|
330 |
|
|
dvander@396
|
331 |
/** |
|
dvander@396
|
332 |
* @brief Called when the server DLL's factory is used through |
|
dvander@396
|
333 |
* Metamod:Source's wrapper. This can be used to provide interfaces to |
|
dvander@396
|
334 |
* other plugins. |
|
dvander@396
|
335 |
* |
|
dvander@396
|
336 |
* If ret is passed, you should fill it with IFACE_OK or IFACE_FAILED. |
|
dvander@396
|
337 |
* |
|
dvander@396
|
338 |
* @param iface Interface string. |
|
dvander@396
|
339 |
* @param ret Optional pointer to store return code. |
|
dvander@396
|
340 |
* @return Generic pointer to the interface, or NULL if not |
|
dvander@396
|
341 |
* found. |
|
dvander@396
|
342 |
*/ |
|
dvander@396
|
343 |
virtual void *OnGameDLLQuery(const char *iface, int *ret) |
|
dvander@396
|
344 |
{ |
|
dvander@396
|
345 |
if (ret) |
|
dvander@396
|
346 |
{ |
|
dvander@396
|
347 |
*ret = IFACE_FAILED; |
|
dvander@396
|
348 |
} |
|
dvander@396
|
349 |
|
|
dvander@396
|
350 |
return NULL; |
|
dvander@396
|
351 |
} |
|
dvander@138
|
352 |
|
|
dvander@396
|
353 |
/** |
|
dvander@396
|
354 |
* @brief Called when Metamod's own factory is invoked. |
|
dvander@396
|
355 |
* This can be used to provide interfaces to other plugins. |
|
dvander@396
|
356 |
* |
|
dvander@396
|
357 |
* If ret is passed, you should fill it with IFACE_OK or IFACE_FAILED. |
|
dvander@396
|
358 |
* |
|
dvander@396
|
359 |
* @param iface Interface string. |
|
dvander@396
|
360 |
* @param ret Optional pointer to store return code. |
|
dvander@396
|
361 |
* @return Generic pointer to the interface, or NULL if not |
|
dvander@396
|
362 |
* found. |
|
dvander@396
|
363 |
*/ |
|
dvander@396
|
364 |
virtual void *OnMetamodQuery(const char *iface, int *ret) |
|
dvander@282
|
365 |
{ |
|
dvander@396
|
366 |
if (ret) |
|
dvander@396
|
367 |
{ |
|
dvander@396
|
368 |
*ret = IFACE_FAILED; |
|
dvander@396
|
369 |
} |
|
dvander@396
|
370 |
|
|
dvander@396
|
371 |
return NULL; |
|
dvander@282
|
372 |
} |
|
dvander@282
|
373 |
|
|
dvander@396
|
374 |
/** |
|
dvander@396
|
375 |
* @brief Called when Metamod:Source acquires a valid |
|
dvander@396
|
376 |
* IServerPluginCallbacks pointer to be used for hooking by plugins. |
|
dvander@396
|
377 |
* |
|
dvander@396
|
378 |
* This will only be called after a call to ISmmAPI::EnableVSPListener(). |
|
dvander@396
|
379 |
* If called before GameInit, this callback will occur before LevelInit. |
|
dvander@396
|
380 |
* Otherwise, it will be called on the first call after that. |
|
dvander@396
|
381 |
* |
|
dvander@396
|
382 |
* This callback is provided to all plugins regardless of which (or how |
|
dvander@396
|
383 |
* many) called EnableVSPListener(), but only if at least one did in |
|
dvander@396
|
384 |
* fact enable it, and only once for all plugins. That is, a late |
|
dvander@396
|
385 |
* loading plugin should use ISmmAPI::GetVSPInfo() before relying on |
|
dvander@396
|
386 |
* this callback. |
|
dvander@396
|
387 |
* |
|
dvander@485
|
388 |
* This callback is never called if Metamod:Source is in VSP mode. |
|
dvander@485
|
389 |
* If in VSP mode, a VSP instance is automatically and always available |
|
dvander@485
|
390 |
* via ISmmAPI::GetVSPInfo(), which should be called anyway (to handle |
|
dvander@485
|
391 |
* late loading cases). |
|
dvander@485
|
392 |
* |
|
dvander@396
|
393 |
* @param iface Interface pointer. If NULL, then the VSP |
|
dvander@396
|
394 |
* listening construct failed to initialize and |
|
dvander@396
|
395 |
* is not available. |
|
dvander@396
|
396 |
*/ |
|
dvander@396
|
397 |
virtual void OnVSPListening(IServerPluginCallbacks *iface) |
|
dvander@396
|
398 |
{ |
|
dvander@396
|
399 |
} |
|
dvander@282
|
400 |
|
|
dvander@396
|
401 |
/** |
|
dvander@396
|
402 |
* @brief Called when Metamod:Source is about to remove a concommand or |
|
dvander@396
|
403 |
* convar. This can also be called if ISmmAPI::UnregisterConCmdBase is |
|
dvander@396
|
404 |
* used by a plugin. |
|
dvander@396
|
405 |
* |
|
dvander@396
|
406 |
* @param id Id of the plugin that created the concommand or |
|
dvander@396
|
407 |
* convar. |
|
dvander@396
|
408 |
* @param pCommand Pointer to concommand or convar that is being |
|
dvander@396
|
409 |
* removed. |
|
dvander@396
|
410 |
*/ |
|
dvander@396
|
411 |
virtual void OnUnlinkConCommandBase(PluginId id, ConCommandBase *pCommand) |
|
dvander@396
|
412 |
{ |
|
dvander@396
|
413 |
} |
|
dvander@396
|
414 |
}; |
|
dvander@396
|
415 |
} |
|
ds@345
|
416 |
|
|
dvander@396
|
417 |
#if !defined METAMOD_NO_AUTO_NAMESPACE |
|
dvander@396
|
418 |
using namespace SourceMM; |
|
dvander@396
|
419 |
#endif |
|
dvander@396
|
420 |
|
|
dvander@122
|
421 |
#define PL_EXPOSURE CreateInterface |
|
dvander@7
|
422 |
#define PL_EXPOSURE_C "CreateInterface" |
|
dvander@7
|
423 |
|
|
dvander@7
|
424 |
#define PLUGIN_EXPOSE(name, var) \ |
|
dvander@7
|
425 |
ISmmAPI *g_SMAPI = NULL; \ |
|
dvander@9
|
426 |
ISmmPlugin *g_PLAPI = NULL; \ |
|
dvander@9
|
427 |
PluginId g_PLID = (PluginId)0; \ |
|
dvander@7
|
428 |
SourceHook::ISourceHook *g_SHPtr = NULL; \ |
|
dvander@7
|
429 |
SMM_API void *PL_EXPOSURE(const char *name, int *code) { \ |
|
dvander@396
|
430 |
if (name && !strcmp(name, METAMOD_PLAPI_NAME)) { \ |
|
dvander@7
|
431 |
return static_cast<void *>(&var); \ |
|
dvander@7
|
432 |
} \ |
|
dvander@7
|
433 |
return NULL; \ |
|
dvander@7
|
434 |
} |
|
dvander@7
|
435 |
|
|
dvander@7
|
436 |
#define PLUGIN_GLOBALVARS() \ |
|
dvander@7
|
437 |
extern SourceHook::ISourceHook *g_SHPtr; \ |
|
dvander@7
|
438 |
extern ISmmAPI *g_SMAPI; \ |
|
dvander@9
|
439 |
extern ISmmPlugin *g_PLAPI; \ |
|
dvander@9
|
440 |
extern PluginId g_PLID; |
|
dvander@7
|
441 |
|
|
dvander@7
|
442 |
#define PLUGIN_SAVEVARS() \ |
|
dvander@7
|
443 |
g_SMAPI = ismm; \ |
|
dvander@140
|
444 |
g_SHPtr = static_cast<SourceHook::ISourceHook *>(ismm->MetaFactory(MMIFACE_SOURCEHOOK, NULL, NULL)); \ |
|
dvander@9
|
445 |
g_PLAPI = static_cast<ISmmPlugin *>(this); \ |
|
dvander@9
|
446 |
g_PLID = id; |
|
dvander@7
|
447 |
|
|
dvander@122
|
448 |
#define META_LOG g_SMAPI->LogMsg |
|
dvander@375
|
449 |
#define META_REGCMD(name) g_SMAPI->RegisterConCommandBase(g_PLAPI, name##_command) |
|
dvander@375
|
450 |
#define META_REGCVAR(var) g_SMAPI->RegisterConCommandBase(g_PLAPI, var) |
|
dvander@375
|
451 |
#define META_UNREGCMD(name) g_SMAPI->UnregisterConCommandBase(g_PLAPI, name##_command) |
|
dvander@375
|
452 |
#define META_UNREGCVAR(var) g_SMAPI->UnregisterConCommandBase(g_PLAPI, var) |
|
dvander@122
|
453 |
#define META_CONPRINT g_SMAPI->ConPrint |
|
dvander@122
|
454 |
#define META_CONPRINTF g_SMAPI->ConPrintf |
|
dvander@7
|
455 |
|
|
ds@296
|
456 |
/* Probably should use this up above someday */ |
|
ds@66
|
457 |
#define CONCMD_VARNAME(name) name##_command |
|
ds@66
|
458 |
|
|
dvander@7
|
459 |
#if !defined SMM_API |
|
dvander@7
|
460 |
#if defined __WIN32__ || defined _WIN32 || defined WIN32 |
|
dvander@7
|
461 |
#define SMM_API extern "C" __declspec(dllexport) |
|
dvander@7
|
462 |
#elif defined __GNUC__ |
|
dvander@247
|
463 |
#if (__GNUC__ == 4) && (__GNUC_MINOR__ >= 1) |
|
dvander@247
|
464 |
#define SMM_API extern "C" __attribute__ ((visibility("default"))) |
|
dvander@247
|
465 |
#else |
|
dvander@247
|
466 |
#define SMM_API extern "C" |
|
dvander@247
|
467 |
#endif |
|
dvander@7
|
468 |
#endif |
|
dvander@7
|
469 |
#endif //!defined SMM_API |
|
dvander@7
|
470 |
|
|
dvander@251
|
471 |
/** |
|
dvander@251
|
472 |
* @brief Macro for automatically getting a current or newer Valve interface. |
|
dvander@251
|
473 |
* |
|
dvander@251
|
474 |
* @param v_factory Factory method to use from ISmmAPI (such as engineFactory). |
|
dvander@251
|
475 |
* @param v_var Variable name to store into. |
|
dvander@251
|
476 |
* @param v_type Interface type (do not include the pointer/asterisk). |
|
ds@296
|
477 |
* @param v_name Interface name. |
|
dvander@251
|
478 |
*/ |
|
dvander@251
|
479 |
#define GET_V_IFACE_CURRENT(v_factory, v_var, v_type, v_name) \ |
|
dvander@251
|
480 |
v_var = (v_type *)ismm->VInterfaceMatch(ismm->v_factory(), v_name); \ |
|
dvander@251
|
481 |
if (!v_var) \ |
|
dvander@251
|
482 |
{ \ |
|
dvander@251
|
483 |
if (error && maxlen) \ |
|
dvander@251
|
484 |
{ \ |
|
dvander@376
|
485 |
ismm->Format(error, maxlen, "Could not find interface: %s", v_name); \ |
|
dvander@251
|
486 |
} \ |
|
dvander@251
|
487 |
return false; \ |
|
dvander@251
|
488 |
} |
|
dvander@251
|
489 |
|
|
dvander@251
|
490 |
/** |
|
dvander@251
|
491 |
* @brief Same as GET_V_IFACE, except searches for any. |
|
dvander@251
|
492 |
* |
|
ds@296
|
493 |
* @param v_factory Factory method to use from ISmmAPI (such as engineFactory). |
|
ds@296
|
494 |
* @param v_var Variable name to store into. |
|
dvander@251
|
495 |
* @param v_type Interface type (do not include the pointer/asterisk). |
|
ds@296
|
496 |
* @param v_name Interface name. |
|
dvander@251
|
497 |
*/ |
|
dvander@251
|
498 |
#define GET_V_IFACE_ANY(v_factory, v_var, v_type, v_name) \ |
|
dvander@251
|
499 |
v_var = (v_type *)ismm->VInterfaceMatch(ismm->v_factory(), v_name, 0); \ |
|
dvander@251
|
500 |
if (!v_var) \ |
|
dvander@251
|
501 |
{ \ |
|
dvander@251
|
502 |
if (error && maxlen) \ |
|
dvander@251
|
503 |
{ \ |
|
dvander@376
|
504 |
ismm->Format(error, maxlen, "Could not find interface: %s", v_name); \ |
|
dvander@251
|
505 |
} \ |
|
dvander@251
|
506 |
return false; \ |
|
dvander@251
|
507 |
} |
|
dvander@251
|
508 |
|
|
dvander@7
|
509 |
#endif //_INCLUDE_ISMM_PLUGIN_H |
|
dvander@371
|
510 |
|