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