extensions/tf2/extension.cpp
author Nicholas Hastings <skamonkey@gmail.com>
Mon Jun 28 17:48:14 2010 -0400 (2010-06-28)
changeset 3056 4e1591dceb8d
parent 2790 6dd851ba15fd
child 3151 aef99299f88b
permissions -rw-r--r--
Added forward/detour for TF2's GetHoliday function (bug 4462, r=pred)
dvander@1945
     1
/**
dvander@1945
     2
 * vim: set ts=4 :
dvander@1945
     3
 * =============================================================================
pred@1963
     4
 * SourceMod Team Fortress 2 Extension
ds@1947
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
dvander@1945
     6
 * =============================================================================
dvander@1945
     7
 *
dvander@1945
     8
 * This program is free software; you can redistribute it and/or modify it under
dvander@1945
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
dvander@1945
    10
 * Free Software Foundation.
dvander@1945
    11
 * 
dvander@1945
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@1945
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@1945
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
dvander@1945
    15
 * details.
dvander@1945
    16
 *
dvander@1945
    17
 * You should have received a copy of the GNU General Public License along with
dvander@1945
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1945
    19
 *
dvander@1945
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
dvander@1945
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@1945
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@1945
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
dvander@1945
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
dvander@1945
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
dvander@1945
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@1945
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@1945
    28
 *
dvander@1945
    29
 * Version: $Id$
dvander@1945
    30
 */
dvander@1945
    31
dvander@2783
    32
#include <sourcemod_version.h>
dvander@1945
    33
#include "extension.h"
pred@1963
    34
#include "util.h"
dvander@1945
    35
#include "RegNatives.h"
dvander@1945
    36
#include "iplayerinfo.h"
pred@1963
    37
#include "sm_trie_tpl.h"
pred@1979
    38
#include "criticals.h"
skamonkey@3056
    39
#include "holiday.h"
pred@2136
    40
#include "CDetour/detours.h"
dvander@1945
    41
dvander@1945
    42
/**
dvander@1945
    43
 * @file extension.cpp
dvander@1945
    44
 * @brief Implement extension code here.
dvander@1945
    45
 */
dvander@1945
    46
dvander@1945
    47
dvander@1945
    48
TF2Tools g_TF2Tools;
dvander@1945
    49
IGameConfig *g_pGameConf = NULL;
dvander@1945
    50
dvander@1945
    51
IBinTools *g_pBinTools = NULL;
dvander@1945
    52
dvander@1945
    53
SMEXT_LINK(&g_TF2Tools);
dvander@1945
    54
pred@1979
    55
ICvar *icvar = NULL;
pred@1979
    56
pred@1963
    57
CGlobalVars *gpGlobals = NULL;
pred@1963
    58
pred@1963
    59
sm_sendprop_info_t *playerSharedOffset;
dvander@1945
    60
dvander@1945
    61
extern sp_nativeinfo_t g_TFNatives[];
dvander@1945
    62
pred@1963
    63
int g_resourceEntity;
pred@1963
    64
pred@1963
    65
SH_DECL_HOOK3_void(IServerGameDLL, ServerActivate, SH_NOATTRIB, 0, edict_t *, int , int);
pred@1963
    66
dvander@1945
    67
