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