3 * ======================================================
4 * Metamod:Source Sample Plugin
5 * Written by AlliedModders LLC.
6 * ======================================================
8 * This software is provided 'as-is', without any express or implied warranty.
9 * In no event will the authors be held liable for any damages arising from
10 * the use of this software.
12 * This sample plugin is public domain.
18 #include "sample_mm.h"
20 SH_DECL_HOOK6(IServerGameDLL, LevelInit, SH_NOATTRIB, 0, bool, char const *, char const *, char const *, char const *, bool, bool);
21 SH_DECL_HOOK3_void(IServerGameDLL, ServerActivate, SH_NOATTRIB, 0, edict_t *, int, int);
22 SH_DECL_HOOK1_void(IServerGameDLL, GameFrame, SH_NOATTRIB, 0, bool);
23 SH_DECL_HOOK0_void(IServerGameDLL, LevelShutdown, SH_NOATTRIB, 0);
24 SH_DECL_HOOK2_void(IServerGameClients, ClientActive, SH_NOATTRIB, 0, edict_t *, bool);
25 SH_DECL_HOOK1_void(IServerGameClients, ClientDisconnect, SH_NOATTRIB, 0, edict_t *);
26 SH_DECL_HOOK2_void(IServerGameClients, ClientPutInServer, SH_NOATTRIB, 0, edict_t *, char const *);
27 SH_DECL_HOOK1_void(IServerGameClients, SetCommandClient, SH_NOATTRIB, 0, int);
28 SH_DECL_HOOK1_void(IServerGameClients, ClientSettingsChanged, SH_NOATTRIB, 0, edict_t *);
29 SH_DECL_HOOK5(IServerGameClients, ClientConnect, SH_NOATTRIB, 0, bool, edict_t *, const char*, const char *, char *, int);
30 SH_DECL_HOOK2(IGameEventManager2, FireEvent, SH_NOATTRIB, 0, bool, IGameEvent *, bool);
32 #if defined ENGINE_ORANGEBOX
33 SH_DECL_HOOK2_void(IServerGameClients, NetworkIDValidated, SH_NOATTRIB, 0, const char *, const char *);
34 SH_DECL_HOOK2_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *, const CCommand &);
35 #elif defined ENGINE_ORIGINAL
36 SH_DECL_HOOK1_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *);
39 StubPlugin g_StubPlugin;
40 IServerGameDLL *server = NULL;
41 IServerGameClients *gameclients = NULL;
42 IVEngineServer *engine = NULL;
43 IServerPluginHelpers *helpers = NULL;
44 IGameEventManager2 *gameevents = NULL;
45 IServerPluginCallbacks *vsp_callbacks = NULL;
46 IPlayerInfoManager *playerinfomanager = NULL;
49 ConVar sample_cvar("sample_cvar", "42", 0);
52 * Something like this is needed to register cvars/CON_COMMANDs.
54 class BaseAccessor : public IConCommandBaseAccessor
57 bool RegisterConCommandBase(ConCommandBase *pCommandBase)
59 /* Always call META_REGCVAR instead of going through the engine. */
60 return META_REGCVAR(pCommandBase);
64 PLUGIN_EXPOSE(StubPlugin, g_StubPlugin);
65 bool StubPlugin::Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlen, bool late)
69 GET_V_IFACE_CURRENT(GetEngineFactory, engine, IVEngineServer, INTERFACEVERSION_VENGINESERVER);
70 GET_V_IFACE_CURRENT(GetEngineFactory, gameevents, IGameEventManager2, INTERFACEVERSION_GAMEEVENTSMANAGER2);
71 GET_V_IFACE_CURRENT(GetEngineFactory, helpers, IServerPluginHelpers, INTERFACEVERSION_ISERVERPLUGINHELPERS);
72 GET_V_IFACE_CURRENT(GetEngineFactory, icvar, ICvar, CVAR_INTERFACE_VERSION);
73 GET_V_IFACE_ANY(GetServerFactory, server, IServerGameDLL, INTERFACEVERSION_SERVERGAMEDLL);
74 GET_V_IFACE_ANY(GetServerFactory, gameclients, IServerGameClients, INTERFACEVERSION_SERVERGAMECLIENTS);
75 GET_V_IFACE_ANY(GetServerFactory, playerinfomanager, IPlayerInfoManager, INTERFACEVERSION_PLAYERINFOMANAGER);
77 META_LOG(g_PLAPI, "Starting plugin.");
79 /* Load the VSP listener. This is usually needed for IServerPluginHelpers. */
80 #if defined METAMOD_PLAPI_VERSION
81 if ((vsp_callbacks = ismm->GetVSPInfo(NULL)) == NULL)
84 ismm->AddListener(this, this);
85 ismm->EnableVSPListener();
88 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelInit, server, this, &StubPlugin::Hook_LevelInit, true);
89 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, server, this, &StubPlugin::Hook_ServerActivate, true);
90 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, GameFrame, server, this, &StubPlugin::Hook_GameFrame, true);
91 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, server, this, &StubPlugin::Hook_LevelShutdown, false);
92 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientActive, gameclients, this, &StubPlugin::Hook_ClientActive, true);
93 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, gameclients, this, &StubPlugin::Hook_ClientDisconnect, true);
94 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, gameclients, this, &StubPlugin::Hook_ClientPutInServer, true);
95 SH_ADD_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, gameclients, this, &StubPlugin::Hook_SetCommandClient, true);
96 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, gameclients, this, &StubPlugin::Hook_ClientSettingsChanged, false);
97 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, gameclients, this, &StubPlugin::Hook_ClientConnect, false);
98 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientCommand, gameclients, this, &StubPlugin::Hook_ClientCommand, false);
100 #if defined ENGINE_ORIGINAL
101 m_EngineCC = SH_GET_CALLCLASS(engine);
104 ENGINE_CALL(&IVEngineServer::LogPrint)("All hooks started!\n");
106 #if defined ENGINE_ORANGEBOX
108 ConVar_Register(0, &s_BaseAccessor);
109 #elif defined ENGINE_ORIGINAL
110 ConCommandBaseMgr::OneTimeInit(&s_BaseAccessor);
116 bool StubPlugin::Unload(char *error, size_t maxlen)
118 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelInit, server, this, &StubPlugin::Hook_LevelInit, true);
119 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, server, this, &StubPlugin::Hook_ServerActivate, true);
120 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, GameFrame, server, this, &StubPlugin::Hook_GameFrame, true);
121 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, server, this, &StubPlugin::Hook_LevelShutdown, false);
122 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientActive, gameclients, this, &StubPlugin::Hook_ClientActive, true);
123 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, gameclients, this, &StubPlugin::Hook_ClientDisconnect, true);
124 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, gameclients, this, &StubPlugin::Hook_ClientPutInServer, true);
125 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, gameclients, this, &StubPlugin::Hook_SetCommandClient, true);
126 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, gameclients, this, &StubPlugin::Hook_ClientSettingsChanged, false);
127 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientConnect, gameclients, this, &StubPlugin::Hook_ClientConnect, false);
128 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientCommand, gameclients, this, &StubPlugin::Hook_ClientCommand, false);
130 #if defined ENGINE_ORIGINAL
131 SH_RELEASE_CALLCLASS(m_EngineCC);
137 void StubPlugin::OnVSPListening(IServerPluginCallbacks *iface)
139 vsp_callbacks = iface;
142 void StubPlugin::Hook_ServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
144 META_LOG(g_PLAPI, "ServerActivate() called: edictCount = %d, clientMax = %d", edictCount, clientMax);
147 void StubPlugin::AllPluginsLoaded()
149 /* This is where we'd do stuff that relies on the mod or other plugins
150 * being initialized (for example, cvars added and events registered).
154 void StubPlugin::Hook_ClientActive(edict_t *pEntity, bool bLoadGame)
156 META_LOG(g_PLAPI, "Hook_ClientActive(%d, %d)", engine->IndexOfEdict(pEntity), bLoadGame);
159 #if defined ENGINE_ORANGEBOX
160 void StubPlugin::Hook_ClientCommand(edict_t *pEntity, const CCommand &args)
161 #elif defined ENGINE_ORIGINAL
162 void StubPlugin::Hook_ClientCommand(edict_t *pEntity)
165 #if defined ENGINE_ORIGINAL
169 if (!pEntity || !pEntity->IsFree())
174 const char *cmd = args.Arg(0);
175 if (strcmp(cmd, "menu") == 0)
177 KeyValues *kv = new KeyValues("menu");
178 kv->SetString("title", "You've got options, hit ESC");
179 kv->SetInt("level", 1);
180 kv->SetColor("color", Color(255, 0, 0, 255));
181 kv->SetInt("time", 20);
182 kv->SetString("msg", "Pick an option\nOr don't.");
184 for (int i = 1; i < 9; i++)
186 char num[10], msg[10], cmd[10];
187 MM_Format( num, sizeof(num), "%i", i );
188 MM_Format( msg, sizeof(msg), "Option %i", i );
189 MM_Format( cmd, sizeof(cmd), "option %i", i );
191 KeyValues *item1 = kv->FindKey(num, true);
192 item1->SetString("msg", msg);
193 item1->SetString("command", cmd);
196 helpers->CreateMessage(pEntity, DIALOG_MENU, kv, vsp_callbacks);
198 RETURN_META(MRES_SUPERCEDE);
200 else if (strcmp(cmd, "rich") == 0)
202 KeyValues *kv = new KeyValues("menu");
203 kv->SetString("title", "A rich message");
204 kv->SetInt("level", 1);
205 kv->SetInt("time", 20);
206 kv->SetString("msg", "This is a long long long text string.\n\nIt also has line breaks.");
208 helpers->CreateMessage(pEntity, DIALOG_TEXT, kv, vsp_callbacks);
210 RETURN_META(MRES_SUPERCEDE);
212 else if (strcmp(cmd, "msg") == 0)
214 KeyValues *kv = new KeyValues("menu");
215 kv->SetString("title", "Just a simple hello");
216 kv->SetInt("level", 1);
217 kv->SetInt("time", 20);
219 helpers->CreateMessage(pEntity, DIALOG_MSG, kv, vsp_callbacks);
221 RETURN_META(MRES_SUPERCEDE);
223 else if (strcmp(cmd, "entry") == 0)
225 KeyValues *kv = new KeyValues("entry");
226 kv->SetString("title", "Stuff");
227 kv->SetString("msg", "Enter something");
228 kv->SetString("command", "say"); // anything they enter into the dialog turns into a say command
229 kv->SetInt("level", 1);
230 kv->SetInt("time", 20);
232 helpers->CreateMessage(pEntity, DIALOG_ENTRY, kv, vsp_callbacks);
234 RETURN_META(MRES_SUPERCEDE);
238 void StubPlugin::Hook_ClientSettingsChanged(edict_t *pEdict)
240 if (playerinfomanager)
242 IPlayerInfo *playerinfo = playerinfomanager->GetPlayerInfo(pEdict);
244 const char *name = engine->GetClientConVarValue(engine->IndexOfEdict(pEdict), "name");
246 if (playerinfo != NULL
248 && strcmp(engine->GetPlayerNetworkIDString(pEdict), "BOT") != 0
249 && playerinfo->GetName() != NULL
250 && strcmp(name, playerinfo->GetName()) == 0)
253 MM_Format(msg, sizeof(msg), "Your name changed to \"%s\" (from \"%s\")\n", name, playerinfo->GetName());
254 engine->ClientPrintf(pEdict, msg);
259 bool StubPlugin::Hook_ClientConnect(edict_t *pEntity,
261 const char *pszAddress,
265 META_LOG(g_PLAPI, "Hook_ClientConnect(%d, \"%s\", \"%s\")", engine->IndexOfEdict(pEntity), pszName, pszAddress);
270 void StubPlugin::Hook_ClientPutInServer(edict_t *pEntity, char const *playername)
272 KeyValues *kv = new KeyValues( "msg" );
273 kv->SetString( "title", "Hello" );
274 kv->SetString( "msg", "Hello there" );
275 kv->SetColor( "color", Color( 255, 0, 0, 255 ));
276 kv->SetInt( "level", 5);
277 kv->SetInt( "time", 10);
278 helpers->CreateMessage(pEntity, DIALOG_MSG, kv, vsp_callbacks);
282 void StubPlugin::Hook_ClientDisconnect(edict_t *pEntity)
284 META_LOG(g_PLAPI, "Hook_ClientDisconnect(%d)", engine->IndexOfEdict(pEntity));
287 void StubPlugin::Hook_GameFrame(bool simulating)
292 * true | game is ticking
293 * false | game is not ticking
297 bool StubPlugin::Hook_LevelInit(const char *pMapName,
298 char const *pMapEntities,
299 char const *pOldLevel,
300 char const *pLandmarkName,
304 META_LOG(g_PLAPI, "Hook_LevelInit(%s)", pMapName);
309 void StubPlugin::Hook_LevelShutdown()
311 META_LOG(g_PLAPI, "Hook_LevelShutdown()");
314 void StubPlugin::Hook_SetCommandClient(int index)
316 META_LOG(g_PLAPI, "Hook_SetCommandClient(%d)", index);
319 bool StubPlugin::Pause(char *error, size_t maxlen)
324 bool StubPlugin::Unpause(char *error, size_t maxlen)
329 const char *StubPlugin::GetLicense()
331 return "Public Domain";
334 const char *StubPlugin::GetVersion()
339 const char *StubPlugin::GetDate()
344 const char *StubPlugin::GetLogTag()
349 const char *StubPlugin::GetAuthor()
351 return "AlliedModders LLC";
354 const char *StubPlugin::GetDescription()
356 return "Sample basic plugin";
359 const char *StubPlugin::GetName()
361 return "Sample Plugin";
364 const char *StubPlugin::GetURL()
366 return "http://www.sourcemm.net/";