dvander@24: /* ======== sample_mm ======== dvander@24: * Copyright (C) 2004-2005 Metamod:Source Development Team dvander@24: * No warranties of any kind dvander@24: * dvander@24: * License: zlib/libpng dvander@24: * dvander@24: * Author(s): David "BAILOPAN" Anderson dvander@24: * ============================ dvander@24: */ dvander@24: dvander@12: #include dvander@7: #include "SamplePlugin.h" dvander@68: #include "cvars.h" dvander@7: dvander@7: SamplePlugin g_SamplePlugin; dvander@152: MyListener g_Listener; dvander@7: dvander@7: PLUGIN_EXPOSE(SamplePlugin, g_SamplePlugin); dvander@7: dvander@22: //This has all of the necessary hook declarations. Read it! dvander@22: #include "meta_hooks.h" dvander@22: dvander@152: #define FIND_IFACE(func, assn_var, num_var, name, type) \ dvander@152: do { \ dvander@152: if ( (assn_var=(type)((ismm->func())(name, NULL))) != NULL ) { \ ds@187: num_var = 0; \ dvander@152: break; \ dvander@152: } \ ds@187: if (num_var >= 999) \ dvander@152: break; \ ds@238: } while (( num_var=ismm->FormatIface(name, sizeof(name)-1) )); \ dvander@152: if (!assn_var) { \ dvander@152: if (error) \ dvander@152: snprintf(error, maxlen, "Could not find interface %s", name); \ dvander@152: return false; \ dvander@152: } dvander@152: dvander@22: bool SamplePlugin::LevelInit(const char *pMapName, const char *pMapEntities, const char *pOldLevel, const char *pLandmarkName, bool loadGame, bool background) dvander@22: { dvander@22: META_LOG(g_PLAPI, "LevelInit() called: pMapName=%s", pMapName); dvander@22: RETURN_META_VALUE(MRES_IGNORED, true); dvander@22: } dvander@22: dvander@142: void SamplePlugin::OnLevelShutdown() dvander@142: { dvander@142: META_LOG(g_PLAPI, "OnLevelShutdown() called from listener"); dvander@142: } dvander@142: dvander@22: void SamplePlugin::ServerActivate(edict_t *pEdictList, int edictCount, int clientMax) dvander@22: { dvander@22: META_LOG(g_PLAPI, "ServerActivate() called: edictCount=%d, clientMax=%d", edictCount, clientMax); dvander@22: RETURN_META(MRES_IGNORED); dvander@22: } dvander@22: dvander@22: void SamplePlugin::GameFrame(bool simulating) dvander@22: { dvander@68: //don't log this, it just pumps stuff to the screen ;] dvander@68: //META_LOG(g_PLAPI, "GameFrame() called: simulating=%d", simulating); dvander@22: RETURN_META(MRES_IGNORED); dvander@22: } dvander@22: dvander@22: void SamplePlugin::LevelShutdown( void ) dvander@22: { dvander@22: META_LOG(g_PLAPI, "LevelShutdown() called"); dvander@22: RETURN_META(MRES_IGNORED); dvander@22: } dvander@22: dvander@22: void SamplePlugin::ClientActive(edict_t *pEntity, bool bLoadGame) dvander@22: { dvander@22: META_LOG(g_PLAPI, "ClientActive called: pEntity=%d", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0); dvander@22: RETURN_META(MRES_IGNORED); dvander@22: } dvander@12: dvander@22: void SamplePlugin::ClientDisconnect(edict_t *pEntity) dvander@22: { dvander@22: META_LOG(g_PLAPI, "ClientDisconnect called: pEntity=%d", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0); dvander@22: RETURN_META(MRES_IGNORED); dvander@22: } dvander@22: dvander@22: void SamplePlugin::ClientPutInServer(edict_t *pEntity, char const *playername) dvander@22: { ds@25: META_LOG(g_PLAPI, "ClientPutInServer called: pEntity=%d, playername=%s", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0, playername); dvander@22: RETURN_META(MRES_IGNORED); dvander@22: } dvander@22: dvander@22: void SamplePlugin::SetCommandClient(int index) dvander@22: { dvander@22: META_LOG(g_PLAPI, "SetCommandClient() called: index=%d", index); dvander@22: RETURN_META(MRES_IGNORED); dvander@22: } dvander@22: dvander@22: void SamplePlugin::ClientSettingsChanged(edict_t *pEdict) dvander@22: { dvander@22: META_LOG(g_PLAPI, "ClientSettingsChanged called: pEdict=%d", pEdict ? m_Engine->IndexOfEdict(pEdict) : 0); dvander@22: RETURN_META(MRES_IGNORED); dvander@22: } dvander@22: dvander@22: bool SamplePlugin::ClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen) dvander@22: { dvander@22: META_LOG(g_PLAPI, "ClientConnect called: pEntity=%d, pszName=%s, pszAddress=%s", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0, pszName, pszAddress); dvander@22: RETURN_META_VALUE(MRES_IGNORED, true); dvander@22: } dvander@22: dvander@22: void SamplePlugin::ClientCommand(edict_t *pEntity) dvander@22: { dvander@22: META_LOG(g_PLAPI, "ClientCommand called: pEntity=%d (commandString=%s)", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0, m_Engine->Cmd_Args() ? m_Engine->Cmd_Args() : ""); dvander@22: RETURN_META(MRES_IGNORED); dvander@22: } dvander@12: dvander@68: bool FireEvent_Handler(IGameEvent *event, bool bDontBroadcast) dvander@68: { dvander@68: if (!event || !event->GetName()) dvander@68: RETURN_META_VALUE(MRES_IGNORED, false); dvander@68: dvander@68: const char *name = event->GetName(); dvander@68: dvander@68: META_LOG(g_PLAPI, "FireGameEvent called: name=%s", name); dvander@68: dvander@68: RETURN_META_VALUE(MRES_IGNORED, true); dvander@68: } dvander@68: dvander@140: bool SamplePlugin::Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlen, bool late) dvander@7: { dvander@7: PLUGIN_SAVEVARS(); dvander@7: dvander@152: char iface_buffer[255]; ds@187: int num = 0; dvander@12: ds@238: strcpy(iface_buffer, "ServerGameDLL003"); ds@187: FIND_IFACE(serverFactory, m_ServerDll, num, iface_buffer, IServerGameDLL *); dvander@152: strcpy(iface_buffer, INTERFACEVERSION_VENGINESERVER); ds@187: FIND_IFACE(engineFactory, m_Engine, num, iface_buffer, IVEngineServer *); dvander@152: strcpy(iface_buffer, INTERFACEVERSION_SERVERGAMECLIENTS); ds@187: FIND_IFACE(serverFactory, m_ServerClients, num, iface_buffer, IServerGameClients *); dvander@152: strcpy(iface_buffer, INTERFACEVERSION_GAMEEVENTSMANAGER2); dvander@152: FIND_IFACE(engineFactory, m_GameEventManager, num, iface_buffer, IGameEventManager2 *); dvander@12: dvander@44: META_LOG(g_PLAPI, "Starting plugin.\n"); dvander@44: dvander@152: ismm->AddListener(this, &g_Listener); dvander@152: dvander@68: //Init our cvars/concmds dvander@68: ConCommandBaseMgr::OneTimeInit(&g_Accessor); dvander@68: dvander@22: //We're hooking the following things as POST, in order to seem like Server Plugins. dvander@22: //However, I don't actually know if Valve has done server plugins as POST or not. dvander@22: //Change the last parameter to 'false' in order to change this to PRE. dvander@22: //SH_ADD_HOOK_MEMFUNC means "SourceHook, Add Hook, Member Function". dvander@22: dvander@22: //Hook LevelInit to our function dvander@54: SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelInit, m_ServerDll, &g_SamplePlugin, &SamplePlugin::LevelInit, true); dvander@22: //Hook ServerActivate to our function dvander@54: SH_ADD_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, m_ServerDll, &g_SamplePlugin, &SamplePlugin::ServerActivate, true); dvander@22: //Hook GameFrame to our function dvander@54: SH_ADD_HOOK_MEMFUNC(IServerGameDLL, GameFrame, m_ServerDll, &g_SamplePlugin, &SamplePlugin::GameFrame, true); dvander@22: //Hook LevelShutdown to our function -- this makes more sense as pre I guess dvander@54: SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, m_ServerDll, &g_SamplePlugin, &SamplePlugin::LevelShutdown, false); dvander@22: //Hook ClientActivate to our function dvander@54: SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientActive, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientActive, true); dvander@22: //Hook ClientDisconnect to our function dvander@54: SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientDisconnect, true); dvander@22: //Hook ClientPutInServer to our function dvander@54: SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientPutInServer, true); dvander@22: //Hook SetCommandClient to our function dvander@54: SH_ADD_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, m_ServerClients, &g_SamplePlugin, &SamplePlugin::SetCommandClient, true); dvander@22: //Hook ClientSettingsChanged to our function dvander@54: SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientSettingsChanged, true); dvander@22: dvander@22: //The following functions are pre handled, because that's how they are in IServerPluginCallbacks dvander@22: dvander@22: //Hook ClientConnect to our function dvander@54: SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientConnect, false); dvander@22: //Hook ClientCommand to our function dvander@54: SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientCommand, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientCommand, false); dvander@22: dvander@68: //This hook is a static hook, no member function dvander@68: SH_ADD_HOOK_STATICFUNC(IGameEventManager2, FireEvent, m_GameEventManager, FireEvent_Handler, false); dvander@68: dvander@44: //Get the call class for IVServerEngine so we can safely call functions without dvander@44: // invoking their hooks (when needed). dvander@44: m_Engine_CC = SH_GET_CALLCLASS(m_Engine); dvander@44: dvander@44: SH_CALL(m_Engine_CC, &IVEngineServer::LogPrint)("All hooks started!\n"); dvander@44: dvander@142: g_SMAPI->AddListener(g_PLAPI, this); dvander@142: dvander@7: return true; dvander@7: } dvander@7: dvander@7: bool SamplePlugin::Unload(char *error, size_t maxlen) dvander@7: { dvander@68: //IT IS CRUCIAL THAT YOU REMOVE CVARS. dvander@68: //As of Metamod:Source 1.00-RC2, it will automatically remove them for you. dvander@68: //But this is only if you've registered them correctly! dvander@68: dvander@22: //Make sure we remove any hooks we did... this may not be necessary since dvander@68: //SourceHook is capable of unloading plugins' hooks itself, but just to be safe. dvander@22: dvander@68: SH_REMOVE_HOOK_STATICFUNC(IGameEventManager2, FireEvent, m_GameEventManager, FireEvent_Handler, false); dvander@54: SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelInit, m_ServerDll, &g_SamplePlugin, &SamplePlugin::LevelInit, true); dvander@54: SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, m_ServerDll, &g_SamplePlugin, &SamplePlugin::ServerActivate, true); dvander@54: SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, GameFrame, m_ServerDll, &g_SamplePlugin, &SamplePlugin::GameFrame, true); dvander@54: SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, m_ServerDll, &g_SamplePlugin, &SamplePlugin::LevelShutdown, false); dvander@54: SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientActive, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientActive, true); dvander@54: SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientDisconnect, true); dvander@54: SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientPutInServer, true); dvander@54: SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, m_ServerClients, &g_SamplePlugin, &SamplePlugin::SetCommandClient, true); dvander@54: SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientSettingsChanged, true); dvander@54: SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientConnect, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientConnect, false); dvander@54: SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientCommand, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientCommand, false); dvander@22: dvander@68: //this, sourcehook does not keep track of. we must do this. dvander@44: SH_RELEASE_CALLCLASS(m_Engine_CC); dvander@44: dvander@7: return true; dvander@7: } dvander@12: dvander@20: void SamplePlugin::AllPluginsLoaded() dvander@20: { dvander@22: //we don't really need this for anything other than interplugin communication dvander@22: //and that's not used in this plugin. dvander@22: //If we really wanted, we could override the factories so other plugins can request dvander@22: // interfaces we make. In this callback, the plugin could be assured that either dvander@22: // the interfaces it requires were either loaded in another plugin or not. dvander@20: } dvander@152: dvander@152: void *MyListener::OnMetamodQuery(const char *iface, int *ret) dvander@152: { dvander@152: if (strcmp(iface, "SamplePlugin")==0) dvander@152: { dvander@152: if (ret) dvander@152: *ret = IFACE_OK; dvander@152: return static_cast(&g_SamplePlugin); dvander@152: } dvander@152: dvander@152: if (ret) dvander@152: *ret = IFACE_FAILED; dvander@152: dvander@152: return NULL; dvander@152: } dvander@152: