sourcemm/sample_mm/SamplePlugin.cpp
author David Anderson <dvander@alliedmods.net>
Mon Apr 18 23:33:44 2005 +0000 (2005-04-18)
changeset 22 3fe8e457c5a2
parent 20 7d2ff2c0999b
child 24 9f04f9fb2485
permissions -rw-r--r--
Sample plugin can now do anything server plugins can (except NetworkIDValidated callback)
dvander@12
     1
#include <oslink.h>
dvander@7
     2
#include "SamplePlugin.h"
dvander@7
     3
dvander@7
     4
SamplePlugin g_SamplePlugin;
dvander@7
     5
dvander@7
     6
PLUGIN_EXPOSE(SamplePlugin, g_SamplePlugin);
dvander@7
     7
dvander@22
     8
//This has all of the necessary hook declarations.  Read it!
dvander@22
     9
#include "meta_hooks.h"
dvander@22
    10
dvander@22
    11
bool SamplePlugin::LevelInit(const char *pMapName, const char *pMapEntities, const char *pOldLevel, const char *pLandmarkName, bool loadGame, bool background)
dvander@22
    12
{
dvander@22
    13
	META_LOG(g_PLAPI, "LevelInit() called: pMapName=%s", pMapName); 
dvander@22
    14
	RETURN_META_VALUE(MRES_IGNORED, true);
dvander@22
    15
}
dvander@22
    16
dvander@22
    17
void SamplePlugin::ServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
dvander@22
    18
{
dvander@22
    19
	META_LOG(g_PLAPI, "ServerActivate() called: edictCount=%d, clientMax=%d", edictCount, clientMax);
dvander@22
    20
	RETURN_META(MRES_IGNORED);
dvander@22
    21
}
dvander@22
    22
dvander@22
    23
void SamplePlugin::GameFrame(bool simulating)
dvander@22
    24
{
dvander@22
    25
	META_LOG(g_PLAPI, "GameFrame() called: simulating=%d", simulating);
dvander@22
    26
	RETURN_META(MRES_IGNORED);
dvander@22
    27
}
dvander@22
    28
dvander@22
    29
void SamplePlugin::LevelShutdown( void )
dvander@22
    30
{
dvander@22
    31
	META_LOG(g_PLAPI, "LevelShutdown() called");
dvander@22
    32
	RETURN_META(MRES_IGNORED);
dvander@22
    33
}
dvander@22
    34
dvander@22
    35
void SamplePlugin::ClientActive(edict_t *pEntity, bool bLoadGame)
dvander@22
    36
{
dvander@22
    37
	META_LOG(g_PLAPI, "ClientActive called: pEntity=%d", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0);
dvander@22
    38
	RETURN_META(MRES_IGNORED);
dvander@22
    39
}
dvander@12
    40
dvander@22
    41
void SamplePlugin::ClientDisconnect(edict_t *pEntity)
dvander@22
    42
{
dvander@22
    43
	META_LOG(g_PLAPI, "ClientDisconnect called: pEntity=%d", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0);
dvander@22
    44
	RETURN_META(MRES_IGNORED);
dvander@22
    45
}
dvander@22
    46
dvander@22
    47
void SamplePlugin::ClientPutInServer(edict_t *pEntity, char const *playername)
dvander@22
    48
{
dvander@22
    49
	META_LOG(g_PLAPI, "ClientActivate called: pEntity=%d, playername=%s", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0, playername);
dvander@22
    50
	RETURN_META(MRES_IGNORED);
dvander@22
    51
}
dvander@22
    52
dvander@22
    53
void SamplePlugin::SetCommandClient(int index)
dvander@22
    54
{
dvander@22
    55
	META_LOG(g_PLAPI, "SetCommandClient() called: index=%d", index);
dvander@22
    56
	RETURN_META(MRES_IGNORED);
dvander@22
    57
}
dvander@22
    58
dvander@22
    59
