AlliedModders Wiki - User contributions [en]

Format Class Functions (SourceMod Scripting)

2011-05-30T13:46:45Z

Cybermind: /* Format Specifiers */

=Introduction=
Format-class functions are variable argument functions in [[SourceMod]] which allow you to format a string. A simple example of this is the <tt>Format()</tt> function, which looks like:

<pawn>decl String:buffer[512];
Format(buffer, sizeof(buffer), "Your name is: %s", userName);</pawn>

If userName contains "<tt>Mark</tt>," the contents of <tt>buffer</tt> will then be: "<tt>Your name is: Mark</tt>." The prototype of these functions almost always contains the following parameters:
<pawn>const String:fmt[], {Handle,Float,_}:...</pawn>

For example, observe the following two natives:
<pawn>native Format(String:buffer[], maxlength, const String:fmt[], {Handle,Float,_}:...);
native PrintToClient(client, String:fmt[], {Handle,Float,_}:...);</pawn>

Thus, <tt>PrintToClient</tt> is a format-class function. It can be used exactly as shown earlier:
<pawn>PrintToClient(client, "Your name is: %s", userName);</pawn>

=Format Specifiers=
A format specifier is a code that allows you to specify what data-type to print. The most common specifiers are:
*'''Numerical'''
**'''d''' or '''i''': Integer number as decimal
**'''u''': Unsigned integer number as decimal
**'''b''': Binary digits in the value
**'''f''': Floating-point number
**'''x''' or '''X''': Hexadecimal representation of the binary value (capitalization affects hex letter casing)
*'''Character(s)'''
**'''s''': String
**'''t''' or '''T''': Translates a phrase (explained in [[Translations (SourceMod_Scripting)#Usage_in_a_Plugin|Translations]])
**'''c''': Prints one character (UTF-8 compliant)
*'''Special'''
**'''L''': Requires a client index; expands to 1<2><3><> where 1 is the player's name, 2 is the player's userid, and 3 is the player's Steam ID. If the client index is 0, the string will be: <tt><nowiki>Console<0><Console><Console></nowiki></tt>
**'''N''': Requires a client index; expands to a string containing the player's name. If the client index is 0, the string will be: <tt>Console</tt>

=Usage=
Format specifiers are denoted with a <tt>'%s'</tt> symbol. For example, to print a float, a number, and a string, you might use this code:
<pawn>new Float:fNum = 5.0;
new iNum = 5
new String:str[] = "5"

PrintToClient(client, "Number: %d Float: %f String: %s", iNum, fNum, str);</pawn>

'''Note''': Using the wrong data type with a specifier can be very dangerous. Always make sure you are printing as the right type. For example, specifying a string and passing a number can crash the server.

=Advanced Formatting=
Format specifiers have an extended syntax for controlling various aspects of how data is printed. The full syntax is:
<tt>%[flags][width][.precision]specifier</tt>

Each bracketed section is an optional extension. Explanations of supported SourceMod format extensions:
*'''%''': Obviously, this is always required.
*'''flags''':
**'''-''': Left-justify (right-justify is set by default)
**'''0''': Pads with 0s instead of spaces when needed (see '''width''' below).
*'''width''': Minimum number of characters to be printed. If the value to be printed is shorter than this number, the result is padded with blank spaces. The value is not truncated even if the result is larger.
*'''precision''':
**'''For integers''': specifies the minimum number of digits to print (or pad with spaces/zeroes if below the minimum).
**'''For strings''': specifies the maximum number of characters to print.
**'''For floats''': specifies the number of digits to be printed ''after the decimal point''.
**'''For all other types''': no effect.
*'''specifier''': character specifying the data type (always required).

todo: examples

For more information, see [http://www.cplusplus.com/reference/clibrary/cstdio/printf.html printf] from the C Standard Library, although not all modes are supported from C.

=Making your function Format-Class=

Sourcemod allows you to make your function Format-class, ie. pass parameters to format string variables.
Here's an example :

<pawn>public formatExample(const String:myString[] , any:...)
{
new String:myFormattedString[strlen(myString)+255];
VFormat(myFormattedString, sizeof(myFormattedString), myString, 2);

PrintToServer(myFormattedString);
}</pawn>

Using the parameter "any: ...", we can pass data(s) to format our string.
Now, in order to replace the Format Specifiers by our data(s), we use the API "VFormat", which documentation can be found here : [http://docs.sourcemod.net/api/].

The three first parameters passed in VFormat are pretty obvious since they are the as in the Format(..) API.

The 4th parameter indicate the "any: ..." parameter position in your function prototype.

[[Category:SourceMod Scripting]]

User:CyberMind

2011-03-22T01:31:37Z

Cybermind: Blanked the page

Vectors Explained (Scripting)

2011-03-22T01:27:44Z

Cybermind: /* Velocity Vectors */

=Introduction=
Vectors in general tend to be rather confusing until they are explained. There are three different types you will see. Position Vectors, Velocity Vectors, and Angle Vectors. While in most basic cases you will probably only use one of these at a time, it doesn't hurt to know what the other two parameters are there for. Here is an example of the native 'TeleportEntity' to show you what it looks like:

<pawn>
native TeleportEntity(entity, const Float:origin[3], const Float:angles[3], const Float:velocity[3]);
</pawn>

'''Position Vector''': The first Vector in this native, declared as origin[3], is the Position Vector. This simply tells us the entities absolute position in the world. The position vector could look something like {15.0, 30.0, 15.0} and this would mean the entity is 15 units along the X axis, 30 units along the Y axis, and 15 units along the Z axis.

'''Angles Vector''': The second Vector in this native, declared as angles[3], is the Angle Vector. This specifies the rotation of an object. This vector would follow the format {pitch, yaw, roll} which modifies the angles at which the object is looking. 'Pitch' is the up & down angles, 'Yaw' is the left & right, and 'Roll' is the spin along the up/down/left/right vector.

'''Velocity Vector''': The last Vector in the native is the Velocity Vector, declared as velocity[3] in the example. This vector tells the game where the object will be on the next frame. So on the next game frame, the Position Vector of this object will be the sum of the Position Vector and the Velocity Vector from our current frame.

==Velocity Vectors==
<pawn>
decl vecOrigin[3], vecVelocity[3], vecResult[3];

AddVectors(vecOrigin, vecVelocity, vecResult);
</pawn>

Compiling SourceMod Plugins

2007-12-21T01:34:55Z

Cybermind: was a code paste

Metamod:Source

2007-10-07T04:56:46Z

Cybermind: /* Plugins */ removed instance of "sourcemm"

:{{owned_project}}
==Introduction==
Metamod:Source is an API manager and interception handler that sits in between the [[Half-Life_2|Half-Life 2]] Engine (Source) and a subsequent Game Modification (MOD). It can dynamically load "Metamod:Source Plugins", written in C++, to intercept, override, and hook Engine and GameDLL API interfaces. It also allows for inter-plugin communication. As a backend it contains [[SourceHook]], a powerful library for safely manipulating virtual table hooks.

[[Category:Half-Life 2]]
[[Category:Metamod:Source Documentation]]

==Where to Download==
Metamod:Source is hosted on [http://sourceforge.net/projects/sourcemm Source Forge] or can be accessed via the [http://www.sourcemm.net/ Metamod:Source Home Page].

==Naming Conventions==
The name "SourceMM" is no longer used.

==History==
Metamod:Source is derived from the [[Metamod]] concept of intercepting calls between a game's engine and mod library. While not based on the same code, the API is designed to be similar and familiar to [[Half-Life 1]] programmers.

====SourceMod Core1====
Initially, the [[SourceMod]] project was started as the next-generation continuation of the [[AMX Mod X]] project. It was designed to be a meta-interface layer for inter-communicating plugins. However, as development continued, it was soon realized that the [[Valve Server Plugin]] interface would not be sufficient to provide proper engine access.

[[User:PM|Pavol Marko]] (core1 developer) decided to add "SourceHook" to SourceMod core1. It was embedded as a large library for hooking specific virtual table functions. After multiple revisions (see [[SourceHook]] history), it became apparent that 1)SourceHook needed to be game and interface generic, and 2)SourceMod and SourceHook needed to be split into two separate projects. The logic behind this was that SourceHook needed to be a layer above [[Valve Server Plugin]]s, in order to properly manage hooks with the least possibility of conflicts. Furthermore, SourceMod should be a plugin to the SourceHook interface, rather than managing it. This decision can be likened to [[Admin-Mod]]'s early decision to split into the first [[Metamod]] project.

====SourceHook Finalized====
After four major revisions, [[SourceHook]] was mature enough to be used in a production environment. While [[User:PM|PM]] concentrated on fleshing out [[SourceHook]], [[User:BAILOPAN|BAILOPAN]] and [[User:Damaged Soul|DS]] created the GameDLL wrapper portion.

====Version 1.0====
On May 6, 2005, Metamod:Source 1.0 was released with SourceHook v4.1 as a backend. GameDLL wrapping was achieved by providing the engine with fake copies of the IServerGame* interfaces. Once the true GameDLL location was known it would be loaded by Metamod:Source. The fake interface then directly wrapped calls to the real GameDLL.

====Version 1.1====
On October 21, 2005, the first major revision of Metamod:Source was released, featuring SourceHook v4.4, internal event listeners, dropped reliance on STL, and rewritten GameDLL hooking code. The [[Day of Defeat|Day of Defeat:Source]] release by [[VALVe_Software|Valve Software]] revealed that the binary interface between the engine and mod wasn't necessarily public or current, and MM:S's detection was improved for compatibility and speed. Furthermore, Metamod:Source stopped wrapping the GameDLL interfaces and began using SourceHook to hook them.

====Version 1.2====
On January 7th, 2006, Metamod:Source was updated for SourceHook v4.3, but received no major API changes.

====Version 1.3====
On August 16th, 2006, Metamod:Source was updated for SourceHook v4.4, minor API changes, bug fixes, and a sync to the latest HL2SDK.

====Version 1.4====
On April 5th, 2007, Metamod:Source was updated with API for [[Valve Server Plugin]] interface hooking and crash-safe user message enumeration. An experimental gameinfo.txt update tool was also added. No SourceHook changes were made in this release.

====Version 1.6====
Currently in development, Metamod:Source received a near complete overhaul to abstract engine-specific code to support Orange Box. Additionally, SourceHook received a massive overhaul and is now v4.5, adding global hooks and various major API simplifications.

==Design Considerations==
====Metamod====
Originally, Metamod:Source was a plugin co-existing with SourceMod. However, there are factories, pointers, and certain capabilities not possible from a [[Valve Server Plugin]]. Furthermore, the [[Half-Life 2]] engine does not properly unload VSPs, making debugging and resource unloading more difficult. Eventually it was decided the added functionality and fine-tuned control outweighed the extra cost of having to configure an intercepting binary.

====Plugins====
Plugins are specific to Metamod:Source. This means that [[Valve Server Plugin]]s and [[Open_Source_Plugins_for_Metamod:Source|Metamod:Source Plugins]] are entirely separate in the API characteristics. While it is certainly possible to expose the necessary interfaces to VSPs, it creates an added layer of complexity for dealing with things that Metamod:Source might not directly control. For example, when a Metamod:Source plugin is removed at runtime, all of the necessary hooks are also removed. A VSP has no clear callback for detecting this event, therefore it would be more difficult to ensure proper unloading. VSP and MM:S plugins also have different ways of attaching and detaching server [[Cvars|cvars]] and [[Console commands|concmds]].

By keeping the plugin system isolated, Metamod:Source can also provide a unique set of console commands and API. For example, plugins can listen for certain Metamod:Source-specific events and provide communication channels with other plugins.

====Hooking====
Metamod:Source is powered by [[SourceHook]], a versatile library for hooking virtual functions. The original [[Half-Life 1]] engine used structs of function pointers which could easily be modified as they passed from one library to another. However, HL2 is comprised almost entirely of pure virtual interfaces. SourceHook was designed for declaring single hooks against a given virtual function and a this pointer, which is not only faster than a blanket hooking system like Metamod's, but more flexible and precise.

Hooking under Metamod:Source has a number of features that don't exist in a hooking system style like Metamod's, and it achieves something closer to [[Detours|detours]], rather than Metamod, which is hardcoded. For example
*You can change parent parameters during a hooked call
*You can hook member functions, both by a pre-existing declaration or given vtable offset
*You can call the original function and still fire its associated hooks, or you can call it without firing hooks in order to prevent infinite recursion

==Documentation==
For more information on installing, configuring, and coding for Metamod:Source, see [[:Category:Documentation (SourceMM)|Documentation]].

==The Future==
While Metamod:Source is a stable/production product, more features are on the horizon. There are distant plans for a [[Detours|detouring]] library and a library for efficiently automated [[Signature Scanning|signature scanning]].

==License==
Metamod:Source is licensed under the [[zLib/libpng License]]. It is free to use for both open-source and proprietary projects.

==External Links==
*[http://www.sourcemm.net/ Metamod:Source Website]
*[http://www.metamod.org/ Metamod Website]
*[http://www.sourcemod.net/ SourceMod Website]
*[http://resonus.net/doxygen_sourcemm/ Doxygen of Metamod:Source]

Metamod:Source

2007-10-07T04:54:48Z

Cybermind: /* Version 1.1 */ removed more instances of "sourcemm"

:{{owned_project}}
==Introduction==
Metamod:Source is an API manager and interception handler that sits in between the [[Half-Life_2|Half-Life 2]] Engine (Source) and a subsequent Game Modification (MOD). It can dynamically load "Metamod:Source Plugins", written in C++, to intercept, override, and hook Engine and GameDLL API interfaces. It also allows for inter-plugin communication. As a backend it contains [[SourceHook]], a powerful library for safely manipulating virtual table hooks.

[[Category:Half-Life 2]]
[[Category:Metamod:Source Documentation]]

==Where to Download==
Metamod:Source is hosted on [http://sourceforge.net/projects/sourcemm Source Forge] or can be accessed via the [http://www.sourcemm.net/ Metamod:Source Home Page].

==Naming Conventions==
The name "SourceMM" is no longer used.

==History==
Metamod:Source is derived from the [[Metamod]] concept of intercepting calls between a game's engine and mod library. While not based on the same code, the API is designed to be similar and familiar to [[Half-Life 1]] programmers.

====SourceMod Core1====
Initially, the [[SourceMod]] project was started as the next-generation continuation of the [[AMX Mod X]] project. It was designed to be a meta-interface layer for inter-communicating plugins. However, as development continued, it was soon realized that the [[Valve Server Plugin]] interface would not be sufficient to provide proper engine access.

[[User:PM|Pavol Marko]] (core1 developer) decided to add "SourceHook" to SourceMod core1. It was embedded as a large library for hooking specific virtual table functions. After multiple revisions (see [[SourceHook]] history), it became apparent that 1)SourceHook needed to be game and interface generic, and 2)SourceMod and SourceHook needed to be split into two separate projects. The logic behind this was that SourceHook needed to be a layer above [[Valve Server Plugin]]s, in order to properly manage hooks with the least possibility of conflicts. Furthermore, SourceMod should be a plugin to the SourceHook interface, rather than managing it. This decision can be likened to [[Admin-Mod]]'s early decision to split into the first [[Metamod]] project.

====SourceHook Finalized====
After four major revisions, [[SourceHook]] was mature enough to be used in a production environment. While [[User:PM|PM]] concentrated on fleshing out [[SourceHook]], [[User:BAILOPAN|BAILOPAN]] and [[User:Damaged Soul|DS]] created the GameDLL wrapper portion.

====Version 1.0====
On May 6, 2005, Metamod:Source 1.0 was released with SourceHook v4.1 as a backend. GameDLL wrapping was achieved by providing the engine with fake copies of the IServerGame* interfaces. Once the true GameDLL location was known it would be loaded by Metamod:Source. The fake interface then directly wrapped calls to the real GameDLL.

====Version 1.1====
On October 21, 2005, the first major revision of Metamod:Source was released, featuring SourceHook v4.4, internal event listeners, dropped reliance on STL, and rewritten GameDLL hooking code. The [[Day of Defeat|Day of Defeat:Source]] release by [[VALVe_Software|Valve Software]] revealed that the binary interface between the engine and mod wasn't necessarily public or current, and MM:S's detection was improved for compatibility and speed. Furthermore, Metamod:Source stopped wrapping the GameDLL interfaces and began using SourceHook to hook them.

====Version 1.2====
On January 7th, 2006, Metamod:Source was updated for SourceHook v4.3, but received no major API changes.

====Version 1.3====
On August 16th, 2006, Metamod:Source was updated for SourceHook v4.4, minor API changes, bug fixes, and a sync to the latest HL2SDK.

====Version 1.4====
On April 5th, 2007, Metamod:Source was updated with API for [[Valve Server Plugin]] interface hooking and crash-safe user message enumeration. An experimental gameinfo.txt update tool was also added. No SourceHook changes were made in this release.

====Version 1.6====
Currently in development, Metamod:Source received a near complete overhaul to abstract engine-specific code to support Orange Box. Additionally, SourceHook received a massive overhaul and is now v4.5, adding global hooks and various major API simplifications.

==Design Considerations==
====Metamod====
Originally, Metamod:Source was a plugin co-existing with SourceMod. However, there are factories, pointers, and certain capabilities not possible from a [[Valve Server Plugin]]. Furthermore, the [[Half-Life 2]] engine does not properly unload VSPs, making debugging and resource unloading more difficult. Eventually it was decided the added functionality and fine-tuned control outweighed the extra cost of having to configure an intercepting binary.

====Plugins====
Plugins are specific to Metamod:Source. This means that [[Valve Server Plugin]]s and [[SourceMM Plugins]] are entirely separate in the API characteristics. While it is certainly possible to expose the necessary interfaces to VSPs, it creates an added layer of complexity for dealing with things that Metamod:Source might not directly control. For example, when a Metamod:Source plugin is removed at runtime, all of the necessary hooks are also removed. A VSP has no clear callback for detecting this event, therefore it would be more difficult to ensure proper unloading. VSP and MM:S plugins also have different ways of attaching and detaching server [[Cvars|cvars]] and [[Console commands|concmds]].

By keeping the plugin system isolated, Metamod:Source can also provide a unique set of console commands and API. For example, plugins can listen for certain Metamod:Source-specific events and provide communication channels with other plugins.

====Hooking====
Metamod:Source is powered by [[SourceHook]], a versatile library for hooking virtual functions. The original [[Half-Life 1]] engine used structs of function pointers which could easily be modified as they passed from one library to another. However, HL2 is comprised almost entirely of pure virtual interfaces. SourceHook was designed for declaring single hooks against a given virtual function and a this pointer, which is not only faster than a blanket hooking system like Metamod's, but more flexible and precise.

Hooking under Metamod:Source has a number of features that don't exist in a hooking system style like Metamod's, and it achieves something closer to [[Detours|detours]], rather than Metamod, which is hardcoded. For example
*You can change parent parameters during a hooked call
*You can hook member functions, both by a pre-existing declaration or given vtable offset
*You can call the original function and still fire its associated hooks, or you can call it without firing hooks in order to prevent infinite recursion

==Documentation==
For more information on installing, configuring, and coding for Metamod:Source, see [[:Category:Documentation (SourceMM)|Documentation]].

==The Future==
While Metamod:Source is a stable/production product, more features are on the horizon. There are distant plans for a [[Detours|detouring]] library and a library for efficiently automated [[Signature Scanning|signature scanning]].

==License==
Metamod:Source is licensed under the [[zLib/libpng License]]. It is free to use for both open-source and proprietary projects.

==External Links==
*[http://www.sourcemm.net/ Metamod:Source Website]
*[http://www.metamod.org/ Metamod Website]
*[http://www.sourcemod.net/ SourceMod Website]
*[http://resonus.net/doxygen_sourcemm/ Doxygen of Metamod:Source]

Metamod:Source

2007-10-07T04:53:06Z

Cybermind: /* Introduction */ removed instance of "sourcemm"

:{{owned_project}}
==Introduction==
Metamod:Source is an API manager and interception handler that sits in between the [[Half-Life_2|Half-Life 2]] Engine (Source) and a subsequent Game Modification (MOD). It can dynamically load "Metamod:Source Plugins", written in C++, to intercept, override, and hook Engine and GameDLL API interfaces. It also allows for inter-plugin communication. As a backend it contains [[SourceHook]], a powerful library for safely manipulating virtual table hooks.

[[Category:Half-Life 2]]
[[Category:Metamod:Source Documentation]]

==Where to Download==
Metamod:Source is hosted on [http://sourceforge.net/projects/sourcemm Source Forge] or can be accessed via the [http://www.sourcemm.net/ Metamod:Source Home Page].

==Naming Conventions==
The name "SourceMM" is no longer used.

==History==
Metamod:Source is derived from the [[Metamod]] concept of intercepting calls between a game's engine and mod library. While not based on the same code, the API is designed to be similar and familiar to [[Half-Life 1]] programmers.

====SourceMod Core1====
Initially, the [[SourceMod]] project was started as the next-generation continuation of the [[AMX Mod X]] project. It was designed to be a meta-interface layer for inter-communicating plugins. However, as development continued, it was soon realized that the [[Valve Server Plugin]] interface would not be sufficient to provide proper engine access.

[[User:PM|Pavol Marko]] (core1 developer) decided to add "SourceHook" to SourceMod core1. It was embedded as a large library for hooking specific virtual table functions. After multiple revisions (see [[SourceHook]] history), it became apparent that 1)SourceHook needed to be game and interface generic, and 2)SourceMod and SourceHook needed to be split into two separate projects. The logic behind this was that SourceHook needed to be a layer above [[Valve Server Plugin]]s, in order to properly manage hooks with the least possibility of conflicts. Furthermore, SourceMod should be a plugin to the SourceHook interface, rather than managing it. This decision can be likened to [[Admin-Mod]]'s early decision to split into the first [[Metamod]] project.

====SourceHook Finalized====
After four major revisions, [[SourceHook]] was mature enough to be used in a production environment. While [[User:PM|PM]] concentrated on fleshing out [[SourceHook]], [[User:BAILOPAN|BAILOPAN]] and [[User:Damaged Soul|DS]] created the GameDLL wrapper portion.

====Version 1.0====
On May 6, 2005, Metamod:Source 1.0 was released with SourceHook v4.1 as a backend. GameDLL wrapping was achieved by providing the engine with fake copies of the IServerGame* interfaces. Once the true GameDLL location was known it would be loaded by Metamod:Source. The fake interface then directly wrapped calls to the real GameDLL.

====Version 1.1====
On October 21, 2005, the first major revision of SourceMM was released, featuring SourceHook v4.4, internal event listeners, dropped reliance on STL, and rewritten GameDLL hooking code. The [[Day of Defeat|Day of Defeat:Source]] release by [[VALVe_Software|Valve Software]] revealed that the binary interface between the engine and mod wasn't necessarily public or current, and SourceMM's detection was improved for compatibility and speed. Furthermore, SourceMM stopped wrapping the GameDLL interfaces and began using SourceHook to hook them.

====Version 1.2====
On January 7th, 2006, Metamod:Source was updated for SourceHook v4.3, but received no major API changes.

====Version 1.3====
On August 16th, 2006, Metamod:Source was updated for SourceHook v4.4, minor API changes, bug fixes, and a sync to the latest HL2SDK.

====Version 1.4====
On April 5th, 2007, Metamod:Source was updated with API for [[Valve Server Plugin]] interface hooking and crash-safe user message enumeration. An experimental gameinfo.txt update tool was also added. No SourceHook changes were made in this release.

====Version 1.6====
Currently in development, Metamod:Source received a near complete overhaul to abstract engine-specific code to support Orange Box. Additionally, SourceHook received a massive overhaul and is now v4.5, adding global hooks and various major API simplifications.

==Design Considerations==
====Metamod====
Originally, Metamod:Source was a plugin co-existing with SourceMod. However, there are factories, pointers, and certain capabilities not possible from a [[Valve Server Plugin]]. Furthermore, the [[Half-Life 2]] engine does not properly unload VSPs, making debugging and resource unloading more difficult. Eventually it was decided the added functionality and fine-tuned control outweighed the extra cost of having to configure an intercepting binary.

====Plugins====
Plugins are specific to Metamod:Source. This means that [[Valve Server Plugin]]s and [[SourceMM Plugins]] are entirely separate in the API characteristics. While it is certainly possible to expose the necessary interfaces to VSPs, it creates an added layer of complexity for dealing with things that Metamod:Source might not directly control. For example, when a Metamod:Source plugin is removed at runtime, all of the necessary hooks are also removed. A VSP has no clear callback for detecting this event, therefore it would be more difficult to ensure proper unloading. VSP and MM:S plugins also have different ways of attaching and detaching server [[Cvars|cvars]] and [[Console commands|concmds]].

By keeping the plugin system isolated, Metamod:Source can also provide a unique set of console commands and API. For example, plugins can listen for certain Metamod:Source-specific events and provide communication channels with other plugins.

====Hooking====
Metamod:Source is powered by [[SourceHook]], a versatile library for hooking virtual functions. The original [[Half-Life 1]] engine used structs of function pointers which could easily be modified as they passed from one library to another. However, HL2 is comprised almost entirely of pure virtual interfaces. SourceHook was designed for declaring single hooks against a given virtual function and a this pointer, which is not only faster than a blanket hooking system like Metamod's, but more flexible and precise.

Hooking under Metamod:Source has a number of features that don't exist in a hooking system style like Metamod's, and it achieves something closer to [[Detours|detours]], rather than Metamod, which is hardcoded. For example
*You can change parent parameters during a hooked call
*You can hook member functions, both by a pre-existing declaration or given vtable offset
*You can call the original function and still fire its associated hooks, or you can call it without firing hooks in order to prevent infinite recursion

==Documentation==
For more information on installing, configuring, and coding for Metamod:Source, see [[:Category:Documentation (SourceMM)|Documentation]].

==The Future==
While Metamod:Source is a stable/production product, more features are on the horizon. There are distant plans for a [[Detours|detouring]] library and a library for efficiently automated [[Signature Scanning|signature scanning]].

==License==
Metamod:Source is licensed under the [[zLib/libpng License]]. It is free to use for both open-source and proprietary projects.

==External Links==
*[http://www.sourcemm.net/ Metamod:Source Website]
*[http://www.metamod.org/ Metamod Website]
*[http://www.sourcemod.net/ SourceMod Website]
*[http://resonus.net/doxygen_sourcemm/ Doxygen of Metamod:Source]