sample_mm/sample_mm.cpp
author Scott Ehlert <ds@alliedmods.net>
Sat May 17 16:11:02 2014 -0500 (2014-05-17)
changeset 913 a883c17f1f86
parent 678 c676a9ce0320
permissions -rw-r--r--
Force reconfigures to happen every time.
dvander@379
     1
/**
ds@678
     2
 * vim: set ts=4 sw=4 tw=99 noet :
dvander@379
     3
 * ======================================================
dvander@379
     4
 * Metamod:Source Sample Plugin
dvander@379
     5
 * Written by AlliedModders LLC.
dvander@379
     6
 * ======================================================
dvander@379
     7
 *
dvander@379
     8
 * This software is provided 'as-is', without any express or implied warranty.
dvander@379
     9
 * In no event will the authors be held liable for any damages arising from 
dvander@379
    10
 * the use of this software.
dvander@379
    11
 *
dvander@379
    12
 * This sample plugin is public domain.
dvander@379
    13
 */
dvander@379
    14
dvander@379
    15
#include <stdio.h>
dvander@379
    16
#include "sample_mm.h"
dvander@379
    17
dvander@379
    18
SH_DECL_HOOK6(IServerGameDLL, LevelInit, SH_NOATTRIB, 0, bool, char const *, char const *, char const *, char const *, bool, bool);
dvander@379
    19
SH_DECL_HOOK3_void(IServerGameDLL, ServerActivate, SH_NOATTRIB, 0, edict_t *, int, int);
dvander@379
    20
SH_DECL_HOOK1_void(IServerGameDLL, GameFrame, SH_NOATTRIB, 0, bool);
dvander@379
    21
SH_DECL_HOOK0_void(IServerGameDLL, LevelShutdown, SH_NOATTRIB, 0);
dvander@379
    22
SH_DECL_HOOK2_void(IServerGameClients, ClientActive, SH_NOATTRIB, 0, edict_t *, bool);
dvander@379
    23
SH_DECL_HOOK1_void(IServerGameClients, ClientDisconnect, SH_NOATTRIB, 0, edict_t *);
dvander@379
    24
SH_DECL_HOOK2_void(IServerGameClients, ClientPutInServer, SH_NOATTRIB, 0, edict_t *, char const *);
dvander@379
    25
SH_DECL_HOOK1_void(IServerGameClients, SetCommandClient, SH_NOATTRIB, 0, int);
dvander@379
    26
SH_DECL_HOOK1_void(IServerGameClients, ClientSettingsChanged, SH_NOATTRIB, 0, edict_t *);
dvander@379
    27
SH_DECL_HOOK5(IServerGameClients, ClientConnect, SH_NOATTRIB, 0, bool, edict_t *, const char*, const char *, char *, int);
dvander@379
    28
SH_DECL_HOOK2(IGameEventManager2, FireEvent, SH_NOATTRIB, 0, bool, IGameEvent *, bool);
dvander@379
    29
ds@605
    30
#if SOURCE_ENGINE >= SE_ORANGEBOX
dvander@379
    31
SH_DECL_HOOK2_void(IServerGameClients, NetworkIDValidated, SH_NOATTRIB, 0, const char *, const char *);
dvander@379
    32
SH_DECL_HOOK2_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *, const CCommand &);
ds@605
    33
#else
dvander@379
    34
SH_DECL_HOOK1_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *);
dvander@379
    35
#endif
dvander@379
    36
ds@605
    37
SamplePlugin g_SamplePlugin;
dvander@379
    38
IServerGameDLL *server = NULL;
dvander@379
    39
IServerGameClients *gameclients = NULL;
dvander@379
    40
IVEngineServer *engine = NULL;
dvander@379
    41
IServerPluginHelpers *helpers = NULL;
dvander@379
    42
IGameEventManager2 *gameevents = NULL;
dvander@379
    43
IServerPluginCallbacks *vsp_callbacks = NULL;
dvander@379
    44
IPlayerInfoManager *playerinfomanager = NULL;
dvander@507
    45
ICvar *icvar = NULL;
ds@605
    46
CGlobalVars *gpGlobals = NULL;
dvander@379
    47
dvander@497
    48
ConVar sample_cvar("sample_cvar", "42", 0);
dvander@497
    49
dvander@497
    50
/** 
dvander@497
    51
 * Something like this is needed to register cvars/CON_COMMANDs.
dvander@497
    52
 */
dvander@497
    53
