SourceHook Development - Revision history

Mooshua: Move embedding to it's own page: SourceHook Standalone

2024-06-12T22:48:17Z

Move embedding to it's own page: SourceHook Standalone

Mooshua: Recategorize

2024-06-12T22:10:26Z

Recategorize

Mooshua: Add metamod-dev category

2024-05-10T05:36:13Z

Add metamod-dev category

KyleS: typo with SH_ADD_DVPHOOK and SH_ADD_MANUALDVPHOOK

2014-02-14T03:37:57Z

typo with SH_ADD_DVPHOOK and SH_ADD_MANUALDVPHOOK

Powerlord: Emphasis on must

2013-08-27T21:31:08Z

Emphasis on must

Powerlord: tt it up and added note about "error" and "maxlen"

2013-08-27T21:30:14Z

tt it up and added note about "error" and "maxlen"

Powerlord: /* Getting an Interface Instance */

2013-08-27T21:25:37Z

‎Getting an Interface Instance

Powerlord: Added section covering retrieving the interface from a factory

2013-08-27T21:24:55Z

Added section covering retrieving the interface from a factory

DJ Tsunami: /* Automatic hookmanager generation */

2009-08-17T09:34:05Z

‎Automatic hookmanager generation

Dave Gomboc: /* Hook Functions */

2008-09-12T18:15:42Z

‎Hook Functions

@@ Line 605: / Line 605: @@
 // (if the type is a reference type, use it without & here)
 </cpp>
 [[Category:Metamod:Source Development]]
 [[Category:SourceHook]]

← Older revision		Revision as of 22:10, 12 June 2024
Line 641:		Line 641:
	*<tt>UnloadPlugin()</tt> - Clean-up any left-over hooks from an ID.		*<tt>UnloadPlugin()</tt> - Clean-up any left-over hooks from an ID.

−	[[Category:Metamod:Source ~~Documentation~~]]	+	[[Category:Metamod:Source Development]]
		+	[[Category:SourceHook]]

← Older revision		Revision as of 05:36, 10 May 2024
Line 640:		Line 640:
	*<tt>UnpausePlugin()</tt> - Un-silences any silenced hooks from an ID.		*<tt>UnpausePlugin()</tt> - Un-silences any silenced hooks from an ID.
	*<tt>UnloadPlugin()</tt> - Clean-up any left-over hooks from an ID.		*<tt>UnloadPlugin()</tt> - Clean-up any left-over hooks from an ID.
		+
		+	[[Category:Metamod:Source Documentation]]

@@ Line 319: / Line 319: @@
 void StartHooks()
+{
-    takedamage_hook = SH_ADD_DVPHOOK(Player, TakeDamage, playervtable, SH_STATIC(Hook_TakeDamage), false);
+    takedamage_hook = SH_ADD_DVPHOOK(Player, TakeDamage, player_vtable, SH_STATIC(Hook_TakeDamage), false);
+}
@@ Line 340: / Line 340: @@
 void StartHooks()
+{
-    takedamage_hook = SH_ADD_MANUALDVPHOOK(MHook_TakeDamage, playervtable, SH_STATIC(Hook_TakeDamage), false);
+    takedamage_hook = SH_ADD_MANUALDVPHOOK(MHook_TakeDamage, player_vtable, SH_STATIC(Hook_TakeDamage), false);
+}

@@ Line 78: / Line 78: @@
 </pre>
-The error and maxlen arguments must be named error and maxlen respectively, or else certain macros will fail.
+The error and maxlen arguments '''must''' be named error and maxlen respectively, or else certain macros will fail.
 Note that MyPlugin should be replaced with your plugin's class.

@@ Line 58: / Line 58: @@
 ==Getting an Interface Instance==
-Before you can use an interface, you need to retrieve an instance of it.  This is done with either the GET_V_IFACE_ANY or GET_V_IFACE_CURRENT macros.  Both take the same arguments.  GET_V_IFACE_CURRENT is recommended if it works.  GET_V_IFACE_ANY should also work, but may be missing newer functionality.
+Before you can use an interface, you need to retrieve an instance of it.  This is done with either the <tt>GET_V_IFACE_ANY</tt> or <tt>GET_V_IFACE_CURRENT</tt> macros.  Both take the same arguments.  <tt>GET_V_IFACE_CURRENT</tt> is recommended if it works.  <tt>GET_V_IFACE_ANY</tt> should also work, but may be missing newer functionality.
 Normally this initialization needs to be done when your MM:S plugin or SourceMod Extension starts.
