dvander@379: /** dvander@379: * vim: set ts=4 : dvander@379: * ====================================================== dvander@379: * Metamod:Source Sample Plugin dvander@379: * Written by AlliedModders LLC. dvander@379: * ====================================================== dvander@379: * dvander@379: * This software is provided 'as-is', without any express or implied warranty. dvander@379: * In no event will the authors be held liable for any damages arising from dvander@379: * the use of this software. dvander@379: * dvander@379: * This sample plugin is public domain. dvander@379: * dvander@379: * Version: $Id$ dvander@379: */ dvander@379: dvander@379: #include dvander@379: #include "sample_mm.h" dvander@379: dvander@379: SH_DECL_HOOK6(IServerGameDLL, LevelInit, SH_NOATTRIB, 0, bool, char const *, char const *, char const *, char const *, bool, bool); dvander@379: SH_DECL_HOOK3_void(IServerGameDLL, ServerActivate, SH_NOATTRIB, 0, edict_t *, int, int); dvander@379: SH_DECL_HOOK1_void(IServerGameDLL, GameFrame, SH_NOATTRIB, 0, bool); dvander@379: SH_DECL_HOOK0_void(IServerGameDLL, LevelShutdown, SH_NOATTRIB, 0); dvander@379: SH_DECL_HOOK2_void(IServerGameClients, ClientActive, SH_NOATTRIB, 0, edict_t *, bool); dvander@379: SH_DECL_HOOK1_void(IServerGameClients, ClientDisconnect, SH_NOATTRIB, 0, edict_t *); dvander@379: SH_DECL_HOOK2_void(IServerGameClients, ClientPutInServer, SH_NOATTRIB, 0, edict_t *, char const *); dvander@379: SH_DECL_HOOK1_void(IServerGameClients, SetCommandClient, SH_NOATTRIB, 0, int); dvander@379: SH_DECL_HOOK1_void(IServerGameClients, ClientSettingsChanged, SH_NOATTRIB, 0, edict_t *); dvander@379: SH_DECL_HOOK5(IServerGameClients, ClientConnect, SH_NOATTRIB, 0, bool, edict_t *, const char*, const char *, char *, int); dvander@379: SH_DECL_HOOK2(IGameEventManager2, FireEvent, SH_NOATTRIB, 0, bool, IGameEvent *, bool); dvander@379: dvander@497: #if defined ENGINE_ORANGEBOX dvander@379: SH_DECL_HOOK2_void(IServerGameClients, NetworkIDValidated, SH_NOATTRIB, 0, const char *, const char *); dvander@379: SH_DECL_HOOK2_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *, const CCommand &); dvander@497: #elif defined ENGINE_ORIGINAL dvander@379: SH_DECL_HOOK1_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *); dvander@379: #endif dvander@379: dvander@379: StubPlugin g_StubPlugin; dvander@379: IServerGameDLL *server = NULL; dvander@379: IServerGameClients *gameclients = NULL; dvander@379: IVEngineServer *engine = NULL; dvander@379: IServerPluginHelpers *helpers = NULL; dvander@379: IGameEventManager2 *gameevents = NULL; dvander@379: IServerPluginCallbacks *vsp_callbacks = NULL; dvander@379: IPlayerInfoManager *playerinfomanager = NULL; dvander@507: ICvar *icvar = NULL; dvander@379: dvander@497: ConVar sample_cvar("sample_cvar", "42", 0); dvander@497: dvander@497: /** dvander@497: * Something like this is needed to register cvars/CON_COMMANDs. dvander@497: */ dvander@497: class BaseAccessor : public IConCommandBaseAccessor dvander@497: { dvander@497: public: dvander@497: bool RegisterConCommandBase(ConCommandBase *pCommandBase) dvander@497: { dvander@497: /* Always call META_REGCVAR instead of going through the engine. */ dvander@497: return META_REGCVAR(pCommandBase); dvander@497: } dvander@497: } s_BaseAccessor; dvander@497: dvander@379: PLUGIN_EXPOSE(StubPlugin, g_StubPlugin); dvander@379: bool StubPlugin::Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlen, bool late) dvander@379: { dvander@379: PLUGIN_SAVEVARS(); dvander@379: dvander@379: GET_V_IFACE_CURRENT(GetEngineFactory, engine, IVEngineServer, INTERFACEVERSION_VENGINESERVER); dvander@379: GET_V_IFACE_CURRENT(GetEngineFactory, gameevents, IGameEventManager2, INTERFACEVERSION_GAMEEVENTSMANAGER2); dvander@379: GET_V_IFACE_CURRENT(GetEngineFactory, helpers, IServerPluginHelpers, INTERFACEVERSION_ISERVERPLUGINHELPERS); dvander@507: GET_V_IFACE_CURRENT(GetEngineFactory, icvar, ICvar, CVAR_INTERFACE_VERSION); dvander@379: GET_V_IFACE_ANY(GetServerFactory, server, IServerGameDLL, INTERFACEVERSION_SERVERGAMEDLL); dvander@379: GET_V_IFACE_ANY(GetServerFactory, gameclients, IServerGameClients, INTERFACEVERSION_SERVERGAMECLIENTS); dvander@379: GET_V_IFACE_ANY(GetServerFactory, playerinfomanager, IPlayerInfoManager, INTERFACEVERSION_PLAYERINFOMANAGER); dvander@379: dvander@379: META_LOG(g_PLAPI, "Starting plugin."); dvander@379: dvander@497: /* Load the VSP listener. This is usually needed for IServerPluginHelpers. */ dvander@497: #if defined METAMOD_PLAPI_VERSION dvander@379: if ((vsp_callbacks = ismm->GetVSPInfo(NULL)) == NULL) dvander@497: #endif dvander@379: { dvander@379: ismm->AddListener(this, this); dvander@379: ismm->EnableVSPListener(); dvander@379: } dvander@379: dvander@497: SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelInit, server, this, &StubPlugin::Hook_LevelInit, true); dvander@497: SH_ADD_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, server, this, &StubPlugin::Hook_ServerActivate, true); dvander@497: SH_ADD_HOOK_MEMFUNC(IServerGameDLL, GameFrame, server, this, &StubPlugin::Hook_GameFrame, true); dvander@497: SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, server, this, &StubPlugin::Hook_LevelShutdown, false); dvander@497: SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientActive, gameclients, this, &StubPlugin::Hook_ClientActive, true); dvander@497: SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, gameclients, this, &StubPlugin::Hook_ClientDisconnect, true); dvander@497: SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, gameclients, this, &StubPlugin::Hook_ClientPutInServer, true); dvander@497: SH_ADD_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, gameclients, this, &StubPlugin::Hook_SetCommandClient, true); dvander@497: SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, gameclients, this, &StubPlugin::Hook_ClientSettingsChanged, false); dvander@497: SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, gameclients, this, &StubPlugin::Hook_ClientConnect, false); dvander@497: SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientCommand, gameclients, this, &StubPlugin::Hook_ClientCommand, false); dvander@379: dvander@497: #if defined ENGINE_ORIGINAL dvander@497: m_EngineCC = SH_GET_CALLCLASS(engine); dvander@497: #endif dvander@497: dvander@497: ENGINE_CALL(&IVEngineServer::LogPrint)("All hooks started!\n"); dvander@497: dvander@497: #if defined ENGINE_ORANGEBOX dvander@507: g_pCVar = icvar; dvander@497: ConVar_Register(0, &s_BaseAccessor); dvander@497: #elif defined ENGINE_ORIGINAL dvander@497: ConCommandBaseMgr::OneTimeInit(&s_BaseAccessor); dvander@497: #endif dvander@379: dvander@379: return true; dvander@379: } dvander@379: dvander@379: bool StubPlugin::Unload(char *error, size_t maxlen) dvander@379: { dvander@497: SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelInit, server, this, &StubPlugin::Hook_LevelInit, true); dvander@497: SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, server, this, &StubPlugin::Hook_ServerActivate, true); dvander@497: SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, GameFrame, server, this, &StubPlugin::Hook_GameFrame, true); dvander@497: SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, server, this, &StubPlugin::Hook_LevelShutdown, false); dvander@497: SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientActive, gameclients, this, &StubPlugin::Hook_ClientActive, true); dvander@497: SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, gameclients, this, &StubPlugin::Hook_ClientDisconnect, true); dvander@497: SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, gameclients, this, &StubPlugin::Hook_ClientPutInServer, true); dvander@497: SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, gameclients, this, &StubPlugin::Hook_SetCommandClient, true); dvander@497: SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, gameclients, this, &StubPlugin::Hook_ClientSettingsChanged, false); dvander@497: SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientConnect, gameclients, this, &StubPlugin::Hook_ClientConnect, false); dvander@497: SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientCommand, gameclients, this, &StubPlugin::Hook_ClientCommand, false); dvander@497: dvander@497: #if defined ENGINE_ORIGINAL dvander@497: SH_RELEASE_CALLCLASS(m_EngineCC); dvander@497: #endif dvander@379: dvander@379: return true; dvander@379: } dvander@379: dvander@379: void StubPlugin::OnVSPListening(IServerPluginCallbacks *iface) dvander@379: { dvander@379: vsp_callbacks = iface; dvander@379: } dvander@379: dvander@379: void StubPlugin::Hook_ServerActivate(edict_t *pEdictList, int edictCount, int clientMax) dvander@379: { dvander@379: META_LOG(g_PLAPI, "ServerActivate() called: edictCount = %d, clientMax = %d", edictCount, clientMax); dvander@379: } dvander@379: dvander@379: void StubPlugin::AllPluginsLoaded() dvander@379: { dvander@379: /* This is where we'd do stuff that relies on the mod or other plugins dvander@379: * being initialized (for example, cvars added and events registered). dvander@379: */ dvander@379: } dvander@379: dvander@379: void StubPlugin::Hook_ClientActive(edict_t *pEntity, bool bLoadGame) dvander@379: { dvander@379: META_LOG(g_PLAPI, "Hook_ClientActive(%d, %d)", engine->IndexOfEdict(pEntity), bLoadGame); dvander@379: } dvander@379: dvander@497: #if defined ENGINE_ORANGEBOX dvander@379: void StubPlugin::Hook_ClientCommand(edict_t *pEntity, const CCommand &args) dvander@497: #elif defined ENGINE_ORIGINAL dvander@379: void StubPlugin::Hook_ClientCommand(edict_t *pEntity) dvander@379: #endif dvander@379: { dvander@497: #if defined ENGINE_ORIGINAL dvander@379: CCommand args; dvander@379: #endif dvander@379: dvander@379: if (!pEntity || !pEntity->IsFree()) dvander@379: { dvander@379: return; dvander@379: } dvander@379: dvander@379: const char *cmd = args.Arg(0); dvander@379: if (strcmp(cmd, "menu") == 0) dvander@379: { dvander@379: KeyValues *kv = new KeyValues("menu"); dvander@379: kv->SetString("title", "You've got options, hit ESC"); dvander@379: kv->SetInt("level", 1); dvander@379: kv->SetColor("color", Color(255, 0, 0, 255)); dvander@379: kv->SetInt("time", 20); dvander@379: kv->SetString("msg", "Pick an option\nOr don't."); dvander@379: dvander@379: for (int i = 1; i < 9; i++) dvander@379: { dvander@379: char num[10], msg[10], cmd[10]; dvander@497: MM_Format( num, sizeof(num), "%i", i ); dvander@497: MM_Format( msg, sizeof(msg), "Option %i", i ); dvander@497: MM_Format( cmd, sizeof(cmd), "option %i", i ); dvander@379: dvander@379: KeyValues *item1 = kv->FindKey(num, true); dvander@379: item1->SetString("msg", msg); dvander@379: item1->SetString("command", cmd); dvander@379: } dvander@379: dvander@379: helpers->CreateMessage(pEntity, DIALOG_MENU, kv, vsp_callbacks); dvander@379: kv->deleteThis(); dvander@379: RETURN_META(MRES_SUPERCEDE); dvander@379: } dvander@379: else if (strcmp(cmd, "rich") == 0) dvander@379: { dvander@379: KeyValues *kv = new KeyValues("menu"); dvander@379: kv->SetString("title", "A rich message"); dvander@379: kv->SetInt("level", 1); dvander@379: kv->SetInt("time", 20); dvander@379: kv->SetString("msg", "This is a long long long text string.\n\nIt also has line breaks."); dvander@379: dvander@379: helpers->CreateMessage(pEntity, DIALOG_TEXT, kv, vsp_callbacks); dvander@379: kv->deleteThis(); dvander@379: RETURN_META(MRES_SUPERCEDE); dvander@379: } dvander@379: else if (strcmp(cmd, "msg") == 0) dvander@379: { dvander@379: KeyValues *kv = new KeyValues("menu"); dvander@379: kv->SetString("title", "Just a simple hello"); dvander@379: kv->SetInt("level", 1); dvander@379: kv->SetInt("time", 20); dvander@379: dvander@379: helpers->CreateMessage(pEntity, DIALOG_MSG, kv, vsp_callbacks); dvander@379: kv->deleteThis(); dvander@379: RETURN_META(MRES_SUPERCEDE); dvander@379: } dvander@379: else if (strcmp(cmd, "entry") == 0) dvander@379: { dvander@379: KeyValues *kv = new KeyValues("entry"); dvander@379: kv->SetString("title", "Stuff"); dvander@379: kv->SetString("msg", "Enter something"); dvander@379: kv->SetString("command", "say"); // anything they enter into the dialog turns into a say command dvander@379: kv->SetInt("level", 1); dvander@379: kv->SetInt("time", 20); dvander@379: dvander@379: helpers->CreateMessage(pEntity, DIALOG_ENTRY, kv, vsp_callbacks); dvander@379: kv->deleteThis(); dvander@379: RETURN_META(MRES_SUPERCEDE); dvander@379: } dvander@379: } dvander@379: dvander@379: void StubPlugin::Hook_ClientSettingsChanged(edict_t *pEdict) dvander@379: { dvander@379: if (playerinfomanager) dvander@379: { dvander@379: IPlayerInfo *playerinfo = playerinfomanager->GetPlayerInfo(pEdict); dvander@379: dvander@379: const char *name = engine->GetClientConVarValue(engine->IndexOfEdict(pEdict), "name"); dvander@379: dvander@379: if (playerinfo != NULL dvander@379: && name != NULL dvander@497: && strcmp(engine->GetPlayerNetworkIDString(pEdict), "BOT") != 0 dvander@379: && playerinfo->GetName() != NULL dvander@379: && strcmp(name, playerinfo->GetName()) == 0) dvander@379: { dvander@379: char msg[128]; dvander@497: MM_Format(msg, sizeof(msg), "Your name changed to \"%s\" (from \"%s\")\n", name, playerinfo->GetName()); dvander@379: engine->ClientPrintf(pEdict, msg); dvander@379: } dvander@379: } dvander@379: } dvander@379: dvander@379: bool StubPlugin::Hook_ClientConnect(edict_t *pEntity, dvander@379: const char *pszName, dvander@379: const char *pszAddress, dvander@379: char *reject, dvander@379: int maxrejectlen) dvander@379: { dvander@379: META_LOG(g_PLAPI, "Hook_ClientConnect(%d, \"%s\", \"%s\")", engine->IndexOfEdict(pEntity), pszName, pszAddress); dvander@379: dvander@379: return true; dvander@379: } dvander@379: dvander@379: void StubPlugin::Hook_ClientPutInServer(edict_t *pEntity, char const *playername) dvander@379: { dvander@379: KeyValues *kv = new KeyValues( "msg" ); dvander@379: kv->SetString( "title", "Hello" ); dvander@379: kv->SetString( "msg", "Hello there" ); dvander@379: kv->SetColor( "color", Color( 255, 0, 0, 255 )); dvander@379: kv->SetInt( "level", 5); dvander@379: kv->SetInt( "time", 10); dvander@379: helpers->CreateMessage(pEntity, DIALOG_MSG, kv, vsp_callbacks); dvander@379: kv->deleteThis(); dvander@379: } dvander@379: dvander@379: void StubPlugin::Hook_ClientDisconnect(edict_t *pEntity) dvander@379: { dvander@379: META_LOG(g_PLAPI, "Hook_ClientDisconnect(%d)", engine->IndexOfEdict(pEntity)); dvander@379: } dvander@379: dvander@379: void StubPlugin::Hook_GameFrame(bool simulating) dvander@379: { dvander@379: /** dvander@379: * simulating: dvander@379: * *********** dvander@379: * true | game is ticking dvander@379: * false | game is not ticking dvander@379: */ dvander@379: } dvander@379: dvander@379: bool StubPlugin::Hook_LevelInit(const char *pMapName, dvander@379: char const *pMapEntities, dvander@379: char const *pOldLevel, dvander@379: char const *pLandmarkName, dvander@379: bool loadGame, dvander@379: bool background) dvander@379: { dvander@379: META_LOG(g_PLAPI, "Hook_LevelInit(%s)", pMapName); dvander@379: dvander@379: return true; dvander@379: } dvander@379: dvander@379: void StubPlugin::Hook_LevelShutdown() dvander@379: { dvander@379: META_LOG(g_PLAPI, "Hook_LevelShutdown()"); dvander@379: } dvander@379: dvander@379: void StubPlugin::Hook_SetCommandClient(int index) dvander@379: { dvander@379: META_LOG(g_PLAPI, "Hook_SetCommandClient(%d)", index); dvander@379: } dvander@379: dvander@379: bool StubPlugin::Pause(char *error, size_t maxlen) dvander@379: { dvander@379: return true; dvander@379: } dvander@379: dvander@379: bool StubPlugin::Unpause(char *error, size_t maxlen) dvander@379: { dvander@379: return true; dvander@379: } dvander@379: dvander@379: const char *StubPlugin::GetLicense() dvander@379: { dvander@379: return "Public Domain"; dvander@379: } dvander@379: dvander@379: const char *StubPlugin::GetVersion() dvander@379: { dvander@379: return "1.0.0.0"; dvander@379: } dvander@379: dvander@379: const char *StubPlugin::GetDate() dvander@379: { dvander@379: return __DATE__; dvander@379: } dvander@379: dvander@379: const char *StubPlugin::GetLogTag() dvander@379: { dvander@379: return "SAMPLE"; dvander@379: } dvander@379: dvander@379: const char *StubPlugin::GetAuthor() dvander@379: { dvander@379: return "AlliedModders LLC"; dvander@379: } dvander@379: dvander@379: const char *StubPlugin::GetDescription() dvander@379: { dvander@379: return "Sample basic plugin"; dvander@379: } dvander@379: dvander@379: const char *StubPlugin::GetName() dvander@379: { dvander@379: return "Sample Plugin"; dvander@379: } dvander@379: dvander@379: const char *StubPlugin::GetURL() dvander@379: { dvander@379: return "http://www.sourcemm.net/"; dvander@379: }