|
dvander@0
|
1 |
/** |
|
dvander@0
|
2 |
* vim: set ts=4 : |
|
dvander@0
|
3 |
* =============================================================== |
|
dvander@0
|
4 |
* SourceMod, Copyright (C) 2004-2007 AlliedModders LLC. |
|
dvander@0
|
5 |
* All rights reserved. |
|
dvander@0
|
6 |
* =============================================================== |
|
dvander@0
|
7 |
* |
|
dvander@0
|
8 |
* This file is part of the SourceMod/SourcePawn SDK. This file may only be |
|
dvander@0
|
9 |
* used or modified under the Terms and Conditions of its License Agreement, |
|
dvander@0
|
10 |
* which is found in public/licenses/LICENSE.txt. As of this notice, derivative |
|
dvander@0
|
11 |
* works must be licensed under the GNU General Public License (version 2 or |
|
dvander@0
|
12 |
* greater). A copy of the GPL is included under public/licenses/GPL.txt. |
|
dvander@0
|
13 |
* |
|
dvander@0
|
14 |
* To view the latest information, see: http://www.sourcemod.net/license.php |
|
dvander@0
|
15 |
* |
|
dvander@0
|
16 |
* Version: $Id$ |
|
dvander@0
|
17 |
*/ |
|
dvander@0
|
18 |
|
|
dvander@0
|
19 |
#ifndef _INCLUDE_SOURCEMOD_EXTENSION_BASESDK_H_ |
|
dvander@0
|
20 |
#define _INCLUDE_SOURCEMOD_EXTENSION_BASESDK_H_ |
|
dvander@0
|
21 |
|
|
dvander@0
|
22 |
/** |
|
dvander@0
|
23 |
* @file smsdk_ext.h |
|
dvander@0
|
24 |
* @brief Contains wrappers for making Extensions easier to write. |
|
dvander@0
|
25 |
*/ |
|
dvander@0
|
26 |
|
|
dvander@0
|
27 |
#include "smsdk_config.h" |
|
dvander@0
|
28 |
#include <IExtensionSys.h> |
|
dvander@0
|
29 |
#include <IHandleSys.h> |
|
dvander@0
|
30 |
#include <sp_vm_api.h> |
|
dvander@0
|
31 |
#include <sm_platform.h> |
|
dvander@0
|
32 |
#include <ISourceMod.h> |
|
dvander@0
|
33 |
#if defined SMEXT_ENABLE_FORWARDSYS |
|
dvander@0
|
34 |
#include <IForwardSys.h> |
|
dvander@0
|
35 |
#endif //SMEXT_ENABLE_FORWARDSYS |
|
dvander@0
|
36 |
#if defined SMEXT_ENABLE_PLAYERHELPERS |
|
dvander@0
|
37 |
#include <IPlayerHelpers.h> |
|
dvander@0
|
38 |
#endif //SMEXT_ENABLE_PlAYERHELPERS |
|
dvander@0
|
39 |
#if defined SMEXT_ENABLE_DBMANAGER |
|
dvander@0
|
40 |
#include <IDBDriver.h> |
|
dvander@0
|
41 |
#endif //SMEXT_ENABLE_DBMANAGER |
|
dvander@0
|
42 |
#if defined SMEXT_ENABLE_GAMECONF |
|
dvander@0
|
43 |
#include <IGameConfigs.h> |
|
dvander@0
|
44 |
#endif |
|
dvander@0
|
45 |
#if defined SMEXT_ENABLE_MEMUTILS |
|
dvander@0
|
46 |
#include <IMemoryUtils.h> |
|
dvander@0
|
47 |
#endif |
|
dvander@0
|
48 |
#if defined SMEXT_ENABLE_GAMEHELPERS |
|
dvander@0
|
49 |
#include <IGameHelpers.h> |
|
dvander@0
|
50 |
#endif |
|
dvander@0
|
51 |
#if defined SMEXT_ENABLE_TIMERSYS |
|
dvander@0
|
52 |
#include <ITimerSystem.h> |
|
dvander@0
|
53 |
#endif |
|
dvander@0
|
54 |
|
|
dvander@0
|
55 |
#if defined SMEXT_CONF_METAMOD |
|
dvander@0
|
56 |
#include <ISmmPlugin.h> |
|
dvander@0
|
57 |
#include <eiface.h> |
|
dvander@0
|
58 |
#endif |
|
dvander@0
|
59 |
|
|
dvander@0
|
60 |
using namespace SourceMod; |
|
dvander@0
|
61 |
using namespace SourcePawn; |
|
dvander@0
|
62 |
|
|
dvander@0
|
63 |
class SDKExtension : |
|
dvander@0
|
64 |
#if defined SMEXT_CONF_METAMOD |
|
dvander@0
|
65 |
public ISmmPlugin, |
|
dvander@0
|
66 |
#endif |
|
dvander@0
|
67 |
public IExtensionInterface |
|
dvander@0
|
68 |
{ |
|
dvander@0
|
69 |
public: |
|
dvander@0
|
70 |
/** Constructor */ |
|
dvander@0
|
71 |
SDKExtension(); |
|
dvander@0
|
72 |
public: |
|
dvander@0
|
73 |
/** |
|
dvander@0
|
74 |
* @brief This is called after the initial loading sequence has been processed. |
|
dvander@0
|
75 |
* |
|
dvander@0
|
76 |
* @param error Error message buffer. |
|
dvander@0
|
77 |
* @param maxlength Size of error message buffer. |
|
dvander@0
|
78 |
* @param late Whether or not the module was loaded after map load. |
|
dvander@0
|
79 |
* @return True to succeed loading, false to fail. |
|
dvander@0
|
80 |
*/ |
|
dvander@0
|
81 |
virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late); |
|
dvander@0
|
82 |
|
|
dvander@0
|
83 |
/** |
|
dvander@0
|
84 |
* @brief This is called right before the extension is unloaded. |
|
dvander@0
|
85 |
*/ |
|
dvander@0
|
86 |
virtual void SDK_OnUnload(); |
|
dvander@0
|
87 |
|
|
dvander@0
|
88 |
/** |
|
dvander@0
|
89 |
* @brief This is called once all known extensions have been loaded. |
|
dvander@0
|
90 |
*/ |
|
dvander@0
|
91 |
virtual void SDK_OnAllLoaded(); |
|
dvander@0
|
92 |
|
|
dvander@0
|
93 |
/** |
|
dvander@0
|
94 |
* @brief Called when the pause state is changed. |
|
dvander@0
|
95 |
*/ |
|
dvander@0
|
96 |
virtual void SDK_OnPauseChange(bool paused); |
|
dvander@0
|
97 |
|
|
dvander@0
|
98 |
#if defined SMEXT_CONF_METAMOD |
|
dvander@0
|
99 |
/** |
|
dvander@0
|
100 |
* @brief Called when Metamod is attached, before the extension version is called. |
|
dvander@0
|
101 |
* |
|
dvander@0
|
102 |
* @param error Error buffer. |
|
dvander@0
|
103 |
* @param maxlength Maximum size of error buffer. |
|
dvander@0
|
104 |
* @param late Whether or not Metamod considers this a late load. |
|
dvander@0
|
105 |
* @return True to succeed, false to fail. |
|
dvander@0
|
106 |
*/ |
|
dvander@0
|
107 |
virtual bool SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late); |
|
dvander@0
|
108 |
|
|
dvander@0
|
109 |
/** |
|
dvander@0
|
110 |
* @brief Called when Metamod is detaching, after the extension version is called. |
|
dvander@0
|
111 |
* NOTE: By default this is blocked unless sent from SourceMod. |
|
dvander@0
|
112 |
* |
|
dvander@0
|
113 |
* @param error Error buffer. |
|
dvander@0
|
114 |
* @param maxlength Maximum size of error buffer. |
|
dvander@0
|
115 |
* @return True to succeed, false to fail. |
|
dvander@0
|
116 |
*/ |
|
dvander@0
|
117 |
virtual bool SDK_OnMetamodUnload(char *error, size_t maxlength); |
|
dvander@0
|
118 |
|
|
dvander@0
|
119 |
/** |
|
dvander@0
|
120 |
* @brief Called when Metamod's pause state is changing. |
|
dvander@0
|
121 |
* NOTE: By default this is blocked unless sent from SourceMod. |
|
dvander@0
|
122 |
* |
|
dvander@0
|
123 |
* @param paused Pause state being set. |
|
dvander@0
|
124 |
* @param error Error buffer. |
|
dvander@0
|
125 |
* @param maxlength Maximum size of error buffer. |
|
dvander@0
|
126 |
* @return True to succeed, false to fail. |
|
dvander@0
|
127 |
*/ |
|
dvander@0
|
128 |
virtual bool SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength); |
|
dvander@0
|
129 |
#endif |
|
dvander@0
|
130 |
|
|
dvander@0
|
131 |
public: //IExtensionInterface |
|
dvander@0
|
132 |
virtual bool OnExtensionLoad(IExtension *me, IShareSys *sys, char *error, size_t maxlength, bool late); |
|
dvander@0
|
133 |
virtual void OnExtensionUnload(); |
|
dvander@0
|
134 |
virtual void OnExtensionsAllLoaded(); |
|
dvander@0
|
135 |
|
|
dvander@0
|
136 |
/** Returns whether or not this is a Metamod-based extension */ |
|
dvander@0
|
137 |
virtual bool IsMetamodExtension(); |
|
dvander@0
|
138 |
|
|
dvander@0
|
139 |
/** |
|
dvander@0
|
140 |
* @brief Called when the pause state changes. |
|
dvander@0
|
141 |
* |
|
dvander@0
|
142 |
* @param state True if being paused, false if being unpaused. |
|
dvander@0
|
143 |
*/ |
|
dvander@0
|
144 |
virtual void OnExtensionPauseChange(bool state); |
|
dvander@0
|
145 |
|
|
dvander@0
|
146 |
/** Returns name */ |
|
dvander@0
|
147 |
virtual const char *GetExtensionName(); |
|
dvander@0
|
148 |
/** Returns URL */ |
|
dvander@0
|
149 |
virtual const char *GetExtensionURL(); |
|
dvander@0
|
150 |
/** Returns log tag */ |
|
dvander@0
|
151 |
virtual const char *GetExtensionTag(); |
|
dvander@0
|
152 |
/** Returns author */ |
|
dvander@0
|
153 |
virtual const char *GetExtensionAuthor(); |
|
dvander@0
|
154 |
/** Returns version string */ |
|
dvander@0
|
155 |
virtual const char *GetExtensionVerString(); |
|
dvander@0
|
156 |
/** Returns description string */ |
|
dvander@0
|
157 |
virtual const char *GetExtensionDescription(); |
|
dvander@0
|
158 |
/** Returns date string */ |
|
dvander@0
|
159 |
virtual const char *GetExtensionDateString(); |
|
dvander@0
|
160 |
#if defined SMEXT_CONF_METAMOD |
|
dvander@0
|
161 |
public: //ISmmPlugin |
|
dvander@0
|
162 |
/** Called when the extension is attached to Metamod. */ |
|
dvander@0
|
163 |
virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late); |
|
dvander@0
|
164 |
/** Returns the author to MM */ |
|
dvander@0
|
165 |
virtual const char *GetAuthor(); |
|
dvander@0
|
166 |
/** Returns the name to MM */ |
|
dvander@0
|
167 |
virtual const char *GetName(); |
|
dvander@0
|
168 |
/** Returns the description to MM */ |
|
dvander@0
|
169 |
virtual const char *GetDescription(); |
|
dvander@0
|
170 |
/** Returns the URL to MM */ |
|
dvander@0
|
171 |
virtual const char *GetURL(); |
|
dvander@0
|
172 |
/** Returns the license to MM */ |
|
dvander@0
|
173 |
virtual const char *GetLicense(); |
|
dvander@0
|
174 |
/** Returns the version string to MM */ |
|
dvander@0
|
175 |
virtual const char *GetVersion(); |
|
dvander@0
|
176 |
/** Returns the date string to MM */ |
|
dvander@0
|
177 |
virtual const char *GetDate(); |
|
dvander@0
|
178 |
/** Returns the logtag to MM */ |
|
dvander@0
|
179 |
virtual const char *GetLogTag(); |
|
dvander@0
|
180 |
/** Called on unload */ |
|
dvander@0
|
181 |
virtual bool Unload(char *error, size_t maxlength); |
|
dvander@0
|
182 |
/** Called on pause */ |
|
dvander@0
|
183 |
virtual bool Pause(char *error, size_t maxlength); |
|
dvander@0
|
184 |
/** Called on unpause */ |
|
dvander@0
|
185 |
virtual bool Unpause(char *error, size_t maxlength); |
|
dvander@0
|
186 |
private: |
|
dvander@0
|
187 |
bool m_SourceMMLoaded; |
|
dvander@0
|
188 |
bool m_WeAreUnloaded; |
|
dvander@0
|
189 |
bool m_WeGotPauseChange; |
|
dvander@0
|
190 |
#endif |
|
dvander@0
|
191 |
}; |
|
dvander@0
|
192 |
|
|
dvander@0
|
193 |
extern SDKExtension *g_pExtensionIface; |
|
dvander@0
|
194 |
extern IExtension *myself; |
|
dvander@0
|
195 |
|
|
dvander@0
|
196 |
extern IShareSys *g_pShareSys; |
|
dvander@0
|
197 |
extern IShareSys *sharesys; /* Note: Newer name */ |
|
dvander@0
|
198 |
extern ISourceMod *g_pSM; |
|
dvander@0
|
199 |
extern ISourceMod *smutils; /* Note: Newer name */ |
|
dvander@0
|
200 |
|
|
dvander@0
|
201 |
/* Optional interfaces are below */ |
|
dvander@0
|
202 |
#if defined SMEXT_ENABLE_FORWARDSYS |
|
dvander@0
|
203 |
extern IForwardManager *g_pForwards; |
|
dvander@0
|
204 |
extern IForwardManager *forwards; /* Note: Newer name */ |
|
dvander@0
|
205 |
#endif //SMEXT_ENABLE_FORWARDSYS |
|
dvander@0
|
206 |
#if defined SMEXT_ENABLE_HANDLESYS |
|
dvander@0
|
207 |
extern IHandleSys *g_pHandleSys; |
|
dvander@0
|
208 |
extern IHandleSys *handlesys; /* Note: Newer name */ |
|
dvander@0
|
209 |
#endif //SMEXT_ENABLE_HANDLESYS |
|
dvander@0
|
210 |
#if defined SMEXT_ENABLE_PLAYERHELPERS |
|
dvander@0
|
211 |
extern IPlayerManager *playerhelpers; |
|
dvander@0
|
212 |
#endif //SMEXT_ENABLE_PLAYERHELPERS |
|
dvander@0
|
213 |
#if defined SMEXT_ENABLE_DBMANAGER |
|
dvander@0
|
214 |
extern IDBManager *dbi; |
|
dvander@0
|
215 |
#endif //SMEXT_ENABLE_DBMANAGER |
|
dvander@0
|
216 |
#if defined SMEXT_ENABLE_GAMECONF |
|
dvander@0
|
217 |
extern IGameConfigManager *gameconfs; |
|
dvander@0
|
218 |
#endif //SMEXT_ENABLE_DBMANAGER |
|
dvander@0
|
219 |
#if defined SMEXT_ENABLE_MEMUTILS |
|
dvander@0
|
220 |
extern IMemoryUtils *memutils; |
|
dvander@0
|
221 |
#endif //SMEXT_ENABLE_DBMANAGER |
|
dvander@0
|
222 |
#if defined SMEXT_ENABLE_GAMEHELPERS |
|
dvander@0
|
223 |
extern IGameHelpers *gamehelpers; |
|
dvander@0
|
224 |
#endif |
|
dvander@0
|
225 |
#if defined SMEXT_ENABLE_TIMERSYS |
|
dvander@0
|
226 |
extern ITimerSystem *timersys; |
|
dvander@0
|
227 |
#endif |
|
dvander@0
|
228 |
|
|
dvander@0
|
229 |
#if defined SMEXT_CONF_METAMOD |
|
dvander@0
|
230 |
PLUGIN_GLOBALVARS(); |
|
dvander@0
|
231 |
extern IVEngineServer *engine; |
|
dvander@0
|
232 |
extern IServerGameDLL *gamedll; |
|
dvander@0
|
233 |
#endif |
|
dvander@0
|
234 |
|
|
dvander@0
|
235 |
/** Creates a SourceMod interface macro pair */ |
|
dvander@0
|
236 |
#define SM_MKIFACE(name) SMINTERFACE_##name##_NAME, SMINTERFACE_##name##_VERSION |
|
dvander@0
|
237 |
/** Automates retrieving SourceMod interfaces */ |
|
dvander@0
|
238 |
#define SM_GET_IFACE(prefix, addr) \ |
|
dvander@0
|
239 |
if (!g_pShareSys->RequestInterface(SM_MKIFACE(prefix), myself, (SMInterface **)&addr)) \ |
|
dvander@0
|
240 |
{ \ |
|
dvander@0
|
241 |
if (error) \ |
|
dvander@0
|
242 |
{ \ |
|
dvander@0
|
243 |
snprintf(error, maxlength, "Could not find interface: %s (version: %d)", SMINTERFACE_##prefix##_NAME, SMINTERFACE_##prefix##_VERSION); \ |
|
dvander@0
|
244 |
return false; \ |
|
dvander@0
|
245 |
} \ |
|
dvander@0
|
246 |
} |
|
dvander@0
|
247 |
/** Automates retrieving SourceMod interfaces when needed outside of SDK_OnLoad() */ |
|
dvander@0
|
248 |
#define SM_GET_LATE_IFACE(prefix, addr) \ |
|
dvander@0
|
249 |
g_pShareSys->RequestInterface(SM_MKIFACE(prefix), myself, (SMInterface **)&addr) |
|
dvander@0
|
250 |
/** Validates a SourceMod interface pointer */ |
|
dvander@0
|
251 |
#define SM_CHECK_IFACE(prefix, addr) \ |
|
dvander@0
|
252 |
if (!addr) \ |
|
dvander@0
|
253 |
{ \ |
|
dvander@0
|
254 |
if (error) \ |
|
dvander@0
|
255 |
{ \ |
|
dvander@0
|
256 |
snprintf(error, maxlength, "Could not find interface: %s", SMINTERFACE_##prefix##_NAME); \ |
|
dvander@0
|
257 |
return false; \ |
|
dvander@0
|
258 |
} \ |
|
dvander@0
|
259 |
} |
|
dvander@0
|
260 |
|
|
dvander@0
|
261 |
#endif // _INCLUDE_SOURCEMOD_EXTENSION_BASESDK_H_ |