class BaseAccessor : public IConCommandBaseAccessor
dvander@497
    54
{
dvander@497
    55
public:
dvander@497
    56
	bool RegisterConCommandBase(ConCommandBase *pCommandBase)
dvander@497
    57
	{
dvander@497
    58
		/* Always call META_REGCVAR instead of going through the engine. */
dvander@497
    59
		return META_REGCVAR(pCommandBase);
dvander@497
    60
	}
dvander@497
    61
} s_BaseAccessor;
dvander@497
    62
ds@605
    63
PLUGIN_EXPOSE(SamplePlugin, g_SamplePlugin);
ds@605
    64
bool SamplePlugin::Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlen, bool late)
dvander@379
    65
{
dvander@379
    66
	PLUGIN_SAVEVARS();
dvander@379
    67
dvander@379
    68
	GET_V_IFACE_CURRENT(GetEngineFactory, engine, IVEngineServer, INTERFACEVERSION_VENGINESERVER);
dvander@379
    69
	GET_V_IFACE_CURRENT(GetEngineFactory, gameevents, IGameEventManager2, INTERFACEVERSION_GAMEEVENTSMANAGER2);
dvander@379
    70
	GET_V_IFACE_CURRENT(GetEngineFactory, helpers, IServerPluginHelpers, INTERFACEVERSION_ISERVERPLUGINHELPERS);
dvander@507
    71
	GET_V_IFACE_CURRENT(GetEngineFactory, icvar, ICvar, CVAR_INTERFACE_VERSION);
dvander@379
    72
	GET_V_IFACE_ANY(GetServerFactory, server, IServerGameDLL, INTERFACEVERSION_SERVERGAMEDLL);
dvander@379
    73
	GET_V_IFACE_ANY(GetServerFactory, gameclients, IServerGameClients, INTERFACEVERSION_SERVERGAMECLIENTS);
dvander@379
    74
	GET_V_IFACE_ANY(GetServerFactory, playerinfomanager, IPlayerInfoManager, INTERFACEVERSION_PLAYERINFOMANAGER);
dvander@379
    75
ds@605
    76
	gpGlobals = ismm->GetCGlobals();
ds@605
    77
dvander@379
    78
	META_LOG(g_PLAPI, "Starting plugin.");
dvander@379
    79
dvander@497
    80
	/* Load the VSP listener.  This is usually needed for IServerPluginHelpers. */
dvander@379
    81
	if ((vsp_callbacks = ismm->GetVSPInfo(NULL)) == NULL)
dvander@379
    82
	{
dvander@379
    83
		ismm->AddListener(this, this);
dvander@379
    84
		ismm->EnableVSPListener();
dvander@379
    85
	}
dvander@379
    86
ds@605
    87
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelInit, server, this, &SamplePlugin::Hook_LevelInit, true);
ds@605
    88
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, server, this, &SamplePlugin::Hook_ServerActivate, true);
ds@605
    89
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, GameFrame, server, this, &SamplePlugin::Hook_GameFrame, true);
ds@605
    90
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, server, this, &SamplePlugin::Hook_LevelShutdown, false);
ds@605
    91
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientActive, gameclients, this, &SamplePlugin::Hook_ClientActive, true);
ds@605
    92
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, gameclients, this, &SamplePlugin::Hook_ClientDisconnect, true);
ds@605
    93
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, gameclients, this, &SamplePlugin::Hook_ClientPutInServer, true);
ds@605
    94
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, gameclients, this, &SamplePlugin::Hook_SetCommandClient, true);
ds@605
    95
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, gameclients, this, &SamplePlugin::Hook_ClientSettingsChanged, false);
ds@605
    96
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, gameclients, this, &SamplePlugin::Hook_ClientConnect, false);
ds@605
    97
	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientCommand, gameclients, this, &SamplePlugin::Hook_ClientCommand, false);
dvander@379
    98
ds@678
    99
	ENGINE_CALL(LogPrint)("All hooks started!\n");
dvander@497
   100
ds@605
   101
#if SOURCE_ENGINE >= SE_ORANGEBOX
dvander@507
   102
	g_pCVar = icvar;
dvander@497
   103
	ConVar_Register(0, &s_BaseAccessor);
ds@605
   104
#else
dvander@497
   105
	ConCommandBaseMgr::OneTimeInit(&s_BaseAccessor);
dvander@497
   106
#endif
dvander@379
   107
dvander@379
   108
	return true;
dvander@379
   109
}
dvander@379
   110
ds@605
   111
