3 * =============================================================================
4 * SourceMod SDKTools Extension
5 * Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved.
6 * =============================================================================
8 * This program is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU General Public License, version 3.0, as published by the
10 * Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
17 * You should have received a copy of the GNU General Public License along with
18 * this program. If not, see <http://www.gnu.org/licenses/>.
20 * As a special exception, AlliedModders LLC gives you permission to link the
21 * code of this program (as well as its derivative works) to "Half-Life 2," the
22 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
23 * by the Valve Corporation. You must obey the GNU General Public License in
24 * all respects for all other code used. Additionally, AlliedModders LLC grants
25 * this exception to all derivative works. AlliedModders LLC defines further
26 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
27 * or <http://www.sourcemod.net/license.php>.
32 #include "extension.h"
35 ISourcePawnEngine *spengine = NULL;
36 EntityOutputManager g_OutputManager;
38 EntityOutputManager::EntityOutputManager()
47 EntityOutputManager::~EntityOutputManager()
54 EntityOutputs->Destroy();
55 ClassNames->Destroy();
56 ShutdownFireEventDetour();
59 void EntityOutputManager::Init()
61 enabled = CreateFireEventDetour();
68 EntityOutputs = adtfactory->CreateBasicTrie();
69 ClassNames = adtfactory->CreateBasicTrie();
72 bool EntityOutputManager::IsEnabled()
77 bool EntityOutputManager::CreateFireEventDetour()
79 if (!g_pGameConf->GetMemSig("FireOutput", &info_address))
86 g_pSM->LogError(myself, "Could not locate FireOutput - Disabling Entity Outputs");
90 if (!g_pGameConf->GetOffset("FireOutputBackup", (int *)&(info_restore.bytes)))
95 /* First, save restore bits */
96 for (size_t i=0; i<info_restore.bytes; i++)
98 info_restore.patch[i] = ((unsigned char *)info_address)[i];
101 info_callback = spengine->ExecAlloc(100);
103 JitWriter *jit = ≀
104 wr.outbase = (jitcode_t)info_callback;
105 wr.outptr = wr.outbase;
107 /* Function we are detouring into is
109 * void FireEventDetour(CBaseEntityOutput(void *) *pOutput, CBaseEntity *pActivator, CBaseEntity *pCaller, float fDelay = 0 )
112 /* push fDelay [esp+20h]
113 * push pCaller [esp+1Ch]
114 * push pActivator [esp+18h]
119 #if defined PLATFORM_WINDOWS
121 IA32_Push_Rm_Disp8_ESP(jit, 32);
122 IA32_Push_Rm_Disp8_ESP(jit, 32);
123 IA32_Push_Rm_Disp8_ESP(jit, 32);
125 IA32_Push_Reg(jit, REG_ECX);
127 #elif defined PLATFORM_LINUX
128 IA32_Push_Rm_Disp8_ESP(jit, 20);
129 IA32_Push_Rm_Disp8_ESP(jit, 20);
130 IA32_Push_Rm_Disp8_ESP(jit, 20);
132 IA32_Push_Rm_Disp8_ESP(jit, 16);
135 jitoffs_t call = IA32_Call_Imm32(jit, 0);
136 IA32_Write_Jump32_Abs(jit, call, (void *)TempDetour);
139 #if defined PLATFORM_LINUX
140 IA32_Add_Rm_Imm8(jit, REG_ESP, 4, MOD_REG); //add esp, 4
141 #elif defined PLATFORM_WINDOWS
142 IA32_Pop_Reg(jit, REG_ECX);
145 IA32_Add_Rm_Imm8(jit, REG_ESP, 12, MOD_REG); //add esp, 12 (0Ch)
148 /* Patch old bytes in */
149 for (size_t i=0; i<info_restore.bytes; i++)
151 jit->write_ubyte(info_restore.patch[i]);
154 /* Return to the original function */
155 call = IA32_Jump_Imm32(jit, 0);
156 IA32_Write_Jump32_Abs(jit, call, (unsigned char *)info_address + info_restore.bytes);
161 void EntityOutputManager::InitFireEventDetour()
165 DoGatePatch((unsigned char *)info_address, &info_callback);
170 void EntityOutputManager::DeleteFireEventDetour()
174 ShutdownFireEventDetour();
180 spengine->ExecFree(info_callback);
181 info_callback = NULL;
185 void TempDetour(void *pOutput, CBaseEntity *pActivator, CBaseEntity *pCaller, float fDelay)
187 g_OutputManager.FireEventDetour(pOutput, pActivator, pCaller, fDelay);
190 void EntityOutputManager::ShutdownFireEventDetour()
194 /* Remove the patch */
195 ApplyPatch(info_address, 0, &info_restore, NULL);
200 void EntityOutputManager::FireEventDetour(void *pOutput, CBaseEntity *pActivator, CBaseEntity *pCaller, float fDelay)
203 Q_snprintf(sOutput, sizeof(sOutput), "%x", pOutput);
205 // attempt to directly lookup a hook using the pOutput pointer
206 OutputNameStruct *pOutputName = NULL;
208 edict_t *pEdict = gameents->BaseEntityToEdict(pCaller);
210 /* TODO: Add support for entities without an edict */
216 bool fastLookup = false;
218 // Fast lookup failed - check the slow way for hooks that havn't fired yet
219 if ((fastLookup = EntityOutputs->Retrieve(sOutput, (void **)&pOutputName)) == false)
221 const char *classname = pEdict->GetClassName();
222 const char *outputname = FindOutputName(pOutput, pCaller);
224 pOutputName = FindOutputPointer(classname, outputname, false);
232 if (!pOutputName->hooks.empty())
236 // hook exists on this classname and output - map it into our quick find trie
237 EntityOutputs->Insert(sOutput, pOutputName);
240 SourceHook::List<omg_hooks *>::iterator _iter;
244 _iter = pOutputName->hooks.begin();
246 while (_iter != pOutputName->hooks.end())
248 hook = (omg_hooks *)*_iter;
252 int serial = pEdict->m_NetworkSerialNumber;
254 if (serial != hook->entity_filter && hook->entity_index == engine->IndexOfEdict(pEdict))
256 // same entity index but different serial number. Entity has changed, kill the hook.
257 _iter = pOutputName->hooks.erase(_iter);
263 if (hook->entity_filter == -1 || hook->entity_filter == serial) // Global classname hook
265 //fire the forward to hook->pf
266 hook->pf->PushString(pOutputName->Name);
267 hook->pf->PushCell(engine->IndexOfEdict(pEdict));
269 edict_t *pEdictActivator = gameents->BaseEntityToEdict(pActivator);
270 if (!pEdictActivator)
272 hook->pf->PushCell(-1);
276 hook->pf->PushCell(engine->IndexOfEdict(pEdictActivator));
278 //hook->pf->PushCell(handle);
279 hook->pf->PushFloat(fDelay);
280 hook->pf->Execute(NULL);
282 if ((hook->entity_filter != -1) && hook->only_once)
284 _iter = pOutputName->hooks.erase(_iter);
292 _iter = pOutputName->hooks.erase(_iter);
298 hook->in_use = false;
304 omg_hooks *EntityOutputManager::NewHook()
308 if (FreeHooks.empty())
310 hook = new omg_hooks;
314 hook = g_OutputManager.FreeHooks.front();
315 g_OutputManager.FreeHooks.pop();
321 void EntityOutputManager::OnHookAdded()
327 // This is the first hook created
328 InitFireEventDetour();
332 void EntityOutputManager::OnHookRemoved()
338 ShutdownFireEventDetour();
342 void EntityOutputManager::CleanUpHook(omg_hooks *hook)
344 FreeHooks.push(hook);
348 IPlugin *pPlugin = plsys->FindPluginByContext(hook->pf->GetParentContext()->GetContext());
349 SourceHook::List<omg_hooks *> *pList = NULL;
351 if (!pPlugin->GetProperty("OutputHookList", (void **)&pList, false) || !pList)
356 SourceHook::List<omg_hooks *>::iterator p_iter = pList->begin();
358 omg_hooks *pluginHook;
360 while (p_iter != pList->end())
362 pluginHook = (omg_hooks *)*p_iter;
363 if (pluginHook == hook)
365 p_iter = pList->erase(p_iter);
374 void EntityOutputManager::OnPluginDestroyed(IPlugin *plugin)
376 SourceHook::List<omg_hooks *> *pList = NULL;
378 if (plugin->GetProperty("OutputHookList", (void **)&pList, true))
380 SourceHook::List<omg_hooks *>::iterator p_iter = pList->begin();
383 while (p_iter != pList->end())
385 hook = (omg_hooks *)*p_iter;
387 p_iter = pList->erase(p_iter); //remove from this plugins list
388 hook->m_parent->hooks.remove(hook); // remove from the y's list
390 FreeHooks.push(hook); //save the omg_hook
397 OutputNameStruct *EntityOutputManager::FindOutputPointer(const char *classname, const char *outputname, bool create)
399 ClassNameStruct *pClassname;
401 if (!ClassNames->Retrieve(classname, (void **)&pClassname))
405 pClassname = new ClassNameStruct;
406 ClassNames->Insert(classname, pClassname);
414 OutputNameStruct *pOutputName;
416 if (!pClassname->OutputList->Retrieve(outputname, (void **)&pOutputName))
420 pOutputName = new OutputNameStruct;
421 pClassname->OutputList->Insert(outputname, pOutputName);
422 strncpy(pOutputName->Name, outputname, sizeof(pOutputName->Name));
423 pOutputName->Name[49] = 0;
434 // Iterate the datamap of pCaller and look for output pointers with the same address as pOutput
435 const char *EntityOutputManager::FindOutputName(void *pOutput, CBaseEntity *pCaller)
437 datamap_t *pMap = gamehelpers->GetDataMap(pCaller);
441 for (int i=0; i<pMap->dataNumFields; i++)
443 if (pMap->dataDesc[i].flags & FTYPEDESC_OUTPUT)
445 if ((char *)pCaller + pMap->dataDesc[i].fieldOffset[0] == pOutput)
447 return pMap->dataDesc[i].externalName;
451 pMap = pMap->baseMap;
458 edict_t *EntityOutputManager::BaseHandleToEdict(CBaseHandle &hndl)
465 int index = hndl.GetEntryIndex();
467 edict_t *pStoredEdict;
469 pStoredEdict = engine->PEntityOfEntIndex(index);
471 if (pStoredEdict == NULL)
476 IServerEntity *pSE = pStoredEdict->GetIServerEntity();
483 if (pSE->GetRefEHandle() != hndl)