sourcemm/sample_mm/SamplePlugin.cpp
author David Anderson <dvander@alliedmods.net>
Thu Oct 06 21:59:10 2005 +0000 (2005-10-06)
changeset 124 b04971393ee4
parent 68 5433659a62ae
child 140 800dc9ba92c5
permissions -rw-r--r--
Finalized versioning and PI
Added QueryRunning() output to meta info/list.
dvander@24
     1
/* ======== sample_mm ========
dvander@24
     2
* Copyright (C) 2004-2005 Metamod:Source Development Team
dvander@24
     3
* No warranties of any kind
dvander@24
     4
*
dvander@24
     5
* License: zlib/libpng
dvander@24
     6
*
dvander@24
     7
* Author(s): David "BAILOPAN" Anderson
dvander@24
     8
* ============================
dvander@24
     9
*/
dvander@24
    10
dvander@12
    11
#include <oslink.h>
dvander@7
    12
#include "SamplePlugin.h"
dvander@68
    13
#include "cvars.h"
dvander@7
    14
dvander@7
    15
SamplePlugin g_SamplePlugin;
dvander@7
    16
dvander@7
    17
PLUGIN_EXPOSE(SamplePlugin, g_SamplePlugin);
dvander@7
    18
dvander@22
    19
//This has all of the necessary hook declarations.  Read it!
dvander@22
    20
#include "meta_hooks.h"
dvander@22
    21
dvander@22
    22
bool SamplePlugin::LevelInit(const char *pMapName, const char *pMapEntities, const char *pOldLevel, const char *pLandmarkName, bool loadGame, bool background)
dvander@22
    23
{
dvander@22
    24
	META_LOG(g_PLAPI, "LevelInit() called: pMapName=%s", pMapName); 
dvander@22
    25
	RETURN_META_VALUE(MRES_IGNORED, true);
dvander@22
    26
}
dvander@22
    27
dvander@22
    28
void SamplePlugin::ServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
dvander@22
    29
{
dvander@22
    30
	META_LOG(g_PLAPI, "ServerActivate() called: edictCount=%d, clientMax=%d", edictCount, clientMax);
dvander@22
    31
	RETURN_META(MRES_IGNORED);
dvander@22
    32
}
dvander@22
    33
dvander@22
    34
void SamplePlugin::GameFrame(bool simulating)
dvander@22
    35
{
dvander@68
    36
	//don't log this, it just pumps stuff to the screen ;]
dvander@68
    37
	//META_LOG(g_PLAPI, "GameFrame() called: simulating=%d", simulating);
dvander@22
    38
	RETURN_META(MRES_IGNORED);
dvander@22
    39
}
dvander@22
    40
dvander@22
    41
void SamplePlugin::LevelShutdown( void )
dvander@22
    42
{
dvander@22
    43
	META_LOG(g_PLAPI, "LevelShutdown() called");
dvander@22
    44
	RETURN_META(MRES_IGNORED);
dvander@22
    45
}
dvander@22
    46
dvander@22
    47
void SamplePlugin::ClientActive(edict_t *pEntity, bool bLoadGame)
dvander@22
    48
{
dvander@22
    49
	META_LOG(g_PLAPI, "ClientActive called: pEntity=%d", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0);
dvander@22
    50
	RETURN_META(MRES_IGNORED);
dvander@22
    51
}
dvander@12
    52
dvander@22
    53
void SamplePlugin::ClientDisconnect(edict_t *pEntity)
dvander@22
    54
{
dvander@22
    55
	META_LOG(g_PLAPI, "ClientDisconnect called: pEntity=%d", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0);
dvander@22
    56
	RETURN_META(MRES_IGNORED);
dvander@22
    57
}
dvander@22
    58
dvander@22
    59
void SamplePlugin::ClientPutInServer(edict_t *pEntity, char const *playername)
dvander@22
    60
{
ds@25
    61
	META_LOG(g_PLAPI, "ClientPutInServer called: pEntity=%d, playername=%s", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0, playername);
dvander@22
    62
	RETURN_META(MRES_IGNORED);
dvander@22
    63
}
dvander@22
    64
dvander@22
    65
void SamplePlugin::SetCommandClient(int index)
dvander@22
    66
{
dvander@22
    67
	META_LOG(g_PLAPI, "SetCommandClient() called: index=%d", index);
dvander@22
    68
	RETURN_META(MRES_IGNORED);
dvander@22
    69
}
dvander@22
    70
dvander@22
    71
void SamplePlugin::ClientSettingsChanged(edict_t *pEdict)
dvander@22
    72
{
dvander@22
    73
	META_LOG(g_PLAPI, "ClientSettingsChanged called: pEdict=%d", pEdict ? m_Engine->IndexOfEdict(pEdict) : 0);
dvander@22
    74
	RETURN_META(MRES_IGNORED);
dvander@22
    75
}
dvander@22
    76