bool SamplePlugin::Unload(char *error, size_t maxlen)
dvander@379
   112
{
ds@605
   113
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelInit, server, this, &SamplePlugin::Hook_LevelInit, true);
ds@605
   114
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, server, this, &SamplePlugin::Hook_ServerActivate, true);
ds@605
   115
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, GameFrame, server, this, &SamplePlugin::Hook_GameFrame, true);
ds@605
   116
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, server, this, &SamplePlugin::Hook_LevelShutdown, false);
ds@605
   117
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientActive, gameclients, this, &SamplePlugin::Hook_ClientActive, true);
ds@605
   118
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, gameclients, this, &SamplePlugin::Hook_ClientDisconnect, true);
ds@605
   119
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, gameclients, this, &SamplePlugin::Hook_ClientPutInServer, true);
ds@605
   120
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, gameclients, this, &SamplePlugin::Hook_SetCommandClient, true);
ds@605
   121
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, gameclients, this, &SamplePlugin::Hook_ClientSettingsChanged, false);
ds@605
   122
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientConnect, gameclients, this, &SamplePlugin::Hook_ClientConnect, false);
ds@605
   123
	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientCommand, gameclients, this, &SamplePlugin::Hook_ClientCommand, false);
dvander@497
   124
dvander@379
   125
	return true;
dvander@379
   126
}
dvander@379
   127
ds@605
   128
void SamplePlugin::OnVSPListening(IServerPluginCallbacks *iface)
dvander@379
   129
{
dvander@379
   130
	vsp_callbacks = iface;
dvander@379
   131
}
dvander@379
   132
ds@605
   133
void SamplePlugin::Hook_ServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
dvander@379
   134
{
dvander@379
   135
	META_LOG(g_PLAPI, "ServerActivate() called: edictCount = %d, clientMax = %d", edictCount, clientMax);
dvander@379
   136
}
dvander@379
   137
ds@605
   138
void SamplePlugin::AllPluginsLoaded()
dvander@379
   139
{
dvander@379
   140
	/* This is where we'd do stuff that relies on the mod or other plugins 
dvander@379
   141
	 * being initialized (for example, cvars added and events registered).
dvander@379
   142
	 */
dvander@379
   143
}
dvander@379
   144
ds@605
   145
void SamplePlugin::Hook_ClientActive(edict_t *pEntity, bool bLoadGame)
dvander@379
   146
{
ds@605
   147
	META_LOG(g_PLAPI, "Hook_ClientActive(%d, %d)", IndexOfEdict(pEntity), bLoadGame);
dvander@379
   148
}
dvander@379
   149
ds@605
   150
#if SOURCE_ENGINE >= SE_ORANGEBOX
ds@605
   151
void SamplePlugin::Hook_ClientCommand(edict_t *pEntity, const CCommand &args)
ds@605
   152
#else
ds@605
   153
void SamplePlugin::Hook_ClientCommand(edict_t *pEntity)
dvander@379
   154