void SamplePlugin::ClientSettingsChanged(edict_t *pEdict)
dvander@22
    60
{
dvander@22
    61
	META_LOG(g_PLAPI, "ClientSettingsChanged called: pEdict=%d", pEdict ? m_Engine->IndexOfEdict(pEdict) : 0);
dvander@22
    62
	RETURN_META(MRES_IGNORED);
dvander@22
    63
}
dvander@22
    64
dvander@22
    65
bool SamplePlugin::ClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
dvander@22
    66
{
dvander@22
    67
	META_LOG(g_PLAPI, "ClientConnect called: pEntity=%d, pszName=%s, pszAddress=%s", pEntity ? m_Engine->IndexOfEdict(pEntity) : 0, pszName, pszAddress);
dvander@22
    68
	RETURN_META_VALUE(MRES_IGNORED, true);
dvander@22
    69
}
dvander@22
    70
dvander@22
    71
void SamplePlugin::ClientCommand(edict_t *pEntity)
dvander@22
    72
{
dvander@22
    73
	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
    74
	RETURN_META(MRES_IGNORED);
dvander@22
    75
}
dvander@12
    76
dvander@7
    77
bool SamplePlugin::Load(PluginId id, ISmmAPI *ismm, factories *list, char *error, size_t maxlen)
dvander@7
    78
{
dvander@7
    79
	PLUGIN_SAVEVARS();
dvander@7
    80
dvander@22
    81
	m_ServerDll = (IServerGameDLL *)((ismm->serverFactory())(INTERFACEVERSION_SERVERGAMEDLL, NULL));
dvander@22
    82
	m_Engine = (IVEngineServer *)((ismm->engineFactory())(INTERFACEVERSION_VENGINESERVER, NULL));
dvander@22
    83
	m_ServerClients = (IServerGameClients *)((ismm->serverFactory())(INTERFACEVERSION_SERVERGAMECLIENTS, NULL));
dvander@12
    84
dvander@22
    85
	if (!m_ServerDll)
dvander@12
    86
	{
dvander@12
    87
		snprintf(error, maxlen, "Could not find interface %s", INTERFACEVERSION_SERVERGAMEDLL);
dvander@12
    88
		return false;
dvander@12
    89
	}
dvander@22
    90
	if (!m_Engine)
dvander@22
    91
	{
dvander@22
    92
		snprintf(error, maxlen, "Could not find interface %s", INTERFACEVERSION_VENGINESERVER);
dvander@22
    93
		return false;
dvander@22
    94
	}
dvander@22
    95
	if (!m_ServerClients)
dvander@22
    96
	{
dvander@22
    97
		snprintf(error, maxlen, "Could not find interface %s", INTERFACEVERSION_SERVERGAMECLIENTS);
dvander@22
    98
		return false;
dvander@22
    99
	}
dvander@12
   100
dvander@22
   101
	//We're hooking the following things as POST, in order to seem like Server Plugins.
dvander@22
   102
	//However, I don't actually know if Valve has done server plugins as POST or not.
dvander@22
   103
	//Change the last parameter to 'false' in order to change this to PRE.
dvander@22
   104
	//SH_ADD_HOOK_MEMFUNC means "SourceHook, Add Hook, Member Function".
dvander@22
   105
dvander@22
   106
	//Hook LevelInit to our function
dvander@22
   107
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelInit, m_ServerDll, &g_SamplePlugin, LevelInit, true);
dvander@22
   108
	//Hook ServerActivate to our function
dvander@22
   109
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, m_ServerDll, &g_SamplePlugin, ServerActivate, true);
dvander@22
   110
	//Hook GameFrame to our function
dvander@22
   111
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, GameFrame, m_ServerDll, &g_SamplePlugin, GameFrame, true);
dvander@22
   112
	//Hook LevelShutdown to our function -- this makes more sense as pre I guess
dvander@22
   113
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, m_ServerDll, &g_SamplePlugin, LevelShutdown, false);
dvander@22
   114
	//Hook ClientActivate to our function
dvander@22
   115
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientActive, m_ServerClients, &g_SamplePlugin, ClientActive, true);
dvander@22
   116
	//Hook ClientDisconnect to our function