dvander@22
    77
bool SamplePlugin::ClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
dvander@22
    78
{
dvander@22
    79
	META_LOG(g_PLAPI, "ClientConnect called: pEntity=%d, pszName=%s, pszAddress=%s", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0, pszName, pszAddress);
dvander@22
    80
	RETURN_META_VALUE(MRES_IGNORED, true);
dvander@22
    81
}
dvander@22
    82
dvander@22
    83
void SamplePlugin::ClientCommand(edict_t *pEntity)
dvander@22
    84
{
dvander@22
    85
	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
    86
	RETURN_META(MRES_IGNORED);
dvander@22
    87
}
dvander@12
    88
dvander@68
    89
bool FireEvent_Handler(IGameEvent *event, bool bDontBroadcast)
dvander@68
    90
{
dvander@68
    91
	if (!event || !event->GetName())
dvander@68
    92
		RETURN_META_VALUE(MRES_IGNORED, false);
dvander@68
    93
dvander@68
    94
	const char *name = event->GetName();
dvander@68
    95
dvander@68
    96
	META_LOG(g_PLAPI, "FireGameEvent called: name=%s", name); 
dvander@68
    97
dvander@68
    98
	RETURN_META_VALUE(MRES_IGNORED, true);
dvander@68
    99
}
dvander@68
   100
dvander@124
   101
bool SamplePlugin::Load(PluginId id, ISmmAPI *ismm, factories *list, char *error, size_t maxlen, bool late)
dvander@7
   102
{
dvander@7
   103
	PLUGIN_SAVEVARS();
dvander@7
   104
dvander@22
   105
	m_ServerDll = (IServerGameDLL *)((ismm->serverFactory())(INTERFACEVERSION_SERVERGAMEDLL, NULL));
dvander@22
   106
	m_Engine = (IVEngineServer *)((ismm->engineFactory())(INTERFACEVERSION_VENGINESERVER, NULL));
dvander@22
   107
	m_ServerClients = (IServerGameClients *)((ismm->serverFactory())(INTERFACEVERSION_SERVERGAMECLIENTS, NULL));
dvander@68
   108
	m_GameEventManager = (IGameEventManager2 *)((ismm->engineFactory())(INTERFACEVERSION_GAMEEVENTSMANAGER2, NULL));
dvander@12
   109
dvander@22
   110
	if (!m_ServerDll)
dvander@12
   111
	{
dvander@12
   112
		snprintf(error, maxlen, "Could not find interface %s", INTERFACEVERSION_SERVERGAMEDLL);
dvander@12
   113
		return false;
dvander@12
   114
	}
dvander@22
   115
	if (!m_Engine)
dvander@22
   116
	{
dvander@22
   117
		snprintf(error, maxlen, "Could not find interface %s", INTERFACEVERSION_VENGINESERVER);
dvander@22
   118
		return false;
dvander@22
   119
	}
dvander@22
   120
	if (!m_ServerClients)
dvander@22
   121
	{
dvander@22
   122
		snprintf(error, maxlen, "Could not find interface %s", INTERFACEVERSION_SERVERGAMECLIENTS);
dvander@22
   123
		return false;
dvander@22
   124
	}
dvander@68
   125
	if (!m_GameEventManager)
dvander@68
   126
	{
dvander@68
   127
		snprintf(error, maxlen, "Could not find interface %s", INTERFACEVERSION_GAMEEVENTSMANAGER2);
dvander@68
   128
		return false;
dvander@68
   129
	}
dvander@12
   130
dvander@44
   131
	META_LOG(g_PLAPI, "Starting plugin.\n");
dvander@44
   132
dvander@68
   133
	//Init our cvars/concmds
dvander@68
   134
	ConCommandBaseMgr::OneTimeInit(&g_Accessor);
dvander@68
   135
dvander@22
   136
	//We're hooking the following things as POST, in order to seem like Server Plugins.
dvander@22
   137
	//However, I don't actually know if Valve has done server plugins as POST or not.
dvander@22
   138
	//Change the last parameter to 'false' in order to change this to PRE.
dvander@22
   139
	//SH_ADD_HOOK_MEMFUNC means "SourceHook, Add Hook, Member Function".
dvander@22
   140
dvander@22
   141
	//Hook LevelInit to our function
dvander@54
   142
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelInit, m_ServerDll, &g_SamplePlugin, &SamplePlugin::LevelInit, true);
dvander@22
   143
	//Hook ServerActivate to our function
dvander@54
   144
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, m_ServerDll, &g_SamplePlugin, &SamplePlugin::ServerActivate, true);
dvander@22
   145
	//Hook GameFrame to our function