#endif
dvander@379
   155
{
ds@637
   156
#if SOURCE_ENGINE <= SE_DARKMESSIAH
dvander@379
   157
	CCommand args;
dvander@379
   158
#endif
dvander@379
   159
dvander@509
   160
	if (!pEntity || pEntity->IsFree())
dvander@379
   161
	{
dvander@379
   162
		return;
dvander@379
   163
	}
dvander@379
   164
dvander@379
   165
	const char *cmd = args.Arg(0);
dvander@379
   166
	if (strcmp(cmd, "menu") == 0)
dvander@379
   167
	{
dvander@379
   168
		KeyValues *kv = new KeyValues("menu");
dvander@379
   169
		kv->SetString("title", "You've got options, hit ESC");
dvander@379
   170
		kv->SetInt("level", 1);
dvander@379
   171
		kv->SetColor("color", Color(255, 0, 0, 255));
dvander@379
   172
		kv->SetInt("time", 20);
dvander@379
   173
		kv->SetString("msg", "Pick an option\nOr don't.");
dvander@379
   174
dvander@379
   175
		for (int i = 1; i < 9; i++)
dvander@379
   176
		{
dvander@379
   177
			char num[10], msg[10], cmd[10];
dvander@497
   178
			MM_Format( num, sizeof(num), "%i", i );
dvander@497
   179
			MM_Format( msg, sizeof(msg), "Option %i", i );
dvander@497
   180
			MM_Format( cmd, sizeof(cmd), "option %i", i );
dvander@379
   181
dvander@379
   182
			KeyValues *item1 = kv->FindKey(num, true);
dvander@379
   183
			item1->SetString("msg", msg);
dvander@379
   184
			item1->SetString("command", cmd);
dvander@379
   185
		}
dvander@379
   186
dvander@379
   187
		helpers->CreateMessage(pEntity, DIALOG_MENU, kv, vsp_callbacks);
dvander@379
   188
		kv->deleteThis();
dvander@379
   189
		RETURN_META(MRES_SUPERCEDE);
dvander@379
   190
	}
dvander@379
   191
	else if (strcmp(cmd, "rich") == 0)
dvander@379
   192
	{
dvander@379
   193
		KeyValues *kv = new KeyValues("menu");
dvander@379
   194
		kv->SetString("title", "A rich message");
dvander@379
   195
		kv->SetInt("level", 1);
dvander@379
   196
		kv->SetInt("time", 20);
dvander@379
   197
		kv->SetString("msg", "This is a long long long text string.\n\nIt also has line breaks.");
dvander@379
   198
dvander@379
   199
		helpers->CreateMessage(pEntity, DIALOG_TEXT, kv, vsp_callbacks);
dvander@379
   200
		kv->deleteThis();
dvander@379
   201
		RETURN_META(MRES_SUPERCEDE);
dvander@379
   202
	}
dvander@379
   203
	else if (strcmp(cmd, "msg") == 0)
dvander@379
   204
	{
dvander@379
   205
		KeyValues *kv = new KeyValues("menu");
dvander@379
   206
		kv->SetString("title", "Just a simple hello");
dvander@379
   207
		kv->SetInt("level", 1);
dvander@379
   208
		kv->SetInt("time", 20);
dvander@379
   209
dvander@379
   210
		helpers->CreateMessage(pEntity, DIALOG_MSG, kv, vsp_callbacks);
dvander@379
   211
		kv->deleteThis();
dvander@379
   212
		RETURN_META(MRES_SUPERCEDE);
dvander@379
   213
	}
dvander@379
   214
	else if (strcmp(cmd, "entry") == 0)
dvander@379
   215
	{
dvander@379
   216
		KeyValues *kv = new KeyValues("entry");
dvander@379
   217
		kv->SetString("title", "Stuff");
dvander@379
   218
		kv->SetString("msg", "Enter something");
dvander@379
   219
		kv->SetString("command", "say"); // anything they enter into the dialog turns into a say command
dvander@379
   220
		kv->SetInt("level", 1);
dvander@379
   221
		kv->SetInt("time", 20);
dvander@379
   222
dvander@379
   223
		helpers->CreateMessage(pEntity, DIALOG_ENTRY, kv, vsp_callbacks);
dvander@379
   224
		kv->deleteThis();
dvander@379
   225
		RETURN_META(MRES_SUPERCEDE);
dvander@379
   226
	}
dvander@379
   227
}
dvander@379
   228
ds@605
   229
void SamplePlugin::Hook_ClientSettingsChanged(edict_t *pEdict)
dvander@379
   230
{
dvander@379
   231
	if (playerinfomanager)
dvander@379
   232
	{
dvander@379
   233
		IPlayerInfo *playerinfo = playerinfomanager->GetPlayerInfo(pEdict);
dvander@379
   234
ds@605
   235
		const char *name = engine->GetClientConVarValue(IndexOfEdict(pEdict), "name");
dvander@379
   236
dvander@379
   237
		if (playerinfo != NULL
dvander@379
   238
			&& name != NULL
dvander@497
   239
			&& strcmp(engine->GetPlayerNetworkIDString(pEdict), "BOT") != 0
dvander@379
   240
			&& playerinfo->GetName() != NULL
dvander@379
   241
			&& strcmp(name, playerinfo->GetName()) == 0)
dvander@379
   242
		{
dvander@379
   243
			char msg[128];
dvander@497
   244
			MM_Format(msg, sizeof(msg), "Your name changed to \"%s\" (from \"%s\")\n", name, playerinfo->GetName());
dvander@379
   245
			engine->ClientPrintf(pEdict, msg);
dvander@379
   246
		}
dvander@379
   247
	}
dvander@379
   248
}
dvander@379
   249
ds@605
   250
bool SamplePlugin::Hook_ClientConnect(edict_t *pEntity,
dvander@379
   251
									const char *pszName,
dvander@379
   252
									const char *pszAddress,
dvander@379
   253
									char *reject,
dvander@379
   254
									int maxrejectlen)
dvander@379
   255
{
ds@605
   256
	META_LOG(g_PLAPI, "Hook_ClientConnect(%d, \"%s\", \"%s\")", IndexOfEdict(pEntity), pszName, pszAddress);
dvander@379
   257
dvander@379
   258
	return true;
dvander@379
   259
}
dvander@379
   260
ds@605
   261
