|
dvander@9
|
1 |
/* ======== SourceMM ======== |
|
dvander@175
|
2 |
* Copyright (C) 2004-2006 Metamod:Source Development Team |
|
dvander@9
|
3 |
* No warranties of any kind |
|
dvander@9
|
4 |
* |
|
dvander@9
|
5 |
* License: zlib/libpng |
|
dvander@9
|
6 |
* |
|
dvander@9
|
7 |
* Author(s): David "BAILOPAN" Anderson |
|
dvander@9
|
8 |
* ============================ |
|
dvander@9
|
9 |
*/ |
|
dvander@9
|
10 |
|
|
dvander@7
|
11 |
#ifndef _INCLUDE_ISMM_PLUGIN_H |
|
dvander@7
|
12 |
#define _INCLUDE_ISMM_PLUGIN_H |
|
dvander@7
|
13 |
|
|
dvander@9
|
14 |
/** |
|
dvander@9
|
15 |
* @brief Plugin API interface |
|
dvander@9
|
16 |
* @file ISmmPlugin.h |
|
dvander@9
|
17 |
*/ |
|
dvander@9
|
18 |
|
|
dvander@7
|
19 |
#include <interface.h> |
|
dvander@7
|
20 |
#include <sourcehook/sourcehook.h> |
|
dvander@7
|
21 |
#include "ISmmAPI.h" |
|
dvander@7
|
22 |
|
|
dvander@166
|
23 |
#define PLAPI_VERSION 8 |
|
dvander@7
|
24 |
#define PLAPI_NAME "ISmmPlugin" |
|
dvander@7
|
25 |
|
|
dvander@7
|
26 |
class ISmmAPI; |
|
dvander@7
|
27 |
|
|
dvander@7
|
28 |
class ISmmPlugin |
|
dvander@7
|
29 |
{ |
|
dvander@7
|
30 |
public: |
|
dvander@9
|
31 |
virtual int GetApiVersion() { return PLAPI_VERSION; } |
|
dvander@122
|
32 |
virtual ~ISmmPlugin() { } |
|
dvander@9
|
33 |
public: |
|
dvander@7
|
34 |
/** |
|
dvander@7
|
35 |
* @brief Called on plugin load. |
|
dvander@122
|
36 |
* NOTE - As of API 7, this is called as DLLInit() executes - after the parameters are known, but before |
|
dvander@122
|
37 |
* the original GameDLL function is called. Therefore, you cannot hook it, but you don't need to - |
|
dvander@122
|
38 |
* Load() is basically your hook. |
|
dvander@122
|
39 |
* NOTE - As of API 7, you can override factories before the engine and gamedll exchange them. |
|
dvander@122
|
40 |
* However, take care to note that if your plugin is unloaded, and the gamedll/engine have cached |
|
dvander@122
|
41 |
* an interface you've passed, something will definitely crash. Be careful. |
|
dvander@7
|
42 |
* |
|
dvander@122
|
43 |
* @param id Internal id of plugin. Saved globally by PLUGIN_SAVEVARS() |
|
dvander@122
|
44 |
* @param ismm External API for SourceMM. Saved globally by PLUGIN_SAVEVARS() |
|
dvander@122
|
45 |
* @param list Contains a list of factories. Hook a factory call by setting one equal to your own function. |
|
dvander@122
|
46 |
* @param late Set to true if your plugin was loaded late (not at server load). |
|
dvander@7
|
47 |
* @param error Error message buffer |
|
dvander@7
|
48 |
* @param maxlen Size of error message buffer |
|
dvander@122
|
49 |
* @return True if successful, return false to reject the load. |
|
dvander@7
|
50 |
*/ |
|
dvander@138
|
51 |
virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late) =0; |
|
dvander@7
|
52 |
|
|
dvander@122
|
53 |
/** |
|
dvander@122
|
54 |
* @brief Called when your plugin is "queried". This is useful for rejecting a loaded |
|
dvander@122
|
55 |
* state. For example, if your plugin wants to stop operating, it can simply return |
|
dvander@122
|
56 |
* false and copy an error message. This will notify other plugins or MM:S of something |
|
dvander@122
|
57 |
* bad that happened. NOTE - MM:S will not cache the return state, so if you return false, |
|
dvander@122
|
58 |
* your plugin will not actually be paused or unloaded. This callback will be called when: |
|
dvander@122
|
59 |
* - Another plugin requests it |
|
dvander@122
|
60 |
* - Someone types "meta list", it will show up as "REFUSED" |
|
dvander@122
|
61 |
* - When Metamod need to re-check the plugin's status |
|
dvander@122
|
62 |
* - If the plugin does something like overload a factory, Metamod will make sure the Query() returns true |
|
dvander@122
|
63 |
* before calling it. |
|
dvander@122
|
64 |
* Also note that this query will only override Metamod when the plugin is running and not paused. |
|
dvander@7
|
65 |
* |
|
dvander@122
|
66 |
* @param error Buffer for error message. This can be NULL! |
|
dvander@122
|
67 |
* @param maxlen Maximum length of error buffer. |
|
dvander@122
|
68 |
* @return Status code - true for okay, false for badness. |
|
dvander@7
|
69 |
*/ |
|
dvander@122
|
70 |
virtual bool QueryRunning(char *error, size_t maxlen) |
|
dvander@122
|
71 |
{ |
|
dvander@122
|
72 |
return true; |
|
dvander@122
|
73 |
} |
|
dvander@122
|
74 |
|
|
dvander@122
|
75 |
/** |
|
dvander@122
|
76 |
* @brief Called on plugin unload. You can return false if you know your plugin |
|
dvander@122
|
77 |
* is not capable of restoring critical states it modifies. |
|
dvander@122
|
78 |
* |
|
dvander@122
|
79 |
* @param error Error message buffer |
|
dvander@122
|
80 |
* @param maxlen Size of error message buffer |
|
dvander@122
|
81 |
* @return True on success, return false to request no unload. |
|
dvander@122
|
82 |
*/ |
|
dvander@122
|
83 |
virtual bool Unload(char *error, size_t maxlen) |
|
dvander@122
|
84 |
{ |
|
dvander@122
|
85 |
return true; |
|
dvander@122
|
86 |
} |
|
dvander@7
|
87 |
|
|
dvander@30
|
88 |
/** @brief Called on plugin pause. |
|
dvander@7
|
89 |
* |
|
dvander@122
|
90 |
* @param error Error message buffer |
|
dvander@122
|
91 |
* @param maxlen Size of error message buffer |
|
dvander@122
|
92 |
* @return True on success, return false to request no pause. |
|
dvander@7
|
93 |
*/ |
|
dvander@122
|
94 |
virtual bool Pause(char *error, size_t maxlen) |
|
dvander@122
|
95 |
{ |
|
dvander@122
|
96 |
return true; |
|
dvander@122
|
97 |
} |
|
dvander@7
|
98 |
|
|
dvander@30
|
99 |
/** @brief Called on plugin unpause. |
|
dvander@7
|
100 |
* |
|
dvander@122
|
101 |
* @param error Error message buffer |
|
dvander@122
|
102 |
* @param maxlen Size of error message buffer |
|
dvander@122
|
103 |
* @return True on success, return false to request no unpause. |
|
dvander@7
|
104 |
*/ |
|
dvander@122
|
105 |
virtual bool Unpause(char *error, size_t maxlen) |
|
dvander@122
|
106 |
{ |
|
dvander@122
|
107 |
return true; |
|
dvander@122
|
108 |
} |
|
dvander@7
|
109 |
public: |
|
dvander@30
|
110 |
/** @brief Return author as string */ |
|
dvander@7
|
111 |
virtual const char *GetAuthor() =0; |
|
dvander@30
|
112 |
|
|
dvander@30
|
113 |
/** @brief Return plugin name as string */ |
|
dvander@7
|
114 |
virtual const char *GetName() =0; |
|
dvander@30
|
115 |
|
|
dvander@30
|
116 |
/** @brief Return a description as string */ |
|
dvander@7
|
117 |
virtual const char *GetDescription() =0; |
|
dvander@30
|
118 |
|
|
dvander@30
|
119 |
/** @brief Return a URL as string */ |
|
dvander@7
|
120 |
virtual const char *GetURL() =0; |
|
dvander@30
|
121 |
|
|
dvander@30
|
122 |
/** @brief Return quick license code as string */ |
|
dvander@7
|
123 |
virtual const char *GetLicense() =0; |
|
dvander@30
|
124 |
|
|
dvander@30
|
125 |
/** @brief Return version as string */ |
|
dvander@7
|
126 |
virtual const char *GetVersion() =0; |
|
dvander@30
|
127 |
|
|
dvander@30
|
128 |
/** @brief Return author as string */ |
|
dvander@7
|
129 |
virtual const char *GetDate() =0; |
|
dvander@30
|
130 |
|
|
dvander@30
|
131 |
/** @brief Return author as string */ |
|
dvander@7
|
132 |
virtual const char *GetLogTag() =0; |
|
dvander@18
|
133 |
public: |
|
dvander@18
|
134 |
/** |
|
dvander@18
|
135 |
* @brief Called when all plugins have been loaded - API version 4 |
|
dvander@122
|
136 |
* |
|
dvander@122
|
137 |
* This is useful for knowing when it's safe to request things another plugin might have. |
|
dvander@122
|
138 |
* NOTE for API 7 - This is called after DLLInit(). |
|
dvander@18
|
139 |
*/ |
|
dvander@122
|
140 |
virtual void AllPluginsLoaded() |
|
dvander@122
|
141 |
{ |
|
dvander@122
|
142 |
} |
|
dvander@7
|
143 |
}; |
|
dvander@7
|
144 |
|
|
dvander@138
|
145 |
/** |
|
dvander@166
|
146 |
* @brief Added in 1.1 so plugins could listen to specific events |
|
dvander@138
|
147 |
*/ |
|
dvander@138
|
148 |
class IMetamodListener |
|
dvander@138
|
149 |
{ |
|
dvander@138
|
150 |
public: |
|
dvander@138
|
151 |
virtual ~IMetamodListener() { } |
|
dvander@138
|
152 |
public: |
|
dvander@138
|
153 |
virtual void OnPluginLoad(PluginId id) { } |
|
dvander@138
|
154 |
|
|
dvander@138
|
155 |
virtual void OnPluginUnload(PluginId id) { } |
|
dvander@138
|
156 |
|
|
dvander@138
|
157 |
virtual void OnPluginPause(PluginId id) { } |
|
dvander@138
|
158 |
|
|
dvander@138
|
159 |
virtual void OnPluginUnpause(PluginId id) { } |
|
dvander@138
|
160 |
|
|
dvander@138
|
161 |
virtual void OnLevelInit(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background) { } |
|
dvander@138
|
162 |
|
|
dvander@141
|
163 |
virtual void OnLevelShutdown() { } |
|
dvander@141
|
164 |
|
|
dvander@138
|
165 |
virtual void *OnEngineQuery(const char *iface, int *ret) |
|
dvander@138
|
166 |
{ |
|
dvander@138
|
167 |
if (ret) |
|
dvander@138
|
168 |
*ret = IFACE_FAILED; |
|
dvander@138
|
169 |
return NULL; |
|
dvander@138
|
170 |
} |
|
dvander@138
|
171 |
|
|
dvander@138
|
172 |
virtual void *OnPhysicsQuery(const char *iface, int *ret) |
|
dvander@138
|
173 |
{ |
|
dvander@138
|
174 |
if (ret) |
|
dvander@138
|
175 |
*ret = IFACE_FAILED; |
|
dvander@138
|
176 |
return NULL; |
|
dvander@138
|
177 |
} |
|
dvander@138
|
178 |
|
|
dvander@138
|
179 |
virtual void *OnFileSystemQuery(const char *iface, int *ret) |
|
dvander@138
|
180 |
{ |
|
dvander@138
|
181 |
if (ret) |
|
dvander@138
|
182 |
*ret = IFACE_FAILED; |
|
dvander@138
|
183 |
return NULL; |
|
dvander@138
|
184 |
} |
|
dvander@138
|
185 |
|
|
dvander@138
|
186 |
virtual void *OnGameDLLQuery(const char *iface, int *ret) |
|
dvander@138
|
187 |
{ |
|
dvander@138
|
188 |
if (ret) |
|
dvander@138
|
189 |
*ret = IFACE_FAILED; |
|
dvander@138
|
190 |
return NULL; |
|
dvander@138
|
191 |
} |
|
dvander@138
|
192 |
|
|
dvander@138
|
193 |
virtual void *OnMetamodQuery(const char *iface, int *ret) |
|
dvander@138
|
194 |
{ |
|
dvander@138
|
195 |
if (ret) |
|
dvander@138
|
196 |
*ret = IFACE_FAILED; |
|
dvander@138
|
197 |
return NULL; |
|
dvander@138
|
198 |
} |
|
dvander@138
|
199 |
}; |
|
dvander@138
|
200 |
|
|
dvander@122
|
201 |
#define PL_EXPOSURE CreateInterface |
|
dvander@7
|
202 |
#define PL_EXPOSURE_C "CreateInterface" |
|
dvander@7
|
203 |
|
|
dvander@7
|
204 |
#define PLUGIN_EXPOSE(name, var) \ |
|
dvander@7
|
205 |
ISmmAPI *g_SMAPI = NULL; \ |
|
dvander@9
|
206 |
ISmmPlugin *g_PLAPI = NULL; \ |
|
dvander@9
|
207 |
PluginId g_PLID = (PluginId)0; \ |
|
dvander@7
|
208 |
SourceHook::ISourceHook *g_SHPtr = NULL; \ |
|
dvander@7
|
209 |
SMM_API void *PL_EXPOSURE(const char *name, int *code) { \ |
|
dvander@7
|
210 |
if (name && !strcmp(name, PLAPI_NAME)) { \ |
|
dvander@7
|
211 |
return static_cast<void *>(&var); \ |
|
dvander@7
|
212 |
} \ |
|
dvander@7
|
213 |
return NULL; \ |
|
dvander@7
|
214 |
} |
|
dvander@7
|
215 |
|
|
dvander@7
|
216 |
#define PLUGIN_GLOBALVARS() \ |
|
dvander@7
|
217 |
extern SourceHook::ISourceHook *g_SHPtr; \ |
|
dvander@7
|
218 |
extern ISmmAPI *g_SMAPI; \ |
|
dvander@9
|
219 |
extern ISmmPlugin *g_PLAPI; \ |
|
dvander@9
|
220 |
extern PluginId g_PLID; |
|
dvander@7
|
221 |
|
|
dvander@7
|
222 |
#define PLUGIN_SAVEVARS() \ |
|
dvander@7
|
223 |
g_SMAPI = ismm; \ |
|
dvander@140
|
224 |
g_SHPtr = static_cast<SourceHook::ISourceHook *>(ismm->MetaFactory(MMIFACE_SOURCEHOOK, NULL, NULL)); \ |
|
dvander@9
|
225 |
g_PLAPI = static_cast<ISmmPlugin *>(this); \ |
|
dvander@9
|
226 |
g_PLID = id; |
|
dvander@7
|
227 |
|
|
dvander@122
|
228 |
#define META_LOG g_SMAPI->LogMsg |
|
dvander@67
|
229 |
#define META_REGCMD(name) g_SMAPI->RegisterConCmdBase(g_PLAPI, name##_command) |
|
dvander@67
|
230 |
#define META_REGCVAR(var) g_SMAPI->RegisterConCmdBase(g_PLAPI, var) |
|
dvander@67
|
231 |
#define META_UNREGCMD(name) g_SMAPI->UnregisterConCmdBase(g_PLAPI, name##_command) |
|
dvander@67
|
232 |
#define META_UNREGCVAR(var) g_SMAPI->UnregisterConCmdBase(g_PLAPI, var) |
|
dvander@122
|
233 |
#define META_CONPRINT g_SMAPI->ConPrint |
|
dvander@122
|
234 |
#define META_CONPRINTF g_SMAPI->ConPrintf |
|
dvander@7
|
235 |
|
|
dvander@67
|
236 |
//probably should use this up above someday |
|
ds@66
|
237 |
#define CONCMD_VARNAME(name) name##_command |
|
ds@66
|
238 |
|
|
dvander@7
|
239 |
#if !defined SMM_API |
|
dvander@7
|
240 |
#if defined __WIN32__ || defined _WIN32 || defined WIN32 |
|
dvander@7
|
241 |
#define SMM_API extern "C" __declspec(dllexport) |
|
dvander@7
|
242 |
#elif defined __GNUC__ |
|
dvander@7
|
243 |
#define SMM_API extern "C" |
|
dvander@7
|
244 |
#endif |
|
dvander@7
|
245 |
#endif //!defined SMM_API |
|
dvander@7
|
246 |
|
|
dvander@7
|
247 |
#endif //_INCLUDE_ISMM_PLUGIN_H |