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