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