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) || !info_address)
81 g_pSM->LogError(myself, "Could not locate FireOutput - Disabling Entity Outputs");
85 if (!g_pGameConf->GetOffset("FireOutputBackup", (int *)&(info_restore.bytes)))
87 g_pSM->LogError(myself, "Could not locate FireOutputBackup - Disabling Entity Outputs");
91 /* First, save restore bits */
92 for (size_t i=0; i<info_restore.bytes; i++)
94 info_restore.patch[i] = ((unsigned char *)info_address)[i];
97 info_callback = spengine->ExecAlloc(100);
100 wr.outbase = (jitcode_t)info_callback;
101 wr.outptr = wr.outbase;
103 /* Function we are detouring into is
105 * void FireEventDetour(CBaseEntityOutput(void *) *pOutput, CBaseEntity *pActivator, CBaseEntity *pCaller, float fDelay = 0 )
108 /* push fDelay [esp+20h]
109 * push pCaller [esp+1Ch]
110 * push pActivator [esp+18h]
115 #if defined PLATFORM_WINDOWS
117 IA32_Push_Rm_Disp8_ESP(jit, 32);
118 IA32_Push_Rm_Disp8_ESP(jit, 32);
119 IA32_Push_Rm_Disp8_ESP(jit, 32);
121 IA32_Push_Reg(jit, REG_ECX);
123 #elif defined PLATFORM_LINUX
124 IA32_Push_Rm_Disp8_ESP(jit, 20);
125 IA32_Push_Rm_Disp8_ESP(jit, 20);
126 IA32_Push_Rm_Disp8_ESP(jit, 20);
128 IA32_Push_Rm_Disp8_ESP(jit, 16);
131 jitoffs_t call = IA32_Call_Imm32(jit, 0);
132 IA32_Write_Jump32_Abs(jit, call, (void *)TempDetour);
135 #if defined PLATFORM_LINUX
136 IA32_Add_Rm_Imm8(jit, REG_ESP, 4, MOD_REG); //add esp, 4
137 #elif defined PLATFORM_WINDOWS
138 IA32_Pop_Reg(jit, REG_ECX);
141 IA32_Add_Rm_Imm8(jit, REG_ESP, 12, MOD_REG); //add esp, 12 (0Ch)
144 /* Patch old bytes in */
145 for (size_t i=0; i<info_restore.bytes; i++)
147 jit->write_ubyte(info_restore.patch[i]);
150 /* Return to the original function */
151 call = IA32_Jump_Imm32(jit, 0);
152 IA32_Write_Jump32_Abs(jit, call, (unsigned char *)info_address + info_restore.bytes);
157 void EntityOutputManager::InitFireEventDetour()
161 DoGatePatch((unsigned char *)info_address, &info_callback);
166 void EntityOutputManager::DeleteFireEventDetour()
170 ShutdownFireEventDetour();
176 spengine->ExecFree(info_callback);
177 info_callback = NULL;
181 void TempDetour(void *pOutput, CBaseEntity *pActivator, CBaseEntity *pCaller, float fDelay)
183 g_OutputManager.FireEventDetour(pOutput, pActivator, pCaller, fDelay);
186 void EntityOutputManager::ShutdownFireEventDetour()
190 /* Remove the patch */
191 ApplyPatch(info_address, 0, &info_restore, NULL);
196 void EntityOutputManager::FireEventDetour(void *pOutput, CBaseEntity *pActivator, CBaseEntity *pCaller, float fDelay)
199 Q_snprintf(sOutput, sizeof(sOutput), "%x", pOutput);
201 // attempt to directly lookup a hook using the pOutput pointer
202 OutputNameStruct *pOutputName = NULL;
204 edict_t *pEdict = gameents->BaseEntityToEdict(pCaller);
206 /* TODO: Add support for entities without an edict */
212 bool fastLookup = false;
214 // Fast lookup failed - check the slow way for hooks that havn't fired yet
215 if ((fastLookup = EntityOutputs->Retrieve(sOutput, (void **)&pOutputName)) == false)
217 const char *classname = pEdict->GetClassName();
218 const char *outputname = FindOutputName(pOutput, pCaller);
220 pOutputName = FindOutputPointer(classname, outputname, false);
228 if (!pOutputName->hooks.empty())
232 // hook exists on this classname and output - map it into our quick find trie
233 EntityOutputs->Insert(sOutput, pOutputName);
236 SourceHook::List<omg_hooks *>::iterator _iter;
240 _iter = pOutputName->hooks.begin();
242 while (_iter != pOutputName->hooks.end())
244 hook = (omg_hooks *)*_iter;
248 int serial = pEdict->m_NetworkSerialNumber;
250 if (serial != hook->entity_filter && hook->entity_index == engine->IndexOfEdict(pEdict))
252 // same entity index but different serial number. Entity has changed, kill the hook.
253 _iter = pOutputName->hooks.erase(_iter);
259 if (hook->entity_filter == -1 || hook->entity_filter == serial) // Global classname hook
261 //fire the forward to hook->pf
262 hook->pf->PushString(pOutputName->Name);
263 hook->pf->PushCell(engine->IndexOfEdict(pEdict));
265 edict_t *pEdictActivator = gameents->BaseEntityToEdict(pActivator);
266 if (!pEdictActivator)
268 hook->pf->PushCell(-1);
272 hook->pf->PushCell(engine->IndexOfEdict(pEdictActivator));
274 //hook->pf->PushCell(handle);
275 hook->pf->PushFloat(fDelay);
276 hook->pf->Execute(NULL);
278 if ((hook->entity_filter != -1) && hook->only_once)
280 _iter = pOutputName->hooks.erase(_iter);
288 _iter = pOutputName->hooks.erase(_iter);
294 hook->in_use = false;
300 omg_hooks *EntityOutputManager::NewHook()
304 if (FreeHooks.empty())
306 hook = new omg_hooks;
310 hook = g_OutputManager.FreeHooks.front();
311 g_OutputManager.FreeHooks.pop();
317 void EntityOutputManager::OnHookAdded()
323 // This is the first hook created
324 InitFireEventDetour();
328 void EntityOutputManager::OnHookRemoved()
334 ShutdownFireEventDetour();
338 void EntityOutputManager::CleanUpHook(omg_hooks *hook)
340 FreeHooks.push(hook);
344 IPlugin *pPlugin = plsys->FindPluginByContext(hook->pf->GetParentContext()->GetContext());
345 SourceHook::List<omg_hooks *> *pList = NULL;
347 if (!pPlugin->GetProperty("OutputHookList", (void **)&pList, false) || !pList)
352 SourceHook::List<omg_hooks *>::iterator p_iter = pList->begin();
354 omg_hooks *pluginHook;
356 while (p_iter != pList->end())
358 pluginHook = (omg_hooks *)*p_iter;
359 if (pluginHook == hook)
361 p_iter = pList->erase(p_iter);
370 void EntityOutputManager::OnPluginDestroyed(IPlugin *plugin)
372 SourceHook::List<omg_hooks *> *pList = NULL;
374 if (plugin->GetProperty("OutputHookList", (void **)&pList, true))
376 SourceHook::List<omg_hooks *>::iterator p_iter = pList->begin();
379 while (p_iter != pList->end())
381 hook = (omg_hooks *)*p_iter;
383 p_iter = pList->erase(p_iter); //remove from this plugins list
384 hook->m_parent->hooks.remove(hook); // remove from the y's list
386 FreeHooks.push(hook); //save the omg_hook
393 OutputNameStruct *EntityOutputManager::FindOutputPointer(const char *classname, const char *outputname, bool create)
395 ClassNameStruct *pClassname;
397 if (!ClassNames->Retrieve(classname, (void **)&pClassname))
401 pClassname = new ClassNameStruct;
402 ClassNames->Insert(classname, pClassname);
410 OutputNameStruct *pOutputName;
412 if (!pClassname->OutputList->Retrieve(outputname, (void **)&pOutputName))
416 pOutputName = new OutputNameStruct;
417 pClassname->OutputList->Insert(outputname, pOutputName);
418 strncpy(pOutputName->Name, outputname, sizeof(pOutputName->Name));
419 pOutputName->Name[49] = 0;
430 // Iterate the datamap of pCaller and look for output pointers with the same address as pOutput
431 const char *EntityOutputManager::FindOutputName(void *pOutput, CBaseEntity *pCaller)
433 datamap_t *pMap = gamehelpers->GetDataMap(pCaller);
437 for (int i=0; i<pMap->dataNumFields; i++)
439 if (pMap->dataDesc[i].flags & FTYPEDESC_OUTPUT)
441 if ((char *)pCaller + pMap->dataDesc[i].fieldOffset[0] == pOutput)
443 return pMap->dataDesc[i].externalName;
447 pMap = pMap->baseMap;
454 edict_t *EntityOutputManager::BaseHandleToEdict(CBaseHandle &hndl)
461 int index = hndl.GetEntryIndex();
463 edict_t *pStoredEdict;
465 pStoredEdict = engine->PEntityOfEntIndex(index);
467 if (pStoredEdict == NULL)
472 IServerEntity *pSE = pStoredEdict->GetIServerEntity();
479 if (pSE->GetRefEHandle() != hndl)