bool TF2Tools::SDK_OnLoad(char *error, size_t maxlength, bool late)
dvander@1945
    68
{
pred@2069
    69
	if (strcmp(g_pSM->GetGameFolderName(), "tf") != 0)
pred@2069
    70
	{
pred@2123
    71
		UTIL_Format(error, maxlength, "Cannot Load TF2 Extension on mods other than TF2");
pred@2069
    72
		return false;
pred@2069
    73
	}
pred@2069
    74
pred@1963
    75
	ServerClass *sc = UTIL_FindServerClass("CTFPlayer");
pred@1963
    76
	if (sc == NULL)
pred@1963
    77
	{
pred@2123
    78
		UTIL_Format(error, maxlength, "Could not find CTFPlayer server class");
pred@1963
    79
		return false;
pred@1963
    80
	}
pred@1963
    81
pred@1963
    82
	playerSharedOffset = new sm_sendprop_info_t;
pred@1963
    83
pred@1963
    84
	if (!UTIL_FindDataTable(sc->m_pTable, "DT_TFPlayerShared", playerSharedOffset, 0))
pred@1963
    85
	{
pred@2123
    86
		UTIL_Format(error, maxlength, "Could not find DT_TFPlayerShared data table");
pred@1963
    87
		return false;
pred@1963
    88
	}
pred@1963
    89
dvander@1945
    90
	sharesys->AddDependency(myself, "bintools.ext", true, true);
dvander@1945
    91
pred@2123
    92
	char conf_error[255] = "";
dvander@1945
    93
	if (!gameconfs->LoadGameConfigFile("sm-tf2.games", &g_pGameConf, conf_error, sizeof(conf_error)))
dvander@1945
    94
	{
pred@2600
    95
		if (conf_error[0])
dvander@1945
    96
		{
pred@2123
    97
			UTIL_Format(error, maxlength, "Could not read sm-tf2.games.txt: %s", conf_error);
dvander@1945
    98
		}
dvander@1945
    99
		return false;
dvander@1945
   100
	}
dvander@1945
   101
pred@2136
   102
	CDetourManager::Init(g_pSM->GetScriptingEngine(), g_pGameConf);
pred@2136
   103
dvander@1945
   104
	sharesys->AddNatives(myself, g_TFNatives);
dvander@1945
   105
	sharesys->RegisterLibrary(myself, "tf2");
dvander@1945
   106
pred@2619
   107
	plsys->AddPluginsListener(this);
pred@2619
   108
ds@1952
   109
	playerhelpers->RegisterCommandTargetProcessor(this);
dvander@1945
   110
pred@2136
   111
	g_critForward = forwards->CreateForward("TF2_CalcIsAttackCritical", ET_Hook, 4, NULL, Param_Cell, Param_Cell, Param_String, Param_CellByRef);
skamonkey@3056
   112
	g_getHolidayForward = forwards->CreateForward("TF2_OnGetHoliday", ET_Event, 1, NULL, Param_CellByRef);
pred@1979
   113
pred@1979
   114
	g_pCVar = icvar;
dvander@1945
   115
skamonkey@3056
   116
	m_CritDetoursEnabled = false;
skamonkey@3056
   117
	m_GetHolidayDetourEnabled = false;
pred@2619
   118
dvander@1945
   119
	return true;
dvander@1945
   120
}
dvander@1945
   121
dvander@2790
   122
const char *TF2Tools::GetExtensionVerString()
dvander@2783
   123
{
dvander@2783
   124
	return SM_FULL_VERSION;
dvander@2783
   125
}
dvander@2783
   126
dvander@2790
   127
const char *TF2Tools::GetExtensionDateString()
dvander@2783
   128
{
dvander@2783
   129
	return SM_BUILD_TIMESTAMP;
dvander@2783
   130
}
dvander@2783
   131
dvander@1945
   132
bool TF2Tools::SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlen, bool late)
dvander@1945
   133
{
dvander@1945
   134
	GET_V_IFACE_CURRENT(GetEngineFactory, engine, IVEngineServer, INTERFACEVERSION_VENGINESERVER);
dvander@1945
   135
pred@1963
   136
	gpGlobals = ismm->GetCGlobals();
pred@1963
   137
pred@1963
   138
	SH_ADD_HOOK(IServerGameDLL, ServerActivate, gamedll, SH_STATIC(OnServerActivate), true);
pred@1963
   139
pred@1979
   140
	GET_V_IFACE_CURRENT(GetEngineFactory, icvar, ICvar, CVAR_INTERFACE_VERSION);
pred@1979
   141
pred@1979
   142
	GET_V_IFACE_CURRENT(GetServerFactory, gameents, IServerGameEnts, INTERFACEVERSION_SERVERGAMEENTS);
pred@1979
   143
pred@2075
   144
	GET_V_IFACE_CURRENT(GetEngineFactory, m_GameEventManager, IGameEventManager2, INTERFACEVERSION_GAMEEVENTSMANAGER2);
pred@2075
   145
	m_GameEventManager->AddListener(this, "teamplay_restart_round", true);
pred@2075
   146
dvander@1945
   147
	return true;
dvander@1945
   148
}
dvander@1945
   149
dvander@1945
   150
