Sample plugin can now do anything server plugins can (except NetworkIDValidated callback)
1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2005 Metamod:Source Development Team
3 * No warranties of any kind
7 * Author(s): David "BAILOPAN" Anderson
8 * ============================
11 #ifndef _INCLUDE_ISMM_PLUGIN_H
12 #define _INCLUDE_ISMM_PLUGIN_H
15 * @brief Plugin API interface
19 #include <interface.h>
20 #include <sourcehook/sourcehook.h>
23 #define PLAPI_VERSION 004
24 #define PLAPI_NAME "ISmmPlugin"
28 CreateInterfaceFn engine;
29 CreateInterfaceFn server;
30 CreateInterfaceFn physics;
31 CreateInterfaceFn fileSystem;
35 typedef unsigned int PluginId;
40 virtual int GetApiVersion() { return PLAPI_VERSION; }
43 * @brief Called on plugin load.
45 * @param id Internal id of plugin. Saved globally by PLUGIN_SAVEVARS()
46 * @param ismm External API for SourceMM. Saved globally by PLUGIN_SAVEVARS()
47 * @param list Contains a list of factories. Hook a factory call by setting one equal to your own function.
48 * @param error Error message buffer
49 * @param maxlen Size of error message buffer
50 * @return True on success, return false to request no load.
52 virtual bool Load(PluginId id, ISmmAPI *ismm, factories *list, char *error, size_t maxlen) =0;
54 /* @brief Called on plugin unload.
56 * @param error Error message buffer
57 * @param maxlen Size of error message buffer
58 * @return True on success, return false to request no unload.
60 virtual bool Unload(char *error, size_t maxlen) =0;
62 /* @brief Called on plugin pause.
64 * @param error Error message buffer
65 * @param maxlen Size of error message buffer
66 * @return True on success, return false to request no pause.
68 virtual bool Pause(char *error, size_t maxlen) =0;
70 /* @brief Called on plugin unpause.
72 * @param error Error message buffer
73 * @param maxlen Size of error message buffer
74 * @return True on success, return false to request no unpause.
76 virtual bool Unpause(char *error, size_t maxlen) =0;
78 virtual const char *GetAuthor() =0;
79 virtual const char *GetName() =0;
80 virtual const char *GetDescription() =0;
81 virtual const char *GetURL() =0;
82 virtual const char *GetLicense() =0;
83 virtual const char *GetVersion() =0;
84 virtual const char *GetDate() =0;
85 virtual const char *GetLogTag() =0;
88 * @brief Called when all plugins have been loaded - API version 4
90 virtual void AllPluginsLoaded() =0;
93 #define PL_EXPOSURE CreateInterface
94 #define PL_EXPOSURE_C "CreateInterface"
95 #define PLAPI_MIN_VERSION 002
97 #define PLUGIN_EXPOSE(name, var) \
98 ISmmAPI *g_SMAPI = NULL; \
99 ISmmPlugin *g_PLAPI = NULL; \
100 PluginId g_PLID = (PluginId)0; \
101 SourceHook::ISourceHook *g_SHPtr = NULL; \
102 SMM_API void *PL_EXPOSURE(const char *name, int *code) { \
103 if (name && !strcmp(name, PLAPI_NAME)) { \
104 return static_cast<void *>(&var); \
109 #define PLUGIN_GLOBALVARS() \
110 extern SourceHook::ISourceHook *g_SHPtr; \
111 extern ISmmAPI *g_SMAPI; \
112 extern ISmmPlugin *g_PLAPI; \
113 extern PluginId g_PLID;
115 #define PLUGIN_SAVEVARS() \
117 g_SHPtr = ismm->SourceHook(); \
118 g_PLAPI = static_cast<ISmmPlugin *>(this); \
121 #define FACTORY_RETURN(mres, value) \
122 g_SMAPI->SetLastMetaReturn(mres); \
125 #define META_LOG g_SMAPI->LogMsg
128 #if defined __WIN32__ || defined _WIN32 || defined WIN32
129 #define SMM_API extern "C" __declspec(dllexport)
130 #elif defined __GNUC__
131 #define SMM_API extern "C"
133 #endif //!defined SMM_API
135 #endif //_INCLUDE_ISMM_PLUGIN_H