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