void TF2Tools::SDK_OnUnload()
dvander@1945
   151
{
pred@1963
   152
	SH_REMOVE_HOOK(IServerGameDLL, ServerActivate, gamedll, SH_STATIC(OnServerActivate), true);
pred@1963
   153
dvander@1945
   154
	g_RegNatives.UnregisterAll();
dvander@1945
   155
	gameconfs->CloseGameConfigFile(g_pGameConf);
pred@1963
   156
	playerhelpers->UnregisterCommandTargetProcessor(this);
pred@2136
   157
pred@2619
   158
	plsys->RemovePluginsListener(this);
pred@2136
   159
pred@2619
   160
	forwards->ReleaseForward(g_critForward);
skamonkey@3056
   161
	forwards->ReleaseForward(g_getHolidayForward);
dvander@1945
   162
}
dvander@1945
   163
dvander@1945
   164
void TF2Tools::SDK_OnAllLoaded()
dvander@1945
   165
{
dvander@1945
   166
	SM_GET_LATE_IFACE(BINTOOLS, g_pBinTools);
ds@1952
   167
}
ds@1952
   168
pred@1979
   169
bool TF2Tools::RegisterConCommandBase(ConCommandBase *pVar)
pred@1979
   170
{
pred@1979
   171
	return g_SMAPI->RegisterConCommandBase(g_PLAPI, pVar);
pred@1979
   172
}
pred@1979
   173
pred@2075
   174
void TF2Tools::FireGameEvent( IGameEvent *event )
pred@2075
   175
{
pred@2075
   176
	timersys->NotifyOfGameStart();
pred@2075
   177
	timersys->MapTimeLeftChanged();
dvander@1945
   178
}
dvander@1945
   179
dvander@1945
   180
bool TF2Tools::QueryRunning(char *error, size_t maxlength)
dvander@1945
   181
{
dvander@1945
   182
	SM_CHECK_IFACE(BINTOOLS, g_pBinTools);
dvander@1945
   183
dvander@1945
   184
	return true;
dvander@1945
   185
}
dvander@1945
   186
dvander@1945
   187
bool TF2Tools::QueryInterfaceDrop(SMInterface *pInterface)
dvander@1945
   188
{
dvander@1945
   189
	if (pInterface == g_pBinTools)
dvander@1945
   190
	{
dvander@1945
   191
		return false;
dvander@1945
   192
	}
dvander@1945
   193
dvander@1945
   194
	return IExtensionInterface::QueryInterfaceDrop(pInterface);
dvander@1945
   195
}
dvander@1945
   196
dvander@1945
   197
void TF2Tools::NotifyInterfaceDrop(SMInterface *pInterface)
dvander@1945
   198
{
dvander@1945
   199
	g_RegNatives.UnregisterAll();
dvander@1945
   200
}
dvander@1945
   201
pred@1963
   202
void OnServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
dvander@1945
   203
{
pred@1963
   204
	g_resourceEntity = FindResourceEntity();
pred@1963
   205
}
dvander@1945
   206
dvander@1945
   207