-You also need to know which factory produces the interface you need.  There are only 4 factories: GetEngineFactory, GetServerFactory, GetPhysicsFactory, and GetFilesystemFactory.  Normally you'll want Engine or Server.
+You also need to know which factory produces the interface you need.  There are only 4 factories: <tt>GetEngineFactory</tt>, <tt>GetServerFactory</tt>, <tt>GetPhysicsFactory</tt>, and <tt>GetFilesystemFactory</tt>.  Normally you'll want Engine or Server.
-You'll also need to know the constant that the game uses for that particular class.  This is usually found in the hl2sdk for your game.  In the case of IVEngineServer, this is INTERFACEVERSION_VENGINESERVER located in public/eiface.h.
+You'll also need to know the constant that the game uses for that particular class.  This is usually found in the hl2sdk for your game.  In the case of <tt>IVEngineServer</tt>, this is <tt>INTERFACEVERSION_VENGINESERVER</tt> located in public/eiface.h.
 So, to retrieve the Interface so you can do something with it, it'd look something like this:
@@ Line 77: / Line 77: @@
+}
 </pre>
 Note that MyPlugin should be replaced with your plugin's class.

← Older revision		Revision as of 21:24, 27 August 2013
Line 55:		Line 55:

	The second line is similar, except the parameter immediately after the overload parameter specifies the return type. There are no further parameters since it was declared with 0.		The second line is similar, except the parameter immediately after the overload parameter specifies the return type. There are no further parameters since it was declared with 0.
		+
		+	==Getting an Interface Instance==
		+
		+	Before you can use an interface, you need to retrieve an instance of it. This is done with either the GET_V_IFACE_ANY or GET_V_IFACE_CURRENT macros. Both take the same arguments. GET_V_IFACE_CURRENT is recommended if it works. GET_V_IFACE_ANY should also work, but may be missing newer functionality.
		+
		+	Normally this initialization needs to be done when your MM:S plugin or SourceMod Extension starts.
		+
		+	You also need to know which factory produces the interface you need. There are only 4 factories: GetEngineFactory, GetServerFactory, GetPhysicsFactory, and GetFilesystemFactory. Normally you'll want Engine or Server.
		+
		+	You'll also need to know the constant that the game uses for that particular class. This is usually found in the hl2sdk for your game. In the case of IVEngineServer, this is located in public/eiface.h.
		+
		+	So, to retrieve the Interface so you can do something with it, it'd look something like this:
		+	<pre>
		+	IVEngineServer *engine;
		+
		+	// For SourceMod, use the first signature
		+	//bool MyExtension::OnMetamodLoad(ISmmAPI ismm, char error, size_t maxlen, bool late)
		+	bool MyPlugin::Load(PluginId id, ISmmAPI ismm, char error, size_t maxlen, bool late)
		+	{
		+	GET_V_IFACE_CURRENT(GetEngineFactory, engine, IVEngineServer, INTERFACEVERSION_VENGINESERVER);
		+	}
		+	</pre>
		+
		+	Note that MyPlugin should be replaced with your plugin's class.
		+

	==Hook Functions==		==Hook Functions==

@@ Line 473: / Line 473: @@
 // Add the hook
-int hookid = g_SHPtr->AddHook(g_PLID, SourceHook::Hook_Normal/Hook_VP/Hook_DVP, iface_ptr, thisptr_offs,
+int hookid = g_SHPtr->AddHook(g_PLID, SourceHook::ISourceHook::Hook_Normal/Hook_VP/Hook_DVP, iface_ptr, thisptr_offs,
      generatedHookMan, handler, post);

@@ Line 63: / Line 63: @@
 *<tt>MRES_SUPERCEDE</tt> - The original function will not be called.  The new return value (if any) will be used instead.
-These constants are defined in <tt><sourcehook.h></tt>, and are made available to Metamod:Source plugin developers via <tt><ISmmPlugin.h></tt>.
+These enum constants are defined in <tt><sourcehook.h></tt>, and are made available to Metamod:Source plugin developers via <tt><ISmmPlugin.h></tt>.
 Once all pre-hooks have been processed, SourceHook takes an action based on the "highest" hook action returned (<tt>MRES_IGNORED</tt> being lowest, <tt>MRES_SUPERCEDE</tt> being highest).  Once the action has been processed, all ''post'' hooks are called.  That is to say, even if the original function is never called, post hooks are still processed.  Because a post hook as no chance at true interception, it is important to realize that depending on the information being detoured, the data may be modified or destroyed.  Similarly, a post hook's returned action and value is ignored.