void SamplePlugin::Hook_ClientPutInServer(edict_t *pEntity, char const *playername)
dvander@379
   262
{
dvander@379
   263
	KeyValues *kv = new KeyValues( "msg" );
dvander@379
   264
	kv->SetString( "title", "Hello" );
dvander@379
   265
	kv->SetString( "msg", "Hello there" );
dvander@379
   266
	kv->SetColor( "color", Color( 255, 0, 0, 255 ));
dvander@379
   267
	kv->SetInt( "level", 5);
dvander@379
   268
	kv->SetInt( "time", 10);
dvander@379
   269
	helpers->CreateMessage(pEntity, DIALOG_MSG, kv, vsp_callbacks);
dvander@379
   270
	kv->deleteThis();
dvander@379
   271
}
dvander@379
   272
ds@605
   273
void SamplePlugin::Hook_ClientDisconnect(edict_t *pEntity)
dvander@379
   274
{
ds@605
   275
	META_LOG(g_PLAPI, "Hook_ClientDisconnect(%d)", IndexOfEdict(pEntity));
dvander@379
   276
}
dvander@379
   277
ds@605
   278
void SamplePlugin::Hook_GameFrame(bool simulating)
dvander@379
   279
{
dvander@379
   280
	/**
dvander@379
   281
	 * simulating:
dvander@379
   282
	 * ***********
dvander@379
   283
	 * true  | game is ticking
dvander@379
   284
	 * false | game is not ticking
dvander@379
   285
	 */
dvander@379
   286
}
dvander@379
   287
ds@605
   288
bool SamplePlugin::Hook_LevelInit(const char *pMapName,
dvander@379
   289
								char const *pMapEntities,
dvander@379
   290
								char const *pOldLevel,
dvander@379
   291
								char const *pLandmarkName,
dvander@379
   292
								bool loadGame,
dvander@379
   293
								bool background)
dvander@379
   294
{
dvander@379
   295
	META_LOG(g_PLAPI, "Hook_LevelInit(%s)", pMapName);
dvander@379
   296
dvander@379
   297
	return true;
dvander@379
   298
}
dvander@379
   299
ds@605
   300
void SamplePlugin::Hook_LevelShutdown()
dvander@379
   301
{
dvander@379
   302
	META_LOG(g_PLAPI, "Hook_LevelShutdown()");
dvander@379
   303
}
dvander@379
   304
ds@605
   305
void SamplePlugin::Hook_SetCommandClient(int index)
dvander@379
   306
{
dvander@379
   307
	META_LOG(g_PLAPI, "Hook_SetCommandClient(%d)", index);
dvander@379
   308
}
dvander@379
   309
ds@605
   310
bool SamplePlugin::Pause(char *error, size_t maxlen)
dvander@379
   311
{
dvander@379
   312
	return true;
dvander@379
   313
}
dvander@379
   314
ds@605
   315
bool SamplePlugin::Unpause(char *error, size_t maxlen)
dvander@379
   316
{
dvander@379
   317
	return true;
dvander@379
   318
}
dvander@379
   319
ds@605
   320
const char *SamplePlugin::GetLicense()
dvander@379
   321
{
dvander@379
   322
	return "Public Domain";
dvander@379
   323
}
dvander@379
   324
ds@605
   325
const char *SamplePlugin::GetVersion()
dvander@379
   326
{
dvander@379
   327
	return "1.0.0.0";
dvander@379
   328
}
dvander@379
   329
ds@605
   330
const char *SamplePlugin::GetDate()
dvander@379
   331
{
dvander@379
   332
	return __DATE__;
dvander@379
   333
}
dvander@379
   334
ds@605
   335
const char *SamplePlugin::GetLogTag()
dvander@379
   336
{
dvander@379
   337
	return "SAMPLE";
dvander@379
   338
}
dvander@379
   339
ds@605
   340
const char *SamplePlugin::GetAuthor()
dvander@379
   341
{
dvander@379
   342
	return "AlliedModders LLC";
dvander@379
   343
}
dvander@379
   344
ds@605
   345
const char *SamplePlugin::GetDescription()
dvander@379
   346
{
dvander@379
   347
	return "Sample basic plugin";
dvander@379
   348
}
dvander@379
   349
ds@605
   350
const char *SamplePlugin::GetName()
dvander@379
   351
{
dvander@379
   352
	return "Sample Plugin";
dvander@379
   353
}
dvander@379
   354
ds@605
   355
const char *SamplePlugin::GetURL()
dvander@379
   356
{
dvander@379
   357
	return "http://www.sourcemm.net/";
dvander@379
   358
}