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