bool TF2Tools::ProcessCommandTarget(cmd_target_info_t *info)
dvander@1945
   208
{
dvander@1945
   209
	int max_clients;
dvander@1945
   210
	IPlayerInfo *pInfo;
dvander@1945
   211
	unsigned int team_index = 0;
dvander@1945
   212
	IGamePlayer *pPlayer, *pAdmin;
dvander@1945
   213
dvander@1945
   214
	if ((info->flags & COMMAND_FILTER_NO_MULTI) == COMMAND_FILTER_NO_MULTI)
dvander@1945
   215
	{
dvander@1945
   216
		return false;
dvander@1945
   217
	}
dvander@1945
   218
dvander@1945
   219
	if (info->admin)
dvander@1945
   220
	{
dvander@1945
   221
		if ((pAdmin = playerhelpers->GetGamePlayer(info->admin)) == NULL)
dvander@1945
   222
		{
dvander@1945
   223
			return false;
dvander@1945
   224
		}
dvander@1945
   225
		if (!pAdmin->IsInGame())
dvander@1945
   226
		{
dvander@1945
   227
			return false;
dvander@1945
   228
		}
dvander@1945
   229
	}
dvander@1945
   230
	else
dvander@1945
   231
	{
dvander@1945
   232
		pAdmin = NULL;
dvander@1945
   233
	}
dvander@1945
   234
dvander@1945
   235
	if (strcmp(info->pattern, "@red") == 0 )
dvander@1945
   236
	{
dvander@1945
   237
		team_index = 2;
dvander@1945
   238
	}
dvander@1945
   239
	else if (strcmp(info->pattern, "@blue") == 0)
dvander@1945
   240
	{
dvander@1945
   241
		team_index = 3;
dvander@1945
   242
	}
dvander@1945
   243
	else
dvander@1945
   244
	{
dvander@1945
   245
		return false;
dvander@1945
   246
	}
dvander@1945
   247
dvander@1945
   248
	info->num_targets = 0;
dvander@1945
   249
dvander@1945
   250
	max_clients = playerhelpers->GetMaxClients();
dvander@1945
   251
	for (int i = 1; 
dvander@1945
   252
		 i <= max_clients && (cell_t)info->num_targets < info->max_targets; 
dvander@1945
   253
		 i++)
dvander@1945
   254
	{
dvander@1945
   255
		if ((pPlayer = playerhelpers->GetGamePlayer(i)) == NULL)
dvander@1945
   256
		{
dvander@1945
   257
			continue;
dvander@1945
   258
		}
dvander@1945
   259
		if (!pPlayer->IsInGame())
dvander@1945
   260
		{
dvander@1945
   261
			continue;
dvander@1945
   262
		}
dvander@1945
   263
		if ((pInfo = pPlayer->GetPlayerInfo()) == NULL)
dvander@1945
   264
		{
dvander@1945
   265
			continue;
dvander@1945
   266
		}
dvander@1945
   267
		if (pInfo->GetTeamIndex() != (int)team_index)
dvander@1945
   268
		{
dvander@1945
   269
			continue;
dvander@1945
   270
		}
dvander@1945
   271
		if (playerhelpers->FilterCommandTarget(pAdmin, pPlayer, info->flags) 
dvander@1945
   272
			!= COMMAND_TARGET_VALID)
dvander@1945
   273
		{
dvander@1945
   274
			continue;
dvander@1945
   275
		}
dvander@1945
   276
		info->targets[info->num_targets] = i;
dvander@1945
   277
		info->num_targets++;
dvander@1945
   278
	}
dvander@1945
   279
dvander@1945
   280
	if (info->num_targets == 0)
dvander@1945
   281
	{
dvander@1945
   282
		info->reason = COMMAND_TARGET_EMPTY_FILTER;
dvander@1945
   283
	}
dvander@1945
   284
	else
dvander@1945
   285
	{
dvander@1945
   286
		info->reason = COMMAND_TARGET_VALID;
dvander@1945
   287
	}
dvander@1945
   288
dvander@1945
   289
	info->target_name_style = COMMAND_TARGETNAME_RAW;
dvander@1945
   290
	if (team_index == 2)
dvander@1945
   291
	{
dvander@1945
   292
		UTIL_Format(info->target_name, info->target_name_maxlength, "Red Team");
dvander@1945
   293
	}
dvander@1945
   294
	else if (team_index == 3)
dvander@1945
   295
	{
dvander@1945
   296
		UTIL_Format(info->target_name, info->target_name_maxlength, "Blue Team");
dvander@1945
   297
	}
dvander@1945
   298
dvander@1945
   299
	return true;
dvander@1945
   300
}
dvander@1945
   301
pred@2619
   302
void TF2Tools::OnPluginLoaded(IPlugin *plugin)
pred@2619
   303
{
skamonkey@3056
   304
	if (!m_CritDetoursEnabled && g_critForward->GetFunctionCount())
pred@2619
   305
	{
skamonkey@3056
   306
		InitialiseCritDetours();
skamonkey@3056
   307
		m_CritDetoursEnabled = true;
skamonkey@3056
   308
	}
skamonkey@3056
   309
	if (!m_GetHolidayDetourEnabled && g_getHolidayForward->GetFunctionCount())
skamonkey@3056
   310
	{
skamonkey@3056
   311
		InitialiseGetHolidayDetour();
skamonkey@3056
   312
		m_GetHolidayDetourEnabled = true;
pred@2619
   313
	}
pred@2619
   314
}
pred@2619
   315
pred@2619
   316