dvander@54
   146
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, GameFrame, m_ServerDll, &g_SamplePlugin, &SamplePlugin::GameFrame, true);
dvander@22
   147
	//Hook LevelShutdown to our function -- this makes more sense as pre I guess
dvander@54
   148
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, m_ServerDll, &g_SamplePlugin, &SamplePlugin::LevelShutdown, false);
dvander@22
   149
	//Hook ClientActivate to our function
dvander@54
   150
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientActive, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientActive, true);
dvander@22
   151
	//Hook ClientDisconnect to our function
dvander@54
   152
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientDisconnect, true);
dvander@22
   153
	//Hook ClientPutInServer to our function
dvander@54
   154
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientPutInServer, true);
dvander@22
   155
	//Hook SetCommandClient to our function
dvander@54
   156
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, m_ServerClients, &g_SamplePlugin, &SamplePlugin::SetCommandClient, true);
dvander@22
   157
	//Hook ClientSettingsChanged to our function
dvander@54
   158
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientSettingsChanged, true);
dvander@22
   159
dvander@22
   160
	//The following functions are pre handled, because that's how they are in IServerPluginCallbacks
dvander@22
   161
dvander@22
   162
	//Hook ClientConnect to our function
dvander@54
   163
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientConnect, false);
dvander@22
   164
	//Hook ClientCommand to our function
dvander@54
   165
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientCommand, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientCommand, false);
dvander@22
   166
dvander@68
   167
	//This hook is a static hook, no member function
dvander@68
   168
	SH_ADD_HOOK_STATICFUNC(IGameEventManager2, FireEvent, m_GameEventManager, FireEvent_Handler, false); 
dvander@68
   169
dvander@44
   170
	//Get the call class for IVServerEngine so we can safely call functions without
dvander@44
   171
	// invoking their hooks (when needed).
dvander@44
   172
	m_Engine_CC = SH_GET_CALLCLASS(m_Engine);
dvander@44
   173
dvander@44
   174
	SH_CALL(m_Engine_CC, &IVEngineServer::LogPrint)("All hooks started!\n");
dvander@44
   175
dvander@7
   176
	return true;
dvander@7
   177
}
dvander@7
   178
dvander@7
   179
bool SamplePlugin::Unload(char *error, size_t maxlen)
dvander@7
   180
{
dvander@68
   181
	//IT IS CRUCIAL THAT YOU REMOVE CVARS.
dvander@68
   182
	//As of Metamod:Source 1.00-RC2, it will automatically remove them for you.
dvander@68
   183
	//But this is only if you've registered them correctly!
dvander@68
   184
    
dvander@22
   185
	//Make sure we remove any hooks we did... this may not be necessary since
dvander@68
   186
	//SourceHook is capable of unloading plugins' hooks itself, but just to be safe.
dvander@22
   187
dvander@68
   188
	SH_REMOVE_HOOK_STATICFUNC(IGameEventManager2, FireEvent, m_GameEventManager, FireEvent_Handler, false); 
dvander@54
   189
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelInit, m_ServerDll, &g_SamplePlugin, &SamplePlugin::LevelInit, true);
dvander@54
   190
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, m_ServerDll, &g_SamplePlugin, &SamplePlugin::ServerActivate, true);
dvander@54
   191
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, GameFrame, m_ServerDll, &g_SamplePlugin, &SamplePlugin::GameFrame, true);
dvander@54
   192
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, m_ServerDll, &g_SamplePlugin, &SamplePlugin::LevelShutdown, false);
dvander@54
   193
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientActive, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientActive, true);
dvander@54
   194
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientDisconnect, true);
dvander@54
   195
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientPutInServer, true);
dvander@54
   196
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, m_ServerClients, &g_SamplePlugin, &SamplePlugin::SetCommandClient, true);
dvander@54
   197
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientSettingsChanged, true);
dvander@54
   198
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientConnect, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientConnect, false);
dvander@54
   199
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientCommand, m_ServerClients, &g_SamplePlugin, &SamplePlugin::ClientCommand, false);
dvander@22
   200
dvander@68
   201
	//this, sourcehook does not keep track of.  we must do this.
dvander@44
   202
	SH_RELEASE_CALLCLASS(m_Engine_CC);
dvander@44
   203
dvander@7
   204
	return true;
dvander@7
   205
}
dvander@12
   206
dvander@20
   207
void SamplePlugin::AllPluginsLoaded()
dvander@20
   208
{
dvander@22
   209
	//we don't really need this for anything other than interplugin communication
dvander@22
   210
	//and that's not used in this plugin.
dvander@22
   211
	//If we really wanted, we could override the factories so other plugins can request
dvander@22
   212
	// interfaces we make.  In this callback, the plugin could be assured that either
dvander@22
   213
	// the interfaces it requires were either loaded in another plugin or not.
dvander@20
   214
}