dvander@22
   117
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, m_ServerClients, &g_SamplePlugin, ClientDisconnect, true);
dvander@22
   118
	//Hook ClientPutInServer to our function
dvander@22
   119
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, m_ServerClients, &g_SamplePlugin, ClientPutInServer, true);
dvander@22
   120
	//Hook SetCommandClient to our function
dvander@22
   121
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, m_ServerClients, &g_SamplePlugin, SetCommandClient, true);
dvander@22
   122
	//Hook ClientSettingsChanged to our function
dvander@22
   123
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, m_ServerClients, &g_SamplePlugin, ClientSettingsChanged, true);
dvander@22
   124
dvander@22
   125
	//The following functions are pre handled, because that's how they are in IServerPluginCallbacks
dvander@22
   126
dvander@22
   127
	//Hook ClientConnect to our function
dvander@22
   128
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, m_ServerClients, &g_SamplePlugin, ClientConnect, false);
dvander@22
   129
	//Hook ClientCommand to our function
dvander@22
   130
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientCommand, m_ServerClients, &g_SamplePlugin, ClientCommand, false);
dvander@22
   131
dvander@22
   132
	//Now, importantly, SourceHook has modified the layout of the above classes.
dvander@22
   133
	//If we want to call them in their original state (i.e., without invoking hooks)
dvander@22
   134
	// we must request a "Call Class" from SourceHook.
dvander@22
   135
	m_ServerClients_CC = SH_GET_CALLCLASS(IServerGameClients, m_ServerClients);
dvander@22
   136
	m_ServerDll = SH_GET_CALLCLASS(IServerGameDLL, m_ServerDll);
dvander@12
   137
dvander@7
   138
	return true;
dvander@7
   139
}
dvander@7
   140
dvander@7
   141
bool SamplePlugin::Unload(char *error, size_t maxlen)
dvander@7
   142
{
dvander@22
   143
	//Make sure we remove any hooks we did... this may not be necessary since
dvander@22
   144
	// SourceHook is capable of unloading plugins' hooks itself, but just to be safe.
dvander@22
   145
dvander@22
   146
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelInit, m_ServerDll, &g_SamplePlugin, LevelInit, true);
dvander@22
   147
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, m_ServerDll, &g_SamplePlugin, ServerActivate, true);
dvander@22
   148
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, GameFrame, m_ServerDll, &g_SamplePlugin, GameFrame, true);
dvander@22
   149
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, m_ServerDll, &g_SamplePlugin, LevelShutdown, false);
dvander@22
   150
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientActive, m_ServerClients, &g_SamplePlugin, ClientActive, true);
dvander@22
   151
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, m_ServerClients, &g_SamplePlugin, ClientDisconnect, true);
dvander@22
   152
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, m_ServerClients, &g_SamplePlugin, ClientPutInServer, true);
dvander@22
   153
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, m_ServerClients, &g_SamplePlugin, SetCommandClient, true);
dvander@22
   154
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, m_ServerClients, &g_SamplePlugin, ClientSettingsChanged, true);
dvander@22
   155
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientConnect, m_ServerClients, &g_SamplePlugin, ClientConnect, false);
dvander@22
   156
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientCommand, m_ServerClients, &g_SamplePlugin, ClientCommand, false);
dvander@22
   157
dvander@22
   158
	//Lastly, release the call classes we requested
dvander@22
   159
	SH_RELEASE_CALLCLASS(m_ServerDll_CC);
dvander@22
   160
	SH_RELEASE_CALLCLASS(m_ServerClients_CC);
dvander@22
   161
dvander@7
   162
	return true;
dvander@7
   163
}
dvander@12
   164
dvander@20
   165
void SamplePlugin::AllPluginsLoaded()
dvander@20
   166
{
dvander@22
   167
	//we don't really need this for anything other than interplugin communication
dvander@22
   168
	//and that's not used in this plugin.
dvander@22
   169
	//If we really wanted, we could override the factories so other plugins can request
dvander@22
   170
	// interfaces we make.  In this callback, the plugin could be assured that either
dvander@22
   171
	// the interfaces it requires were either loaded in another plugin or not.
dvander@20
   172
}