void TF2Tools::OnPluginUnloaded(IPlugin *plugin)
pred@2619
   317
{
skamonkey@3056
   318
	if (m_CritDetoursEnabled && !g_critForward->GetFunctionCount())
pred@2619
   319
	{
skamonkey@3056
   320
		RemoveCritDetours();
skamonkey@3056
   321
		m_CritDetoursEnabled = false;
skamonkey@3056
   322
	}
skamonkey@3056
   323
	if (m_GetHolidayDetourEnabled && !g_getHolidayForward->GetFunctionCount())
skamonkey@3056
   324
	{
skamonkey@3056
   325
		RemoveGetHolidayDetour();
skamonkey@3056
   326
		m_GetHolidayDetourEnabled = false;
pred@2619
   327
	}
pred@2619
   328
}
pred@1963
   329
int FindResourceEntity()
pred@1963
   330
{
pred@1963
   331
	return FindEntityByNetClass(-1, "CTFPlayerResource");
pred@1963
   332
}
pred@1963
   333
pred@1963
   334
pred@1963
   335
int FindEntityByNetClass(int start, const char *classname)
pred@1963
   336
{
pred@1963
   337
	edict_t *current;
pred@1963
   338
pred@1963
   339
	for (int i = ((start != -1) ? start : 0); i < gpGlobals->maxEntities; i++)
pred@1963
   340
	{
pred@1963
   341
		current = engine->PEntityOfEntIndex(i);
pred@1963
   342
		if (current == NULL)
pred@1963
   343
		{
pred@1963
   344
			continue;
pred@1963
   345
		}
pred@1963
   346
pred@1963
   347
		IServerNetworkable *network = current->GetNetworkable();
pred@1963
   348
pred@1963
   349
		if (network == NULL)
pred@1963
   350
		{
pred@1963
   351
			continue;
pred@1963
   352
		}
pred@1963
   353
pred@1963
   354
		ServerClass *sClass = network->GetServerClass();
pred@1963
   355
		const char *name = sClass->GetName();
pred@1963
   356
		
pred@1963
   357
pred@1963
   358
		if (strcmp(name, classname) == 0)
pred@1963
   359
		{
pred@1963
   360
			return i;
pred@1963
   361
		}
pred@1963
   362
	}
pred@1963
   363
pred@1963
   364
	return -1;
pred@1963
   365
}
pred@1963
   366
pred@1963
   367
TFClassType ClassnameToType(const char *classname)
pred@1963
   368
{
pred@1963
   369
	static KTrie<TFClassType> trie;
pred@1963
   370
	static bool filled = false;
pred@1963
   371
	
pred@1963
   372
	if (!filled)
pred@1963
   373
	{
pred@1963
   374
		trie.insert("scout", TFClass_Scout);
pred@1963
   375
		trie.insert("sniper", TFClass_Sniper);
pred@1963
   376
		trie.insert("soldier", TFClass_Soldier);
pred@1963
   377
		trie.insert("demoman", TFClass_DemoMan);
pred@1963
   378
		trie.insert("demo", TFClass_DemoMan);
pred@1963
   379
		trie.insert("medic", TFClass_Medic);
pred@1963
   380
		trie.insert("heavy", TFClass_Heavy);
pred@1963
   381
		trie.insert("hwg", TFClass_Heavy);
pred@1963
   382
		trie.insert("pyro", TFClass_Pyro);
pred@1963
   383
		trie.insert("spy", TFClass_Spy);
pred@1963
   384
		trie.insert("engineer", TFClass_Engineer);
pred@1963
   385
		trie.insert("engy", TFClass_Engineer);
pred@1963
   386
pred@1963
   387
		filled = true;	
pred@1963
   388
	}
pred@1963
   389
	
pred@1963
   390
	TFClassType *value;
pred@1963
   391
pred@1963
   392
	if (!(value = trie.retrieve(classname)))
pred@1963
   393
	{
pred@1963
   394
		return TFClass_Unknown;	
pred@1963
   395
	}
pred@1963
   396
pred@1963
   397
	return *value;
pred@1963
   398
}
pred@1963
   399
pred@1963
   400
pred@1963
   401
pred@1963
   402
/**
pred@1963
   403
 * A picture of a blue crab given to me as a gift and stored here for safe keeping
pred@1963
   404
 *
pred@1963
   405
 * http://www.democracycellproject.net/blog/archives/Clown%20car.jpg
pred@1963
   406
 */
pred@1963
   407