1 /* ======== sample_mm ========
2 * Copyright (C) 2004-2005 Metamod:Source Development Team
3 * No warranties of any kind
7 * Author(s): David "BAILOPAN" Anderson
8 * ============================
12 #include "SamplePlugin.h"
15 SamplePlugin g_SamplePlugin;
17 PLUGIN_EXPOSE(SamplePlugin, g_SamplePlugin);
19 //This has all of the necessary hook declarations. Read it!
20 #include "meta_hooks.h"
22 bool SamplePlugin::LevelInit(const char *pMapName, const char *pMapEntities, const char *pOldLevel, const char *pLandmarkName, bool loadGame, bool background)
24 META_LOG(g_PLAPI, "LevelInit() called: pMapName=%s", pMapName);
25 RETURN_META_VALUE(MRES_IGNORED, true);
28 void SamplePlugin::OnLevelShutdown()
30 META_LOG(g_PLAPI, "OnLevelShutdown() called from listener");
33 void SamplePlugin::ServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
35 META_LOG(g_PLAPI, "ServerActivate() called: edictCount=%d, clientMax=%d", edictCount, clientMax);
36 RETURN_META(MRES_IGNORED);
39 void SamplePlugin::GameFrame(bool simulating)
41 //don't log this, it just pumps stuff to the screen ;]
42 //META_LOG(g_PLAPI, "GameFrame() called: simulating=%d", simulating);
43 RETURN_META(MRES_IGNORED);
46 void SamplePlugin::LevelShutdown( void )
48 META_LOG(g_PLAPI, "LevelShutdown() called");
49 RETURN_META(MRES_IGNORED);
52 void SamplePlugin::ClientActive(edict_t *pEntity, bool bLoadGame)
54 META_LOG(g_PLAPI, "ClientActive called: pEntity=%d", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0);
55 RETURN_META(MRES_IGNORED);
58 void SamplePlugin::ClientDisconnect(edict_t *pEntity)
60 META_LOG(g_PLAPI, "ClientDisconnect called: pEntity=%d", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0);
61 RETURN_META(MRES_IGNORED);
64 void SamplePlugin::ClientPutInServer(edict_t *pEntity, char const *playername)
66 META_LOG(g_PLAPI, "ClientPutInServer called: pEntity=%d, playername=%s", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0, playername);
67 RETURN_META(MRES_IGNORED);
70 void SamplePlugin::SetCommandClient(int index)
72 META_LOG(g_PLAPI, "SetCommandClient() called: index=%d", index);
73 RETURN_META(MRES_IGNORED);
76 void SamplePlugin::ClientSettingsChanged(edict_t *pEdict)
78 META_LOG(g_PLAPI, "ClientSettingsChanged called: pEdict=%d", pEdict ? m_Engine->IndexOfEdict(pEdict) : 0);
79 RETURN_META(MRES_IGNORED);
82 bool SamplePlugin::ClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
84 META_LOG(g_PLAPI, "ClientConnect called: pEntity=%d, pszName=%s, pszAddress=%s", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0, pszName, pszAddress);
85 RETURN_META_VALUE(MRES_IGNORED, true);
88 void SamplePlugin::ClientCommand(edict_t *pEntity)
90 META_LOG(g_PLAPI, "ClientCommand called: pEntity=%d (commandString=%s)", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0, m_Engine->Cmd_Args() ? m_Engine->Cmd_Args() : "");
91 RETURN_META(MRES_IGNORED);
94 bool FireEvent_Handler(IGameEvent *event, bool bDontBroadcast)
96 if (!event || !event->GetName())
97 RETURN_META_VALUE(MRES_IGNORED, false);
99 const char *name = event->GetName();
101 META_LOG(g_PLAPI, "FireGameEvent called: name=%s", name);
103 RETURN_META_VALUE(MRES_IGNORED, true);
106 bool SamplePlugin::Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlen, bool late)
110 m_ServerDll = (IServerGameDLL *)((ismm->serverFactory())(INTERFACEVERSION_SERVERGAMEDLL, NULL));
111 m_Engine = (IVEngineServer *)((ismm->engineFactory())(INTERFACEVERSION_VENGINESERVER, NULL));
112 m_ServerClients = (IServerGameClients *)((ismm->serverFactory())(INTERFACEVERSION_SERVERGAMECLIENTS, NULL));
113 m_GameEventManager = (IGameEventManager2 *)((ismm->engineFactory())(INTERFACEVERSION_GAMEEVENTSMANAGER2, NULL));
117 snprintf(error, maxlen, "Could not find interface %s", INTERFACEVERSION_SERVERGAMEDLL);
122 snprintf(error, maxlen, "Could not find interface %s", INTERFACEVERSION_VENGINESERVER);
125 if (!m_ServerClients)
127 snprintf(error, maxlen, "Could not find interface %s", INTERFACEVERSION_SERVERGAMECLIENTS);
130 if (!m_GameEventManager)
132 snprintf(error, maxlen, "Could not find interface %s", INTERFACEVERSION_GAMEEVENTSMANAGER2);
136 META_LOG(g_PLAPI, "Starting plugin.\n");
138 //Init our cvars/concmds
139 ConCommandBaseMgr::OneTimeInit(&g_Accessor);
141 //We're hooking the following things as POST, in order to seem like Server Plugins.
142 //However, I don't actually know if Valve has done server plugins as POST or not.
143 //Change the last parameter to 'false' in order to change this to PRE.
144 //SH_ADD_HOOK_MEMFUNC means "SourceHook, Add Hook, Member Function".
146 //Hook LevelInit to our function
147 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelInit, m_ServerDll, &g_SamplePlugin, &SamplePlugin::LevelInit, true);
148 //Hook ServerActivate to our function
149 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, m_ServerDll, &g_SamplePlugin, &SamplePlugin::ServerActivate, true);
150 //Hook GameFrame to our function
151 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, GameFrame, m_ServerDll, &g_SamplePlugin, &SamplePlugin::GameFrame, true);
152 //Hook LevelShutdown to our function -- this makes more sense as pre I guess
153 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, m_ServerDll, &g_SamplePlugin, &SamplePlugin::LevelShutdown, false);
154 //Hook ClientActivate to our function
155 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientActive, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientActive, true);
156 //Hook ClientDisconnect to our function
157 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientDisconnect, true);
158 //Hook ClientPutInServer to our function
159 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientPutInServer, true);
160 //Hook SetCommandClient to our function
161 SH_ADD_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, m_ServerClients, &g_SamplePlugin, &SamplePlugin::SetCommandClient, true);
162 //Hook ClientSettingsChanged to our function
163 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientSettingsChanged, true);
165 //The following functions are pre handled, because that's how they are in IServerPluginCallbacks
167 //Hook ClientConnect to our function
168 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientConnect, false);
169 //Hook ClientCommand to our function
170 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientCommand, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientCommand, false);
172 //This hook is a static hook, no member function
173 SH_ADD_HOOK_STATICFUNC(IGameEventManager2, FireEvent, m_GameEventManager, FireEvent_Handler, false);
175 //Get the call class for IVServerEngine so we can safely call functions without
176 // invoking their hooks (when needed).
177 m_Engine_CC = SH_GET_CALLCLASS(m_Engine);
179 SH_CALL(m_Engine_CC, &IVEngineServer::LogPrint)("All hooks started!\n");
181 g_SMAPI->AddListener(g_PLAPI, this);
186 bool SamplePlugin::Unload(char *error, size_t maxlen)
188 //IT IS CRUCIAL THAT YOU REMOVE CVARS.
189 //As of Metamod:Source 1.00-RC2, it will automatically remove them for you.
190 //But this is only if you've registered them correctly!
192 //Make sure we remove any hooks we did... this may not be necessary since
193 //SourceHook is capable of unloading plugins' hooks itself, but just to be safe.
195 SH_REMOVE_HOOK_STATICFUNC(IGameEventManager2, FireEvent, m_GameEventManager, FireEvent_Handler, false);
196 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelInit, m_ServerDll, &g_SamplePlugin, &SamplePlugin::LevelInit, true);
197 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, m_ServerDll, &g_SamplePlugin, &SamplePlugin::ServerActivate, true);
198 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, GameFrame, m_ServerDll, &g_SamplePlugin, &SamplePlugin::GameFrame, true);
199 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, m_ServerDll, &g_SamplePlugin, &SamplePlugin::LevelShutdown, false);
200 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientActive, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientActive, true);
201 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientDisconnect, true);
202 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientPutInServer, true);
203 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, m_ServerClients, &g_SamplePlugin, &SamplePlugin::SetCommandClient, true);
204 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientSettingsChanged, true);
205 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientConnect, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientConnect, false);
206 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientCommand, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientCommand, false);
208 //this, sourcehook does not keep track of. we must do this.
209 SH_RELEASE_CALLCLASS(m_Engine_CC);
214 void SamplePlugin::AllPluginsLoaded()
216 //we don't really need this for anything other than interplugin communication
217 //and that's not used in this plugin.
218 //If we really wanted, we could override the factories so other plugins can request
219 // interfaces we make. In this callback, the plugin could be assured that either
220 // the interfaces it requires were either loaded in another plugin or not.