dvander@0: /** dvander@0: * vim: set ts=4 : dvander@0: * =============================================================== dvander@0: * SourceMod, Copyright (C) 2004-2007 AlliedModders LLC. dvander@0: * All rights reserved. dvander@0: * =============================================================== dvander@0: * dvander@0: * This file is part of the SourceMod/SourcePawn SDK. This file may only be dvander@0: * used or modified under the Terms and Conditions of its License Agreement, dvander@0: * which is found in public/licenses/LICENSE.txt. As of this notice, derivative dvander@0: * works must be licensed under the GNU General Public License (version 2 or dvander@0: * greater). A copy of the GPL is included under public/licenses/GPL.txt. dvander@0: * dvander@0: * To view the latest information, see: http://www.sourcemod.net/license.php dvander@0: * dvander@0: * Version: $Id$ dvander@0: */ dvander@0: dvander@0: #ifndef _INCLUDE_SOURCEMOD_EXTENSION_BASESDK_H_ dvander@0: #define _INCLUDE_SOURCEMOD_EXTENSION_BASESDK_H_ dvander@0: dvander@0: /** dvander@0: * @file smsdk_ext.h dvander@0: * @brief Contains wrappers for making Extensions easier to write. dvander@0: */ dvander@0: dvander@0: #include "smsdk_config.h" dvander@0: #include dvander@0: #include dvander@0: #include dvander@0: #include dvander@0: #include dvander@0: #if defined SMEXT_ENABLE_FORWARDSYS dvander@0: #include dvander@0: #endif //SMEXT_ENABLE_FORWARDSYS dvander@0: #if defined SMEXT_ENABLE_PLAYERHELPERS dvander@0: #include dvander@0: #endif //SMEXT_ENABLE_PlAYERHELPERS dvander@0: #if defined SMEXT_ENABLE_DBMANAGER dvander@0: #include dvander@0: #endif //SMEXT_ENABLE_DBMANAGER dvander@0: #if defined SMEXT_ENABLE_GAMECONF dvander@0: #include dvander@0: #endif dvander@0: #if defined SMEXT_ENABLE_MEMUTILS dvander@0: #include dvander@0: #endif dvander@0: #if defined SMEXT_ENABLE_GAMEHELPERS dvander@0: #include dvander@0: #endif dvander@0: #if defined SMEXT_ENABLE_TIMERSYS dvander@0: #include dvander@0: #endif dvander@0: dvander@0: #if defined SMEXT_CONF_METAMOD dvander@0: #include dvander@0: #include dvander@0: #endif dvander@0: dvander@0: using namespace SourceMod; dvander@0: using namespace SourcePawn; dvander@0: dvander@0: class SDKExtension : dvander@0: #if defined SMEXT_CONF_METAMOD dvander@0: public ISmmPlugin, dvander@0: #endif dvander@0: public IExtensionInterface dvander@0: { dvander@0: public: dvander@0: /** Constructor */ dvander@0: SDKExtension(); dvander@0: public: dvander@0: /** dvander@0: * @brief This is called after the initial loading sequence has been processed. dvander@0: * dvander@0: * @param error Error message buffer. dvander@0: * @param maxlength Size of error message buffer. dvander@0: * @param late Whether or not the module was loaded after map load. dvander@0: * @return True to succeed loading, false to fail. dvander@0: */ dvander@0: virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late); dvander@0: dvander@0: /** dvander@0: * @brief This is called right before the extension is unloaded. dvander@0: */ dvander@0: virtual void SDK_OnUnload(); dvander@0: dvander@0: /** dvander@0: * @brief This is called once all known extensions have been loaded. dvander@0: */ dvander@0: virtual void SDK_OnAllLoaded(); dvander@0: dvander@0: /** dvander@0: * @brief Called when the pause state is changed. dvander@0: */ dvander@0: virtual void SDK_OnPauseChange(bool paused); dvander@0: dvander@0: #if defined SMEXT_CONF_METAMOD dvander@0: /** dvander@0: * @brief Called when Metamod is attached, before the extension version is called. dvander@0: * dvander@0: * @param error Error buffer. dvander@0: * @param maxlength Maximum size of error buffer. dvander@0: * @param late Whether or not Metamod considers this a late load. dvander@0: * @return True to succeed, false to fail. dvander@0: */ dvander@0: virtual bool SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late); dvander@0: dvander@0: /** dvander@0: * @brief Called when Metamod is detaching, after the extension version is called. dvander@0: * NOTE: By default this is blocked unless sent from SourceMod. dvander@0: * dvander@0: * @param error Error buffer. dvander@0: * @param maxlength Maximum size of error buffer. dvander@0: * @return True to succeed, false to fail. dvander@0: */ dvander@0: virtual bool SDK_OnMetamodUnload(char *error, size_t maxlength); dvander@0: dvander@0: /** dvander@0: * @brief Called when Metamod's pause state is changing. dvander@0: * NOTE: By default this is blocked unless sent from SourceMod. dvander@0: * dvander@0: * @param paused Pause state being set. dvander@0: * @param error Error buffer. dvander@0: * @param maxlength Maximum size of error buffer. dvander@0: * @return True to succeed, false to fail. dvander@0: */ dvander@0: virtual bool SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength); dvander@0: #endif dvander@0: dvander@0: public: //IExtensionInterface dvander@0: virtual bool OnExtensionLoad(IExtension *me, IShareSys *sys, char *error, size_t maxlength, bool late); dvander@0: virtual void OnExtensionUnload(); dvander@0: virtual void OnExtensionsAllLoaded(); dvander@0: dvander@0: /** Returns whether or not this is a Metamod-based extension */ dvander@0: virtual bool IsMetamodExtension(); dvander@0: dvander@0: /** dvander@0: * @brief Called when the pause state changes. dvander@0: * dvander@0: * @param state True if being paused, false if being unpaused. dvander@0: */ dvander@0: virtual void OnExtensionPauseChange(bool state); dvander@0: dvander@0: /** Returns name */ dvander@0: virtual const char *GetExtensionName(); dvander@0: /** Returns URL */ dvander@0: virtual const char *GetExtensionURL(); dvander@0: /** Returns log tag */ dvander@0: virtual const char *GetExtensionTag(); dvander@0: /** Returns author */ dvander@0: virtual const char *GetExtensionAuthor(); dvander@0: /** Returns version string */ dvander@0: virtual const char *GetExtensionVerString(); dvander@0: /** Returns description string */ dvander@0: virtual const char *GetExtensionDescription(); dvander@0: /** Returns date string */ dvander@0: virtual const char *GetExtensionDateString(); dvander@0: #if defined SMEXT_CONF_METAMOD dvander@0: public: //ISmmPlugin dvander@0: /** Called when the extension is attached to Metamod. */ dvander@0: virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late); dvander@0: /** Returns the author to MM */ dvander@0: virtual const char *GetAuthor(); dvander@0: /** Returns the name to MM */ dvander@0: virtual const char *GetName(); dvander@0: /** Returns the description to MM */ dvander@0: virtual const char *GetDescription(); dvander@0: /** Returns the URL to MM */ dvander@0: virtual const char *GetURL(); dvander@0: /** Returns the license to MM */ dvander@0: virtual const char *GetLicense(); dvander@0: /** Returns the version string to MM */ dvander@0: virtual const char *GetVersion(); dvander@0: /** Returns the date string to MM */ dvander@0: virtual const char *GetDate(); dvander@0: /** Returns the logtag to MM */ dvander@0: virtual const char *GetLogTag(); dvander@0: /** Called on unload */ dvander@0: virtual bool Unload(char *error, size_t maxlength); dvander@0: /** Called on pause */ dvander@0: virtual bool Pause(char *error, size_t maxlength); dvander@0: /** Called on unpause */ dvander@0: virtual bool Unpause(char *error, size_t maxlength); dvander@0: private: dvander@0: bool m_SourceMMLoaded; dvander@0: bool m_WeAreUnloaded; dvander@0: bool m_WeGotPauseChange; dvander@0: #endif dvander@0: }; dvander@0: dvander@0: extern SDKExtension *g_pExtensionIface; dvander@0: extern IExtension *myself; dvander@0: dvander@0: extern IShareSys *g_pShareSys; dvander@0: extern IShareSys *sharesys; /* Note: Newer name */ dvander@0: extern ISourceMod *g_pSM; dvander@0: extern ISourceMod *smutils; /* Note: Newer name */ dvander@0: dvander@0: /* Optional interfaces are below */ dvander@0: #if defined SMEXT_ENABLE_FORWARDSYS dvander@0: extern IForwardManager *g_pForwards; dvander@0: extern IForwardManager *forwards; /* Note: Newer name */ dvander@0: #endif //SMEXT_ENABLE_FORWARDSYS dvander@0: #if defined SMEXT_ENABLE_HANDLESYS dvander@0: extern IHandleSys *g_pHandleSys; dvander@0: extern IHandleSys *handlesys; /* Note: Newer name */ dvander@0: #endif //SMEXT_ENABLE_HANDLESYS dvander@0: #if defined SMEXT_ENABLE_PLAYERHELPERS dvander@0: extern IPlayerManager *playerhelpers; dvander@0: #endif //SMEXT_ENABLE_PLAYERHELPERS dvander@0: #if defined SMEXT_ENABLE_DBMANAGER dvander@0: extern IDBManager *dbi; dvander@0: #endif //SMEXT_ENABLE_DBMANAGER dvander@0: #if defined SMEXT_ENABLE_GAMECONF dvander@0: extern IGameConfigManager *gameconfs; dvander@0: #endif //SMEXT_ENABLE_DBMANAGER dvander@0: #if defined SMEXT_ENABLE_MEMUTILS dvander@0: extern IMemoryUtils *memutils; dvander@0: #endif //SMEXT_ENABLE_DBMANAGER dvander@0: #if defined SMEXT_ENABLE_GAMEHELPERS dvander@0: extern IGameHelpers *gamehelpers; dvander@0: #endif dvander@0: #if defined SMEXT_ENABLE_TIMERSYS dvander@0: extern ITimerSystem *timersys; dvander@0: #endif dvander@0: dvander@0: #if defined SMEXT_CONF_METAMOD dvander@0: PLUGIN_GLOBALVARS(); dvander@0: extern IVEngineServer *engine; dvander@0: extern IServerGameDLL *gamedll; dvander@0: #endif dvander@0: dvander@0: /** Creates a SourceMod interface macro pair */ dvander@0: #define SM_MKIFACE(name) SMINTERFACE_##name##_NAME, SMINTERFACE_##name##_VERSION dvander@0: /** Automates retrieving SourceMod interfaces */ dvander@0: #define SM_GET_IFACE(prefix, addr) \ dvander@0: if (!g_pShareSys->RequestInterface(SM_MKIFACE(prefix), myself, (SMInterface **)&addr)) \ dvander@0: { \ dvander@0: if (error) \ dvander@0: { \ dvander@0: snprintf(error, maxlength, "Could not find interface: %s (version: %d)", SMINTERFACE_##prefix##_NAME, SMINTERFACE_##prefix##_VERSION); \ dvander@0: return false; \ dvander@0: } \ dvander@0: } dvander@0: /** Automates retrieving SourceMod interfaces when needed outside of SDK_OnLoad() */ dvander@0: #define SM_GET_LATE_IFACE(prefix, addr) \ dvander@0: g_pShareSys->RequestInterface(SM_MKIFACE(prefix), myself, (SMInterface **)&addr) dvander@0: /** Validates a SourceMod interface pointer */ dvander@0: #define SM_CHECK_IFACE(prefix, addr) \ dvander@0: if (!addr) \ dvander@0: { \ dvander@0: if (error) \ dvander@0: { \ dvander@0: snprintf(error, maxlength, "Could not find interface: %s", SMINTERFACE_##prefix##_NAME); \ dvander@0: return false; \ dvander@0: } \ dvander@0: } dvander@0: dvander@0: #endif // _INCLUDE_SOURCEMOD_EXTENSION_BASESDK_H_