3 * =============================================================================
4 * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
5 * =============================================================================
7 * This file is part of the SourceMod/SourcePawn SDK.
9 * This program is free software; you can redistribute it and/or modify it under
10 * the terms of the GNU General Public License, version 3.0, as published by the
11 * Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 * You should have received a copy of the GNU General Public License along with
19 * this program. If not, see <http://www.gnu.org/licenses/>.
21 * As a special exception, AlliedModders LLC gives you permission to link the
22 * code of this program (as well as its derivative works) to "Half-Life 2," the
23 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
24 * by the Valve Corporation. You must obey the GNU General Public License in
25 * all respects for all other code used. Additionally, AlliedModders LLC grants
26 * this exception to all derivative works. AlliedModders LLC defines further
27 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
28 * or <http://www.sourcemod.net/license.php>.
33 #if defined _sdktools_entoutput_included
36 #define _sdktools_entoutput_included
39 * Called when an entity output is fired.
41 * @param output Name of the output that fired.
42 * @param caller Entity index of the caller.
43 * @param activator Entity index of the activator.
44 * @param delay Delay in seconds? before the event gets fired.
46 functag public EntityOutput(const String:output[], caller, activator, Float:delay);
49 * Add an entity output hook on a entity classname
51 * @param classname The classname to hook.
52 * @param output The output name to hook.
53 * @param callback An EntityOutput function pointer.
55 * @error Entity Outputs disabled.
57 native HookEntityOutput(const String:classname[], const String:output[], EntityOutput:callback);
60 * Remove an entity output hook.
61 * @param classname The classname to hook.
62 * @param output The output name to hook.
63 * @param callback An EntityOutput function pointer.
64 * @return True on success, false if no valid hook was found.
65 * @error Entity Outputs disabled.
67 native bool:UnhookEntityOutput(const String:classname[], const String:output[], EntityOutput:callback);
70 * Add an entity output hook on a single entity instance
72 * @param entity The entity on which to add a hook.
73 * @param output The output name to hook.
74 * @param callback An EntityOutput function pointer.
75 * @param once Only fire this hook once and then remove itself.
77 * @error Entity Outputs disabled or Invalid Entity index.
79 native HookSingleEntityOutput(entity, const String:output[], EntityOutput:callback , bool:once=false);
82 * Remove a single entity output hook.
84 * @param entity The entity on which to remove the hook.
85 * @param output The output name to hook.
86 * @param callback An EntityOutput function pointer.
87 * @return True on success, false if no valid hook was found.
88 * @error Entity Outputs disabled or Invalid Entity index.
90 native bool:UnhookSingleEntityOutput(entity, const String:output[], EntityOutput:callback);
