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