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