https://wiki.alliedmods.net/api.php?action=feedcontributions&feedformat=atom&user=Luki1412AlliedModders Wiki - User contributions [en]2026-05-25T20:46:03ZUser contributionsMediaWiki 1.31.6https://wiki.alliedmods.net/index.php?title=Metamod:Source&diff=11873Metamod:Source2026-04-06T13:11:19Z<p>Luki1412: Updated version history</p>
<hr />
<div>:{{owned_project}}<br />
==Introduction==<br />
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.<br />
<br />
[[Category:Half-Life 2]]<br />
[[Category:Metamod:Source Documentation]]<br />
<br />
==Where to Download==<br />
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].<br />
<br />
==Naming Conventions==<br />
The name "SourceMM" is no longer used.<br />
<br />
==History==<br />
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.<br />
<br />
====SourceMod Core1====<br />
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.<br />
<br />
[[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.<br />
<br />
====SourceHook Finalized====<br />
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:DS|DS]] created the GameDLL wrapper portion.<br />
<br />
====Version 1.0====<br />
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.<br />
<br />
====Version 1.1====<br />
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.<br />
<br />
====Version 1.2====<br />
On January 7th, 2006, Metamod:Source was updated for SourceHook v4.3, but received no major API changes.<br />
<br />
====Version 1.3====<br />
On August 16th, 2006, Metamod:Source was updated for SourceHook v4.4, minor API changes, bug fixes, and a sync to the latest HL2SDK.<br />
<br />
====Version 1.4====<br />
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.<br />
<br />
====Version 1.6====<br />
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 v5.0, adding global hooks and various major API simplifications. It is the first backwards compatibility break since 1.1.<br />
<br />
====Version 1.7====<br />
Major update -- it is a single version that runs on all Source engines, including Left 4 Dead.<br />
There is no longer an automated installer.<br />
<br />
====Version 1.7.1====<br />
Added support for Dark Messiah<br />
<br />
====Version 1.8====<br />
Major update that adds a number of new features for both users and developers.<br />
The first official release that supports the Left 4 Dead 2 engine. For developers, backport of a few New API features to the Legacy API. This includes SourceHook's extremely useful "VP hooks" feature.<br />
<br />
====Version 1.8.1====<br />
Updated to work with the latest L4D2, TF, and DoD:Source updates<br />
<br />
====Version 1.8.4====<br />
*Added support for Alien Swarm.<br />
*Added support for L4D and L4D2 on Mac OS X.<br />
*Fixed wrong engine detection on early Orange Box engines.<br />
*Fixed a crash when hooking some functions compiled by very new GCC versions.<br />
<br />
====Version 1.8.5====<br />
Small bug-fix release to work with the latest Orange Box engine update (TF2, CS:S, DOD:S, HL2DM, and Garry's Mod).<br />
<br />
====Version 1.8.6====<br />
Small bug-fix release to work with the latest Orange Box engine update (TF2, CS:S, DOD:S, HL2DM, and Garry's Mod).<br />
Added support for Bloody Good Time.<br />
<br />
====Version 1.8.7====<br />
Small bug-fix release to work with the latest Orange Box engine update (TF2, CS:S, DOD:S, HL2DM, and Garry's Mod).<br />
<br />
====Version 1.9====<br />
The first official release that supports the Counter-Strike: Global Offensive engine. In addition, CS:S is now treated as a separate engine from 'EP2V'.<br />
<br />
====Version 1.9.1====<br />
*Fixed core-legacy crash on hook from making wrong page writable.<br />
*Updated loader to attempt to guess correct tier0/vstdlib filenames on linux, fixing load on ep2v engine.<br />
*Recompiled against new hl2sdk-ob-valve to fix vdf plugin loading on ep2v engine.<br />
<br />
====Version 1.9.2====<br />
*Fixed load issues on CS:GO after protobuf networking game update (bug 5578).<br />
*Fixed load issues on CS:S under linux after game update.<br />
<br />
====Version 1.10====<br />
Major update that adds support for a new engines, reorganizes others, and contains general bugfixes.<br />
The first official release that supports the Dota 2 engine. In addition, the 'EP2V' engine is no more. TF2, DoD:S, and HL2:DM now each act as their own. Nuclear Dawn is also now separate from Left 4 Dead 2.<br />
<br />
====Version 1.10.1====<br />
*Added support for Source SDK 2013 mods, Insurgency, Contagion, and Blade Symphony.<br />
*Updated Dota 2 support to add Linux and Mac OS X support.<br />
*Improved engine detection when '-game' launch param is not present<br />
<br />
====Version 1.10.2====<br />
Fixes a regression from 1.10.1 causing engine detection on Alien Swarm to fail, as well as improving detection for some games when the '-game' command line parameter is not present (such as when using the SRCDS GUI).<br />
<br />
====Version 1.10.3====<br />
Resolves issues with recent game updates to Team Fortress 2 and Counter-Strike: Global Offensive.<br />
<br />
====Version 1.10.4====<br />
Resolves issues with recent game updates to Team Fortress 2.<br />
<br />
====Version 1.10.5====<br />
*Added support for Black Mesa.<br />
*Updated support for recent CS:GO game updates.<br />
*Fixed game detection issues on Nuclear Dawn.<br />
<br />
====Version 1.10.6====<br />
Small update to restore support for TF2, CS:S, DoD:S, HL2:DM, and Source SDK Base 2013 after their recent updates.<br />
<br />
====Move to Rolling Release Model====<br />
As of Apr 27, 2017 Metamod:Source, like SourceMod, is now officially on a rolling release cycle.<br />
*There won't be any more "point" releases (1.10.7, etc). Instead, we're going to continue to make an effort to keep the stable branch stable, and better relay information about what has changed in each build.<br />
*Major releases with potential API breakage will still occur and will still have release notes, along with continued updates even after the branch is considered to be stable.<br />
*Some of the recent, potentially-breaking changes in the Dev branch include support for Source 2, support for 64-bit dedicated servers, and removal of the old v1.4 "ep1" plugin API. (The newer v1.6 API is now used for The Ship and Source SDK 2006 mods).<br />
<br />
====Version 1.11====<br />
*Fixed linking errors with some compilers when MM:S plugins call functions in tier1 interface.h<br />
*Added support for the following engine variants: Source SDK 2013, Blade Symphony, Insurgency, Contagion, Black Mesa, and Day of Infamy.<br />
*Updated Dota 2 support for the move to Source 2 from Source. (Currently broken due to other game changes since then).<br />
*Added 64-bit support for games with supported 64-bit dedicated server versions, including 64-bit support in SourceHook.<br />
*Ported Episode 1 build from Core Legacy API to Core API.<br />
*Removed support for plugins using the "Core Legacy" API.<br />
*Updated AMBuild dependency to version 2.2.<br />
<br />
====Version 1.12====<br />
*Improved 64-bit support<br />
*Improved support for mods running on the 2025 refresh of Source SDK 2013<br />
*Improved support for HL1DM<br />
*Added support for Military Conflict: Vietnam and Pirates, Vikings, and Knights II<br />
<br />
====Version 2.0====<br />
Currently in development, where Source 2 support continues to be refined, among other larger changes.<br />
<br />
==Design Considerations==<br />
====Metamod====<br />
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.<br />
<br />
====Plugins====<br />
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]].<br />
<br />
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.<br />
<br />
====Hooking====<br />
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.<br />
<br />
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<br />
*You can change parent parameters during a hooked call<br />
*You can hook member functions, both by a pre-existing declaration or given vtable offset<br />
*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<br />
<br />
==Documentation==<br />
For more information on installing, configuring, and coding for Metamod:Source, see [[:Category:Documentation (SourceMM)|Documentation]].<br />
<br />
==The Future==<br />
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]].<br />
<br />
==License==<br />
Metamod:Source is licensed under the [[zLib/libpng License]]. It is free to use for both open-source and proprietary projects.<br />
<br />
==External Links==<br />
*[http://www.sourcemm.net/ Metamod:Source Website]<br />
*[http://www.metamod.org/ Metamod Website]<br />
*[http://www.sourcemod.net/ SourceMod Website]<br />
*[http://resonus.net/doxygen_sourcemm/ Doxygen of Metamod:Source]</div>Luki1412https://wiki.alliedmods.net/index.php?title=SourceMod&diff=11872SourceMod2026-04-06T11:38:11Z<p>Luki1412: </p>
<hr />
<div>=Introduction=<br />
SourceMod is a [[SourceMM|Metamod:Source]] plugin for [[Half-Life 2]]. It provides comprehensive scripting for the Source engine and mods written using the Source SDK. It has features for administration systems, commands, console variables, events, network messages, timed actions, math and string routines, entity modification, and more. It also features a safely versioned, object oriented API usable from "extensions" written in C++. The extension API can be used to add scripting language callbacks and native features.<br />
<br />
SourceMod scripts are written in the SourcePawn language, which is derived from [[Pawn]]. Some of the differences include:<br />
*Passing functions as "objects," instead of by name<br />
*Natively packed and tagged strings<br />
*Dynamic local variables<br />
*A '<tt>decl</tt>' operator for creating uninitialized variables<br />
*A new virtual machine and JIT, both rewritten in C++<br />
*A new file format<br />
<br />
=History=<br />
==Initial Project==<br />
SourceMod was officially announced on October 7th, 2004, as a successor to [[AMX Mod X]] for the Half-Life 1 engine. It was targetted as a complete rewrite of AMX Mod X, with the following fundamental changes:<br />
*Use of multiple (pluggable) scripting languages<br />
*JavaScript support<br />
*Unloadability<br />
*An object-oriented module API<br />
<br />
The Source SDK was released on December 1st, 2004. A few weeks later, SourceMod released its source code on December 25th. Then, development began to stagnate. The concept of multiple languages was over-ambitious and improper. The system was largely too complex and too unorganized for developers to understand. Most importantly, the integral calling abstraction layer, designed to let Core talk to plugins without knowing the target scripting layer, was never viable. Because of this and the inherent complexity of MetaEng, scripts were not testable.<br />
<br />
By May of 2005, SourceMod had become completely abandoned. The codebase was scrapped for a rewrite, called "Core 2." This was also quickly abandoned. This timeline and the details therein are explained on the SourceMod [http://www.sourcemod.net/devlog/?p=88 Dev Log]. The remaining members of the SourceMod team went back to AMX Mod X.<br />
<br />
==SourceHook==<br />
By January of 2005, it was apparent that Valve's API would not be sufficient for plugin development in C++. SourceMod and AMX Mod X Developer Pavol "PM OnoTo" Marko started working on an API for safely hooking virtual functions via vtables. <br />
<br />
By March of 2005, it was apparent that this technology would be more useful as a separate project. Thus, SourceHook broke from SourceMod and the [[SourceMM|Metamod:Source]] project was started. Metamod:Source was first released on May 26, 2005.<br />
<br />
==Current Project==<br />
In March of 2006, a public survey was held to determine if the community still wanted SourceMod. Since the response was good, the project was restarted, but in secret, to avoid the same public relations mistakes. From March to September, SourcePawn was written, which included:<br />
*A new JIT, written completely in C++<br />
*A new virtual machine and API, written in C++ with object oriented API<br />
*A new file format<br />
*Various new language features<br />
<br />
From November 2006 to January 2007, SourceMod evolved into a usable scripting platform based on SourcePawn. As of March 16, 2007, it contained enough scripting-level features to be usable, and builds were made available to the public.<br />
<br />
SourceMod remains an ongoing development project which now runs on over 38% of all Source servers.<br />
<br />
=Development Team=<br />
*See the [http://www.sourcemod.net/credits.php credits page].<br />
<br />
=Future Plans=<br />
As of the time of writing, SourceMod version 1.12 has been released and version 1.13 is under development. The best way to keep up with current development of SourceMod is to view our news section of the forums (linked below).<br />
<br />
https://forums.alliedmods.net/forumdisplay.php?f=59<br />
<br />
=License=<br />
SourceMod along with it's extensions & plugins are all licensed under the [[GNU General Public License]].<br />
<br />
=See Also=<br />
*[[Introduction to SourcePawn]]<br />
*[[Introduction to SourceMod Plugins]]<br />
<br />
=External Links=<br />
*[http://www.sourcemod.net/ SourceMod Website]<br />
*[http://www.metamodsource.net/ Metamod:Source Website]<br />
<br />
[[Category:Half-Life_2]]<br />
[[Category:SourceMod]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=Category:SourceMod_Scripting&diff=11869Category:SourceMod Scripting2026-03-31T20:26:46Z<p>Luki1412: </p>
<hr />
<div>{{ForDevelopers}}<br />
<br />
This category contains articles about scripting for SourceMod with SourcePawn.<br />
<br />
===Introductions===<br />
*[[Introduction to SourcePawn 1.7]] - Learning language syntax.<br />
*[[SourcePawn Transitional Syntax]] - Learning transitional syntax.<br />
*[[Introduction to SourceMod Plugins]] - Writing your "first plugin."<br />
*[https://sm.alliedmods.net/new-api/ API Reference] - Searchable scripting API reference.<br />
<br />
===Basic API===<br />
*[[AutoConfigs (SourceMod Scripting)|AutoConfigs]] - Automatic .cfg creation for cvars.<br />
*[[Commands (SourceMod Scripting)|Commands]] - Console commands/input.<br />
*[[ConVars (SourceMod Scripting)|ConVars]] - Console variables (cvars).<br />
*[[Events (SourceMod Scripting)|Events]] - Half-Life 2 Game Events.<br />
*[[KeyValues (SourceMod Scripting)|KeyValues]] - KeyValues file parsing/writing.<br />
*[[Menu API (SourceMod)|Menus]] - Building and drawing menus.<br />
*[[SQL (SourceMod Scripting)|SQL]] - Using databases (MySQL, SQLite).<br />
*[[Timers (SourceMod Scripting)|Timers]] - Timed callbacks.<br />
*[[DataPacks|DataPacks]] - A good way to store asynchronous data.<br />
*[[Translations (SourceMod Scripting)|Translations]] - Internationalization.<br />
*[[Entity References (SourceMod)|Entity References]] - A safe way of storing entities.<br />
*[[Checking Admin Flags (SourceMod Scripting)|Checking Admin Flags]] - Limit commands to certain users<br />
<br />
===Advanced API===<br />
*[[Admin API (SourceMod)|Administration API]] - Using the Admin Cache.<br />
*[[Admin Menu (SourceMod Scripting)|Admin Menu API]] - Attaching to the Admin Menu.<br />
*[[Creating Natives (SourceMod Scripting)|Creating Natives]] - Exposing API to other plugins.<br />
*[[Function Calling API (SourceMod Scripting)|Function Calling API]] - Calling external functions.<br />
*[[Optional Requirements (SourceMod Scripting)|Optional Requirements]] - Managing dependencies.<br />
*[[SDKTools (SourceMod Scripting)|SDKTools]] - Using the powerful SDK abstraction layer.<br />
*[[SDKHooks]] - Using SDKHooks, that provide additional hooks and functions.<br />
*[[DHooks (SourceMod Scripting)]] - Dynamic hooks.<br />
*[[TempEnts (SourceMod SDKTools)|Temporary Entities]] - Using temporary entities.<br />
<br />
===Information===<br />
*[[Format Class Functions (SourceMod Scripting)|Format Class Functions]] - All about text formatting.<br />
*[[Handles (SourceMod Scripting)|Handles]] - Overview of Handles and some common types.<br />
*[[Optimizing Plugins (SourceMod Scripting)|Optimizing Plugins]] - Optimization hints.<br />
*<s>[[Tags (Scripting)|Tags]] - All about tags.</s><br />
*[[Vectors Explained (Scripting)|Vectors Explained]] - Explanation of Vector types.<br />
<br />
===Resources===<br />
*[https://sm.alliedmods.net/new-api/ API Reference] - Searchable scripting API reference.<br />
*[[Entity Properties]] - Explanation of Source entity properties.<br />
*[[Game Events (Source)|Game Events]] - Game events listings for popular mods.<br />
*[[Mod TempEnt List (Source)|Temp Entity Lists]] - Temporary entities for popular mods.<br />
*[[SourceMod Profiler]] - Performance tracking and optimizing.<br />
*[[Vice_keys]] - Decryption keys for ctx files<br />
*[[Weapon Names(Source)]] - Weapon Names / weapon entity names<br />
[[Category:SourceMod]]<br />
[[Category:SourceMod Development]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=Tags_(Scripting)&diff=11868Tags (Scripting)2026-03-31T20:24:26Z<p>Luki1412: </p>
<hr />
<div>{{Note|As of Sourcemod 1.7 there have been significant changes to the tags and types, making this page mostly outdated. See [[SourcePawn_Transitional_Syntax]] for more information}}<br />
<br />
=Introduction=<br />
Tags are a concept in the original Small/Pawn language that work around the inherent lack of data types present. For example, Java/C would declare variables like so:<br />
<java>double dNumber = 5.0;<br />
int iNumber = 5;<br />
char cLetter = 'a';<br />
</java><br />
<br />
In Java, the sizes of these types respectively are eight bytes, four bytes, and two bytes. However, Pawn is only capable of one data type size. In SourcePawn, that's 32bit (four bytes). Therefore, tags serve two purposes:<br />
*Allow overloads and restrictions of basic math operators<br />
*Introduce weak typing and coalescence<br />
<br />
An example of this is:<br />
<pawn>new Float:fNum = 5.0;<br />
new iNum = 5;<br />
new char = 'A';</pawn><br />
<br />
In this example, all of the variables are the same ''type'', the <tt>cell</tt>, which is four bytes. But the <tt>fNum</tt> variable is ''tagged'' as a <tt>Float</tt>, and so it uses a set of overloaded operators for floating point math. The <tt>iNum</tt> and <tt>char</tt> variables are both integers. Even though <tt>char</tt> is only holding one byte of data (an ASCII character), it is still a 32bit data type.<br />
<br />
==Usage==<br />
Tags are identified by prefixing the tag name and a colon to a variable name. Note that you still need the <tt>new</tt> declaration, as tags aren't a declaration in and of themselves. Example:<br />
<pawn>//this is valid<br />
new ValidTag:crab = something;<br />
//this is not<br />
InvalidTag:tag = something;<br />
</pawn><br />
<br />
Tags can be used for enumerations. For example, the following defines a list of constant symbols which are each tagged as the enumeration name.<br />
<pawn>enum Clam<br />
{<br />
Oyster = 0, /* Oyster has the Clam tag */<br />
Quahog = 1, /* Quahog has the Clam tag */<br />
};</pawn><br />
<br />
==Mismatches and Coalescence==<br />
If you attempt to mix tags in an expression, you will get the infamous (213) "Tag mismatch" warning from the compiler. Although it is only a warning, it ''can'' be a serious error, and it is important that your plugins do not carry this warning (or, if they do, it is carefully understood to be safe).<br />
<br />
An example of a tag mismatch, using the above enumeration, might be:<br />
<pawn>stock GetClamNumber()<br />
{<br />
return Oyster;<br />
}<br />
<br />
stock Clam:GetOyster()<br />
{<br />
return 0;<br />
}</pawn><br />
<br />
Both of these functions will generate tag mismatch warnings by the compiler. This is because 0 is not inherently an Oyster, and Oyster is a <tt>Clam</tt>, not a raw number.<br />
<br />
Luckily in Pawn, you can 'coalesce' tags. This means you can convert one tag to another. This is usually a bad idea, however, it can be important for converting a bitstring to another bitstring, or a raw integer. The generic, or "empty" tag is <tt>_</tt>, and this symbol will effectively strip a tag from a tagged variable. For example:<br />
<pawn>stock GetClamNumber()<br />
{<br />
return _:Oyster;<br />
}<br />
<br />
stock Clam:GetOyster()<br />
{<br />
return Clam:0;<br />
}</pawn><br />
<br />
This forces the tags to be correct. ''Note that the second function could simply return <tt>Oyster</tt>. This mistake was for example purposes only.''<br />
<br />
=Built-in Tags=<br />
Pawn has two built-in tags by default. These are '''bool''' and '''Float'''.<br />
<br />
==Boolean==<br />
The <tt>bool</tt> tag (note case sensitivity) can be set to two values:<br />
*'''true''' - 1<br />
*'''false''' - 0<br />
<br />
Again, it is not faster or slower than an integer 1 or 0, because the data type is the same. This tag simply provides better looking code.<br />
<br />
==Float==<br />
The <tt>Float</tt> tag (note case sensitivity) is used for floating point math. If the compiler detects a number to have a decimal point, it is automatically tagged as Float. Floats have the following operators defined. Note that these operators are not intrinsic to the compiler, and are written in <tt>float.inc</tt>.<br />
*'''Math'''<br />
** '''Binary''' +, -, /, * (at least one side must be a Float)<br />
** '''Unary''' ++, --<br />
** '''Unary''' -<br />
*'''Comparison'''<br />
** '''Binary''' ==, != (at least one side must be a Float)<br />
** '''Binary''' >=, >, <, <= (at least one side must be a Float)<br />
** '''Unary''' !<br />
<br />
<br />
=SourceMod Specific=<br />
==New Magic Tags==<br />
In SourceMod, the rules for tags change in two cases, as there are a few 'magic' tags. These magic tags are:<br />
<ul><br />
<li>'''Function''': This is the tag returned when using a function without a call. For example: <pawn>stock Function() { }<br />
new Function:fCall = Function;</pawn></li><br />
<li>'''String''': This is a "magic" tag similar to <tt>Float</tt>. It is inherent to literal strings. Unlike <tt>Float</tt>, it secretly changes the storage method -- this makes it a true data type internally, unlike any other tag. Any array tagged as a String is stored in ''bytes'', not ''cells''. Observe the example: <pawn>new String:hello[] = "Hello";<br />
new hello2[] = "Hello";<br />
new hello3[] = {'H', 'e', 'l', 'l', 'o', 0};</pawn><br />
In this example, <tt>hello</tt> is a valid string array. To the scripter, this appears normal. Internally, it is roughly 6 bytes. This is specifically to make C++ coding of Pawn very fast and easy, in order to avoid cell to string conversion. <tt>hello2</tt> is an invalid declaration, as it is a tag mismatch. <tt>hello3</tt> is a valid declaration, but uses one cell for each character, rather than one byte. Thus, it will be incompatible with natives that use Strings. ''This is a good example of why tag coalescence is often dangerous.'' If you attempt to manually rewrite tags for strings, the result will be very unexpected, and may even crash.<br />
<br />
Note, however, that is still possible to do assignments like this:<br />
<pawn>new String:string[20]<br />
new letter = 'a'<br />
string[3] = 'a'<br />
string[a] = letter</pawn><br />
<br />
These assignments work because the <tt>String</tt> tag is a true type underneath, and will correctly cast other tags when necessary.</li><br />
</ul><br />
<br />
==Function Enumerations==<br />
SourceMod features "function enumerations," which are normal enums, except they define function prototypes rather than constants. Each of the prototypes is given a unique sub-tag that only matches a <tt>Function</tt> of that prototype. These will be explained more in the future, as they are not used yet.<br />
<br />
==New General Tags==<br />
SourceMod introduces one important general tag.<br />
*'''Handle''': Used for the [[Handles (SourceMod Scripting)|Handle System]].<br />
<br />
<br />
=AMX Mod X Specific=<br />
AMX Mod X has literally a plethora of tags, but has no new "magic" tags. Some of these tags are:<br />
*'''Sql''': An SQL index for the DBI system.<br />
*'''Result''': An SQL Result index for the DBI system.<br />
*'''Handle''': An SQL Handle (precursor to SourceMod's <tt>Handle</tt>) for the SQLX system.<br />
*'''Vault''': An index for a vault opened with the nVault module.<br />
<br />
[[Category:SourceMod Scripting]]<br />
[[Category:Scripting (AMX Mod X)]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=Tags_(Scripting)&diff=11867Tags (Scripting)2026-03-31T20:16:40Z<p>Luki1412: Added a note</p>
<hr />
<div>{{Note|As of Sourcemod 1.7 there have been significant changes to the tags and types. See [[SourcePawn_Transitional_Syntax]] for more information}}<br />
<br />
=Introduction=<br />
Tags are a concept in the original Small/Pawn language that work around the inherent lack of data types present. For example, Java/C would declare variables like so:<br />
<java>double dNumber = 5.0;<br />
int iNumber = 5;<br />
char cLetter = 'a';<br />
</java><br />
<br />
In Java, the sizes of these types respectively are eight bytes, four bytes, and two bytes. However, Pawn is only capable of one data type size. In SourcePawn, that's 32bit (four bytes). Therefore, tags serve two purposes:<br />
*Allow overloads and restrictions of basic math operators<br />
*Introduce weak typing and coalescence<br />
<br />
An example of this is:<br />
<pawn>new Float:fNum = 5.0;<br />
new iNum = 5;<br />
new char = 'A';</pawn><br />
<br />
In this example, all of the variables are the same ''type'', the <tt>cell</tt>, which is four bytes. But the <tt>fNum</tt> variable is ''tagged'' as a <tt>Float</tt>, and so it uses a set of overloaded operators for floating point math. The <tt>iNum</tt> and <tt>char</tt> variables are both integers. Even though <tt>char</tt> is only holding one byte of data (an ASCII character), it is still a 32bit data type.<br />
<br />
==Usage==<br />
Tags are identified by prefixing the tag name and a colon to a variable name. Note that you still need the <tt>new</tt> declaration, as tags aren't a declaration in and of themselves. Example:<br />
<pawn>//this is valid<br />
new ValidTag:crab = something;<br />
//this is not<br />
InvalidTag:tag = something;<br />
</pawn><br />
<br />
Tags can be used for enumerations. For example, the following defines a list of constant symbols which are each tagged as the enumeration name.<br />
<pawn>enum Clam<br />
{<br />
Oyster = 0, /* Oyster has the Clam tag */<br />
Quahog = 1, /* Quahog has the Clam tag */<br />
};</pawn><br />
<br />
==Mismatches and Coalescence==<br />
If you attempt to mix tags in an expression, you will get the infamous (213) "Tag mismatch" warning from the compiler. Although it is only a warning, it ''can'' be a serious error, and it is important that your plugins do not carry this warning (or, if they do, it is carefully understood to be safe).<br />
<br />
An example of a tag mismatch, using the above enumeration, might be:<br />
<pawn>stock GetClamNumber()<br />
{<br />
return Oyster;<br />
}<br />
<br />
stock Clam:GetOyster()<br />
{<br />
return 0;<br />
}</pawn><br />
<br />
Both of these functions will generate tag mismatch warnings by the compiler. This is because 0 is not inherently an Oyster, and Oyster is a <tt>Clam</tt>, not a raw number.<br />
<br />
Luckily in Pawn, you can 'coalesce' tags. This means you can convert one tag to another. This is usually a bad idea, however, it can be important for converting a bitstring to another bitstring, or a raw integer. The generic, or "empty" tag is <tt>_</tt>, and this symbol will effectively strip a tag from a tagged variable. For example:<br />
<pawn>stock GetClamNumber()<br />
{<br />
return _:Oyster;<br />
}<br />
<br />
stock Clam:GetOyster()<br />
{<br />
return Clam:0;<br />
}</pawn><br />
<br />
This forces the tags to be correct. ''Note that the second function could simply return <tt>Oyster</tt>. This mistake was for example purposes only.''<br />
<br />
=Built-in Tags=<br />
Pawn has two built-in tags by default. These are '''bool''' and '''Float'''.<br />
<br />
==Boolean==<br />
The <tt>bool</tt> tag (note case sensitivity) can be set to two values:<br />
*'''true''' - 1<br />
*'''false''' - 0<br />
<br />
Again, it is not faster or slower than an integer 1 or 0, because the data type is the same. This tag simply provides better looking code.<br />
<br />
==Float==<br />
The <tt>Float</tt> tag (note case sensitivity) is used for floating point math. If the compiler detects a number to have a decimal point, it is automatically tagged as Float. Floats have the following operators defined. Note that these operators are not intrinsic to the compiler, and are written in <tt>float.inc</tt>.<br />
*'''Math'''<br />
** '''Binary''' +, -, /, * (at least one side must be a Float)<br />
** '''Unary''' ++, --<br />
** '''Unary''' -<br />
*'''Comparison'''<br />
** '''Binary''' ==, != (at least one side must be a Float)<br />
** '''Binary''' >=, >, <, <= (at least one side must be a Float)<br />
** '''Unary''' !<br />
<br />
<br />
=SourceMod Specific=<br />
==New Magic Tags==<br />
In SourceMod, the rules for tags change in two cases, as there are a few 'magic' tags. These magic tags are:<br />
<ul><br />
<li>'''Function''': This is the tag returned when using a function without a call. For example: <pawn>stock Function() { }<br />
new Function:fCall = Function;</pawn></li><br />
<li>'''String''': This is a "magic" tag similar to <tt>Float</tt>. It is inherent to literal strings. Unlike <tt>Float</tt>, it secretly changes the storage method -- this makes it a true data type internally, unlike any other tag. Any array tagged as a String is stored in ''bytes'', not ''cells''. Observe the example: <pawn>new String:hello[] = "Hello";<br />
new hello2[] = "Hello";<br />
new hello3[] = {'H', 'e', 'l', 'l', 'o', 0};</pawn><br />
In this example, <tt>hello</tt> is a valid string array. To the scripter, this appears normal. Internally, it is roughly 6 bytes. This is specifically to make C++ coding of Pawn very fast and easy, in order to avoid cell to string conversion. <tt>hello2</tt> is an invalid declaration, as it is a tag mismatch. <tt>hello3</tt> is a valid declaration, but uses one cell for each character, rather than one byte. Thus, it will be incompatible with natives that use Strings. ''This is a good example of why tag coalescence is often dangerous.'' If you attempt to manually rewrite tags for strings, the result will be very unexpected, and may even crash.<br />
<br />
Note, however, that is still possible to do assignments like this:<br />
<pawn>new String:string[20]<br />
new letter = 'a'<br />
string[3] = 'a'<br />
string[a] = letter</pawn><br />
<br />
These assignments work because the <tt>String</tt> tag is a true type underneath, and will correctly cast other tags when necessary.</li><br />
</ul><br />
<br />
==Function Enumerations==<br />
SourceMod features "function enumerations," which are normal enums, except they define function prototypes rather than constants. Each of the prototypes is given a unique sub-tag that only matches a <tt>Function</tt> of that prototype. These will be explained more in the future, as they are not used yet.<br />
<br />
==New General Tags==<br />
SourceMod introduces one important general tag.<br />
*'''Handle''': Used for the [[Handles (SourceMod Scripting)|Handle System]].<br />
<br />
<br />
=AMX Mod X Specific=<br />
AMX Mod X has literally a plethora of tags, but has no new "magic" tags. Some of these tags are:<br />
*'''Sql''': An SQL index for the DBI system.<br />
*'''Result''': An SQL Result index for the DBI system.<br />
*'''Handle''': An SQL Handle (precursor to SourceMod's <tt>Handle</tt>) for the SQLX system.<br />
*'''Vault''': An index for a vault opened with the nVault module.<br />
<br />
[[Category:SourceMod Scripting]]<br />
[[Category:Scripting (AMX Mod X)]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=SDKHooks&diff=11866SDKHooks2026-03-31T20:08:18Z<p>Luki1412: Added more information about how to hook and some hooks and how to use takedamage</p>
<hr />
<div>==Introduction==<br />
SDKHooks was previously an external extension to Sourcemod. It was rolled in [https://wiki.alliedmods.net/Sourcemod_1.5.0_API_Changes#SDKHooks Sourcemod 1.5] and it does not need to be manually installed anymore.<br />
SDKHooks extension provides hooks, functions and natives. <br />
<br />
==Take Damage==<br />
Native SDKHooks_TakeDamage allows you to force an entity to take damage: <code>void SDKHooks_TakeDamage(int entity, int inflictor, int attacker,<br />
float damage, int damageType=DMG_GENERIC, int weapon=-1,<br />
const float damageForce[3]=NULL_VECTOR, const float damagePosition[3]=NULL_VECTOR,<br />
bool bypassHooks = true);</code><br><br />
Damage types are available in the sdkhooks.inc file - [https://sm.alliedmods.net/new-api/sdkhooks/__raw sdkhooks.inc]<br><br />
The weapon parameter is not used by all games and damage sources.<br />
<br />
==Hooking an entity==<br />
SDKHooks provides 3 functions related to hooking entities: '''SDKHook''', '''SDKHookEx''' and '''SDKUnhook'''<br><br />
<br />
===SDKHook===<br />
SDKHook is used to hook entities:<br />
<code><br />
void SDKHook(int entity, SDKHookType type, SDKHookCB callback);<br />
</code><br><br />
The first parameter is the entity index.<br><br />
The second parameter is the hook type, some of which are listed in the Hooks section below but you can always find the full list in the sdkhooks.inc file. Online version available [https://sm.alliedmods.net/new-api/sdkhooks/__raw here].<br><br />
The third parameter is the callback function, that will be run, when the hook is triggered.<br><br />
<br />
The callback function signature changes depending on the hook type. You can see all the callback function signatures in the sdkhooks.inc file - [https://sm.alliedmods.net/new-api/sdkhooks/__raw sdkhooks.inc]<br><br />
Example callback function signature for the OnTakeDamage hook:<br />
<code><br />
function Action (int victim, int &attacker, int &inflictor, float &damage, int &damagetype, int &weapon,<br />
float damageForce[3], float damagePosition[3], int damagecustom);<br />
</code><br><br />
Note the callback return type: <br />
*void - event cannot be changed at this point<br />
*Action - event can be changed or stopped where possible<br />
<br />
===SDKHookEx===<br />
SDKHookEx is exactly the same as SDKHook, with only 1 difference:<br />
Unlike SDKHook, it has a boolean return value telling you whether the hook was successful.<br />
<br />
===SDKUnhook===<br />
SDKUnhook removes/unhooks the hook from the entity:<br />
<code><br />
void SDKUnhook(int entity, SDKHookType type, SDKHookCB callback);<br />
</code><br><br />
It has the same parameters as SDKHook.<br />
<br />
It is rarely used, because:<br />
* SDKHooks blocks hooking the same hook (for the same entity) twice<br />
* Hooks are unhooked automatically upon destruction/removal of the entity<br />
<br />
==Hooks==<br />
Some information on various hooks below:<br />
===SDKHook_Blocked===<br />
===SDKHook_BlockedPost===<br />
===SDKHook_CanBeAutobalanced===<br />
===SDKHook_EndTouch===<br />
===SDKHook_EndTouchPost===<br />
===SDKHook_FireBulletsPost===<br />
Not all games use FireBullets so this hook will not trigger in such games.<br />
===SDKHook_GetMaxHealth===<br />
(ep2v and later)<br />
===SDKHook_GroundEntChangedPost===<br />
===SDKHook_OnTakeDamage===<br />
inflictor (3rd argument) is the entity that inflicts the damage. If a player directly damages another, inflictor should be equal to the attacking player id. An example of an indirect damage would be a grenade.<br />
<br />
====Under CSS====<br />
'''Non-regular cases for SDKHook_OnTakeDamage'''<br />
In the scenario where a player throw a grenade to another player then quickly disconnect, the attacker (2nd argument) will become the inflictor (3rd argument). <br />
<br />
In the scenario where a player fall; the attacker, which is also the inflictor, will be 0 (the world).<br />
<br />
In the scenario where a terrorist plants the bomb, when the bomb explodes, the attacker (2nd argument) will be the same as the inflictor (3rd argument) which will have the Classname "planted_c4".<br />
<br />
'''Some damage types'''<br />
A normal HEGrenade and the C4 inflict damage of type DMG_BLAST.<br />
<br />
A fall inflicts damage of type DMG_FALL.<br />
<br />
A grenade impact (for instance a flash hitting a teammate) will inflict damage of type DMG_CLUB.<br />
<br />
A normal gun bullet and the knife will inflict damage of type (DMG_BULLET | DMG_NEVERGIB) (non-headshot) or (DMG_BULLET | DMG_NEVERGIB | (1 << 30) ) (headshot).<br />
<br />
A single attack can trigger many SDKHook_OnTakeDamage; when a gun throws pullets for instance (shotgun and glock in burst-mode notably).<br />
<br />
<br />
(Regarding SM/Admin damaged; maybe place this is another section if someone can be sure that this would occur on all mods)<br />
<br />
sm_slap does not trigger SDKHook_OnTakeDamage.<br />
<br />
sm_burn will trigger two different callback : an entity with the classname "entityflame" will deal once 0 damage of type DMG_BURN and once 1 damage of type (DMG_BURN | DMG_DIRECT) every tick.<br />
<br />
'''Regarding SDKHook_OnTakeDamage and SDKHook_OnTakeDamageAlive'''<br />
<br />
SDKHook_OnTakeDamage/Post is triggered when hitting a teammate with mp_friendlyfire 0 (except in TF2), but not SDKHook_OnTakeDamageAlive.<br />
<br />
====Under TF2====<br />
Under TF2, the SDKHook_OnTakeDamage hook isn't 100% accurate, it's damage parameter is the weapon's base damage. the DMG_CRIT flag is for both crits and minicrits. Weapon spread and minicrit/crit damage is calculated after this call (in SDKHook_OnTakeDamageAlive/Post).<br />
<br />
'''Some damage types'''<br />
Shotgun = DMG_BUCKSHOT | DMG_SLOWBURN<br />
<br />
Rocket Launcher = DMG_SLOWBURN | DMG_RADIATION | DMG_BLAST<br />
<br />
If a crit, |= DMG_CRIT<br />
<br />
===SDKHook_OnTakeDamagePost===<br />
Trigged after SDKHook_OnTakeDamage, but before SDKHook_OnTakeDamageAlive<br />
===SDKHook_OnTakeDamageAlive===<br />
This hook works in a similar way to SDKHook_OnTakeDamage but it gives the [https://bugs.alliedmods.net/show_bug.cgi?id=6249#c7 actual, calculated damage amount done to the player. The pre-hook will fire after an OnTakeDamage pre-hook, and the post-hook will fire before an OnTakeDamage post-hook. The health is subtracted in between pre and post unless the hook is blocked.] {{pr|149}}<br />
<br />
[https://forums.alliedmods.net/showthread.php?p=2309798#post2309798 OnTakeDamageAlive is also only called for players.]<br />
===SDKHook_OnTakeDamageAlivePost===<br />
Triggered after the player took damage.<br />
===SDKHook_PreThink===<br />
Called before OnGameFrame(), but only for the hooked entity.<br />
===SDKHook_PreThinkPost===<br />
===SDKHook_PostThink===<br />
===SDKHook_PostThinkPost===<br />
===SDKHook_Reload===<br />
===SDKHook_ReloadPost===<br />
===SDKHook_SetTransmit===<br />
===SDKHook_ShouldCollide===<br />
===SDKHook_Spawn===<br />
Triggers when the hooked entity is about to spawn. Entity creation and spawn are not the same thing. Some entity properties are not available until the entity spawns.<br />
===SDKHook_SpawnPost===<br />
Triggers after the hooked entity was spawned.<br />
===SDKHook_StartTouch===<br />
Triggers when the hooked entity is about to be touched by another entity. Not all entities can trigger/fire touch events. Adjusting collision groups for the entity can fix that.<br />
===SDKHook_StartTouchPost===<br />
===SDKHook_Think===<br />
===SDKHook_ThinkPost===<br />
===SDKHook_Touch===<br />
===SDKHook_TouchPost===<br />
===SDKHook_TraceAttack===<br />
===SDKHook_TraceAttackPost===<br />
===SDKHook_Use===<br />
===SDKHook_UsePost===<br />
===SDKHook_VPhysicsUpdate===<br />
Triggers when the hooked entity is about to update.<br />
===SDKHook_VPhysicsUpdatePost===<br />
===SDKHook_WeaponCanSwitchTo===<br />
===SDKHook_WeaponCanSwitchToPost===<br />
===SDKHook_WeaponCanUse===<br />
===SDKHook_WeaponCanUsePost===<br />
===SDKHook_WeaponDrop===<br />
Triggers when the hooked weapon is about to be dropped.<br />
====Under TF2====<br />
When a weapon is dropped in tf2, a new entity is created called tf_dropped_weapon and this new entity is not the same entity as the one that player had equipped nor do they share entity IDs. They share the m_iAccountID property however, which contains the steam ID of the owner of the weapon that dropped it. You cannot prevent weapon drop through this hook in TF2.<br />
===SDKHook_WeaponDropPost===<br />
Triggers after the hooked weapon was dropped.<br />
===SDKHook_WeaponEquip===<br />
Triggers when the hooked weapon is about to be equipped.<br />
===SDKHook_WeaponEquipPost===<br />
Triggers after the hooked weapon was equipped.<br />
===SDKHook_WeaponSwitch===<br />
Triggers when the hooked weapon is about to be switched for another one.<br />
===SDKHook_WeaponSwitchPost===<br />
Triggers after the hooked weapon was switched for another one.<br />
[[Category:SourceMod Scripting]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=Category:SourceMod_Scripting&diff=11865Category:SourceMod Scripting2026-03-31T19:08:09Z<p>Luki1412: </p>
<hr />
<div>{{ForDevelopers}}<br />
<br />
This category contains articles about scripting for SourceMod with SourcePawn.<br />
<br />
===Introductions===<br />
*[[Introduction to SourcePawn 1.7]] - Learning language syntax.<br />
*[[SourcePawn Transitional Syntax]] - Learning transitional syntax.<br />
*[[Introduction to SourceMod Plugins]] - Writing your "first plugin."<br />
*[https://sm.alliedmods.net/new-api/ API Reference] - Searchable scripting API reference.<br />
<br />
===Basic API===<br />
*[[AutoConfigs (SourceMod Scripting)|AutoConfigs]] - Automatic .cfg creation for cvars.<br />
*[[Commands (SourceMod Scripting)|Commands]] - Console commands/input.<br />
*[[ConVars (SourceMod Scripting)|ConVars]] - Console variables (cvars).<br />
*[[Events (SourceMod Scripting)|Events]] - Half-Life 2 Game Events.<br />
*[[KeyValues (SourceMod Scripting)|KeyValues]] - KeyValues file parsing/writing.<br />
*[[Menu API (SourceMod)|Menus]] - Building and drawing menus.<br />
*[[SQL (SourceMod Scripting)|SQL]] - Using databases (MySQL, SQLite).<br />
*[[Timers (SourceMod Scripting)|Timers]] - Timed callbacks.<br />
*[[DataPacks|DataPacks]] - A good way to store asynchronous data.<br />
*[[Translations (SourceMod Scripting)|Translations]] - Internationalization.<br />
*[[Entity References (SourceMod)|Entity References]] - A safe way of storing entities.<br />
*[[Checking Admin Flags (SourceMod Scripting)|Checking Admin Flags]] - Limit commands to certain users<br />
<br />
===Advanced API===<br />
*[[Admin API (SourceMod)|Administration API]] - Using the Admin Cache.<br />
*[[Admin Menu (SourceMod Scripting)|Admin Menu API]] - Attaching to the Admin Menu.<br />
*[[Creating Natives (SourceMod Scripting)|Creating Natives]] - Exposing API to other plugins.<br />
*[[Function Calling API (SourceMod Scripting)|Function Calling API]] - Calling external functions.<br />
*[[Optional Requirements (SourceMod Scripting)|Optional Requirements]] - Managing dependencies.<br />
*[[SDKTools (SourceMod Scripting)|SDKTools]] - Using the powerful SDK abstraction layer.<br />
*[[SDKHooks]] - Using SDKHooks, that provide additional hooks and functions.<br />
*[[TempEnts (SourceMod SDKTools)|Temporary Entities]] - Using temporary entities.<br />
<br />
===Information===<br />
*[[Format Class Functions (SourceMod Scripting)|Format Class Functions]] - All about text formatting.<br />
*[[Handles (SourceMod Scripting)|Handles]] - Overview of Handles and some common types.<br />
*[[Optimizing Plugins (SourceMod Scripting)|Optimizing Plugins]] - Optimization hints.<br />
*<s>[[Tags (Scripting)|Tags]] - All about tags.</s><br />
*[[Vectors Explained (Scripting)|Vectors Explained]] - Explanation of Vector types.<br />
<br />
===Resources===<br />
*[https://sm.alliedmods.net/new-api/ API Reference] - Searchable scripting API reference.<br />
*[[Entity Properties]] - Explanation of Source entity properties.<br />
*[[Game Events (Source)|Game Events]] - Game events listings for popular mods.<br />
*[[Mod TempEnt List (Source)|Temp Entity Lists]] - Temporary entities for popular mods.<br />
*[[SourceMod Profiler]] - Performance tracking and optimizing.<br />
*[[Vice_keys]] - Decryption keys for ctx files<br />
*[[Weapon Names(Source)]] - Weapon Names / weapon entity names<br />
[[Category:SourceMod]]<br />
[[Category:SourceMod Development]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=Category:SourceMod_Scripting&diff=11864Category:SourceMod Scripting2026-03-31T19:07:52Z<p>Luki1412: </p>
<hr />
<div>{{ForDevelopers}}<br />
<br />
This category contains articles about scripting for SourceMod with SourcePawn.<br />
<br />
===Introductions===<br />
*[[Introduction to SourcePawn 1.7]] - Learning language syntax.<br />
*[[SourcePawn Transitional Syntax]] - Learning transitional syntax.<br />
*[[Introduction to SourceMod Plugins]] - Writing your "first plugin."<br />
*[https://sm.alliedmods.net/new-api/ API Reference] - Searchable scripting API reference.<br />
<br />
===Basic API===<br />
*[[AutoConfigs (SourceMod Scripting)|AutoConfigs]] - Automatic .cfg creation for cvars.<br />
*[[Commands (SourceMod Scripting)|Commands]] - Console commands/input.<br />
*[[ConVars (SourceMod Scripting)|ConVars]] - Console variables (cvars).<br />
*[[Events (SourceMod Scripting)|Events]] - Half-Life 2 Game Events.<br />
*[[KeyValues (SourceMod Scripting)|KeyValues]] - KeyValues file parsing/writing.<br />
*[[Menu API (SourceMod)|Menus]] - Building and drawing menus.<br />
*[[SQL (SourceMod Scripting)|SQL]] - Using databases (MySQL, SQLite).<br />
*[[Timers (SourceMod Scripting)|Timers]] - Timed callbacks.<br />
*[[DataPacks|DataPacks]] - A good way to store asynchronous data.<br />
*[[Translations (SourceMod Scripting)|Translations]] - Internationalization.<br />
*[[Entity References (SourceMod)|Entity References]] - A safe way of storing entities.<br />
*[[Checking Admin Flags (SourceMod Scripting)|Checking Admin Flags]] - Limit commands to certain users<br />
<br />
===Advanced API===<br />
*[[Admin API (SourceMod)|Administration API]] - Using the Admin Cache.<br />
*[[Admin Menu (SourceMod Scripting)|Admin Menu API]] - Attaching to the Admin Menu.<br />
*[[Creating Natives (SourceMod Scripting)|Creating Natives]] - Exposing API to other plugins.<br />
*[[Function Calling API (SourceMod Scripting)|Function Calling API]] - Calling external functions.<br />
*[[Optional Requirements (SourceMod Scripting)|Optional Requirements]] - Managing dependencies.<br />
*[[SDKTools (SourceMod Scripting)|SDKTools]] - Using the powerful SDK abstraction layer.<br />
*[[SDKHooks]] - Using SDKHooks, that provide additional hooks and functions.<br />
*[[TempEnts (SourceMod SDKTools)|Temporary Entities]] - Using temporary entities.<br />
<br />
===Information===<br />
*[[Format Class Functions (SourceMod Scripting)|Format Class Functions]] - All about text formatting.<br />
*[[Handles (SourceMod Scripting)|Handles]] - Overview of Handles and some common types.<br />
*[[Optimizing Plugins (SourceMod Scripting)|Optimizing Plugins]] - Optimization hints.<br />
<s>*[[Tags (Scripting)|Tags]] - All about tags.</s><br />
*[[Vectors Explained (Scripting)|Vectors Explained]] - Explanation of Vector types.<br />
<br />
===Resources===<br />
*[https://sm.alliedmods.net/new-api/ API Reference] - Searchable scripting API reference.<br />
*[[Entity Properties]] - Explanation of Source entity properties.<br />
*[[Game Events (Source)|Game Events]] - Game events listings for popular mods.<br />
*[[Mod TempEnt List (Source)|Temp Entity Lists]] - Temporary entities for popular mods.<br />
*[[SourceMod Profiler]] - Performance tracking and optimizing.<br />
*[[Vice_keys]] - Decryption keys for ctx files<br />
*[[Weapon Names(Source)]] - Weapon Names / weapon entity names<br />
[[Category:SourceMod]]<br />
[[Category:SourceMod Development]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=Category:SourceMod_Scripting&diff=11863Category:SourceMod Scripting2026-03-31T18:59:50Z<p>Luki1412: added SDKHooks</p>
<hr />
<div>{{ForDevelopers}}<br />
<br />
This category contains articles about scripting for SourceMod with SourcePawn.<br />
<br />
===Introductions===<br />
*[[Introduction to SourcePawn 1.7]] - Learning language syntax.<br />
*[[SourcePawn Transitional Syntax]] - Learning transitional syntax.<br />
*[[Introduction to SourceMod Plugins]] - Writing your "first plugin."<br />
*[https://sm.alliedmods.net/new-api/ API Reference] - Searchable scripting API reference.<br />
<br />
===Basic API===<br />
*[[AutoConfigs (SourceMod Scripting)|AutoConfigs]] - Automatic .cfg creation for cvars.<br />
*[[Commands (SourceMod Scripting)|Commands]] - Console commands/input.<br />
*[[ConVars (SourceMod Scripting)|ConVars]] - Console variables (cvars).<br />
*[[Events (SourceMod Scripting)|Events]] - Half-Life 2 Game Events.<br />
*[[KeyValues (SourceMod Scripting)|KeyValues]] - KeyValues file parsing/writing.<br />
*[[Menu API (SourceMod)|Menus]] - Building and drawing menus.<br />
*[[SQL (SourceMod Scripting)|SQL]] - Using databases (MySQL, SQLite).<br />
*[[Timers (SourceMod Scripting)|Timers]] - Timed callbacks.<br />
*[[DataPacks|DataPacks]] - A good way to store asynchronous data.<br />
*[[Translations (SourceMod Scripting)|Translations]] - Internationalization.<br />
*[[Entity References (SourceMod)|Entity References]] - A safe way of storing entities.<br />
*[[Checking Admin Flags (SourceMod Scripting)|Checking Admin Flags]] - Limit commands to certain users<br />
<br />
===Advanced API===<br />
*[[Admin API (SourceMod)|Administration API]] - Using the Admin Cache.<br />
*[[Admin Menu (SourceMod Scripting)|Admin Menu API]] - Attaching to the Admin Menu.<br />
*[[Creating Natives (SourceMod Scripting)|Creating Natives]] - Exposing API to other plugins.<br />
*[[Function Calling API (SourceMod Scripting)|Function Calling API]] - Calling external functions.<br />
*[[Optional Requirements (SourceMod Scripting)|Optional Requirements]] - Managing dependencies.<br />
*[[SDKTools (SourceMod Scripting)|SDKTools]] - Using the powerful SDK abstraction layer.<br />
*[[SDKHooks]] - Using SDK Hooks, that provide additional hooks.<br />
*[[TempEnts (SourceMod SDKTools)|Temporary Entities]] - Using temporary entities.<br />
<br />
===Information===<br />
*[[Format Class Functions (SourceMod Scripting)|Format Class Functions]] - All about text formatting.<br />
*[[Handles (SourceMod Scripting)|Handles]] - Overview of Handles and some common types.<br />
*[[Optimizing Plugins (SourceMod Scripting)|Optimizing Plugins]] - Optimization hints.<br />
*[[Tags (Scripting)|Tags]] - All about tags.<br />
*[[Vectors Explained (Scripting)|Vectors Explained]] - Explanation of Vector types.<br />
<br />
===Resources===<br />
*[https://sm.alliedmods.net/new-api/ API Reference] - Searchable scripting API reference.<br />
*[[Entity Properties]] - Explanation of Source entity properties.<br />
*[[Game Events (Source)|Game Events]] - Game events listings for popular mods.<br />
*[[Mod TempEnt List (Source)|Temp Entity Lists]] - Temporary entities for popular mods.<br />
*[[SourceMod Profiler]] - Performance tracking and optimizing.<br />
*[[Vice_keys]] - Decryption keys for ctx files<br />
*[[Weapon Names(Source)]] - Weapon Names / weapon entity names<br />
[[Category:SourceMod]]<br />
[[Category:SourceMod Development]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=Format_Class_Functions_(SourceMod_Scripting)&diff=11862Format Class Functions (SourceMod Scripting)2026-03-31T18:49:52Z<p>Luki1412: Added FormatEx</p>
<hr />
<div>=Introduction=<br />
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:<br />
<br />
<sourcepawn>char buffer[512];<br />
Format(buffer, sizeof(buffer), "Your name is: %s", userName);</sourcepawn><br />
<br />
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:<br />
<sourcepawn>const char[] fmt, any ...</sourcepawn><br />
<br />
For example, observe the following two natives:<br />
<sourcepawn>native void Format(char[] buffer, int maxlength, const char[] fmt, any ...);<br />
native void PrintToClient(int client, char[] fmt, any ...);</sourcepawn><br />
<br />
Thus, <tt>PrintToClient</tt> is a format-class function. It can be used exactly as shown earlier:<br />
<sourcepawn>PrintToClient(client, "Your name is: %s", userName);</sourcepawn><br />
<br />
=Format Specifiers=<br />
A format specifier is a code that allows you to specify what data-type to print. The most common specifiers are:<br />
*'''Numerical'''<br />
**'''d''' or '''i''': Integer number as decimal<br />
**'''u''': Unsigned integer number as decimal<br />
**'''b''': Binary digits in the value<br />
**'''f''': Floating-point number<br />
**'''x''' or '''X''': Hexadecimal representation of the binary value (capitalization affects hex letter casing)<br />
*'''Character(s)'''<br />
**'''s''': String<br />
**'''t''' or '''T''': Translates a phrase (explained in [[Translations (SourceMod_Scripting)#Usage_in_a_Plugin|Translations]])<br />
**'''c''': Prints one character (UTF-8 compliant)<br />
*'''Special'''<br />
**'''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><br />
**'''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><br />
<br />
=Usage=<br />
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:<br />
<sourcepawn>float fNum = 5.0;<br />
int iNum = 5;<br />
char[] str = "5";<br />
<br />
PrintToClient(client, "Number: %d Float: %f String: %s", iNum, fNum, str);</sourcepawn><br />
<br />
'''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.<br />
<br />
=Advanced Formatting=<br />
Format specifiers have an extended syntax for controlling various aspects of how data is printed. The full syntax is:<br />
<tt>%[flags][width][.precision]specifier</tt><br />
<br />
Each bracketed section is an optional extension. Explanations of supported SourceMod format extensions:<br />
*'''%''': Obviously, this is always required.<br />
*'''flags''':<br />
**'''-''': Left-justify (right-justify is set by default)<br />
**'''0''': Pads with 0s instead of spaces when needed (see '''width''' below).<br />
*'''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.<br />
*'''precision''': <br />
**'''For integers''': specifies the minimum number of digits to print (or pad with spaces/zeroes if below the minimum). <br />
**'''For strings''': specifies the maximum number of characters to print.<br />
**'''For floats''': specifies the number of digits to be printed ''after the decimal point''.<br />
**'''For all other types''': no effect.<br />
*'''specifier''': character specifying the data type (always required).<br />
<br />
Example:<br />
<sourcepawn><br />
PrintToServer("Characters: %c %c", 'a', 65);<br />
PrintToServer("Decimals: %d", 1977);<br />
PrintToServer("Preceding with blanks: %10d", 1977);<br />
PrintToServer("Preceding with zeros: %010d", 1977);<br />
PrintToServer("Some different radices: %d %x %X", 26, 26, 0x1A);<br />
PrintToServer("floats: %f %.2f", 3.1416, 3.1416);<br />
char abc[] = "abcdefg...";<br />
PrintToServer("%s %s", "The alphabet:", abc);<br />
PrintToServer("%s %c", abc[3], abc[3]);<br />
</sourcepawn><br />
<br />
Output:<br />
<pre><br />
Characters: a A<br />
Decimals: 1977<br />
Preceding with blanks: 1977<br />
Preceding with zeros: 0000001977<br />
Some different radices: 26 1a 1A<br />
floats: 3.141599 3.14<br />
The alphabet: abcdefg...<br />
defg... d<br />
</pre><br />
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.<br />
<br />
=Making your function Format-Class=<br />
<br />
Sourcemod allows you to make your function Format-class, ie. pass parameters to format string variables.<br />
Here's an example:<br />
<br />
<sourcepawn>public void formatExample(const char[] myString, any ...)<br />
{<br />
int len = strlen(myString) + 255;<br />
char[] myFormattedString = new char[len];<br />
VFormat(myFormattedString, len, myString, 2);<br />
<br />
PrintToServer(myFormattedString);<br />
}</sourcepawn><br />
<br />
Using the parameter "any ...", we can pass data(s) to format our string.<br />
Now, in order to replace the Format Specifiers by our data(s), we use the API "VFormat", which documentation can be found here : [https://sm.alliedmods.net/new-api/].<br />
<br />
The three first parameters passed in VFormat are pretty obvious since they are the as in the Format(..) API.<br />
<br />
The 4th parameter indicate the "any ..." parameter position in your function prototype.<br />
<br />
=FormatEx=<br />
<br />
If you plan to use Format, consider using FormatEx instead as it is slightly faster. <br />
It is the same as Format, except none of the input buffers can overlap the same memory as the output buffer. <br />
So if you do not need to use the input buffer in the output, you should use FormatEx instead of Format.<br />
<br />
[[Category:SourceMod Scripting]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=Template:Warning&diff=11861Template:Warning2025-12-31T18:41:03Z<p>Luki1412: Added warning template</p>
<hr />
<div>{| style="margin:0.5em;padding:0.3em;border-width: 2px; border-color: Orange; border-style:solid;color:DarkOrange;background-color:rgb(255, 240, 210);"<br />
| [[File:Warning.png|text-bottom|link=|alt=]] || '''Warning:''' || {{{1}}}<br />
|}</div>Luki1412https://wiki.alliedmods.net/index.php?title=Template:Note&diff=11860Template:Note2025-12-31T18:34:59Z<p>Luki1412: Replaced with a table</p>
<hr />
<div>{| style="margin:0.5em;padding:0.3em;border-width: 2px; border-color: Blue; border-style:solid;color:blue;background-color:rgb(200 230 255);"<br />
| [[File:Note.png|text-bottom|link=|alt=]] || '''Note:''' || {{{1}}}<br />
|}</div>Luki1412https://wiki.alliedmods.net/index.php?title=Template:HandleType&diff=11859Template:HandleType2025-12-31T18:28:42Z<p>Luki1412: Added color and left border</p>
<hr />
<div>{| style="border-left: 2px solid darkred"<br />
|-<br />
| style="color:darkred" | '''Type''':<br />
| {{{1}}}<br />
|-<br />
| style="color:darkred" | '''Closeable''': <br />
| {{{2}}}<br />
|-<br />
| style="color:darkred" | '''Cloneable''':<br />
| {{{3}}}<br />
|-<br />
| style="color:darkred" | '''API''':<br />
| {{{4}}}<br />
|-<br />
| style="color:darkred" | '''Found in''':<br />
| {{{5}}}<br />
|}</div>Luki1412https://wiki.alliedmods.net/index.php?title=Template:Note&diff=11858Template:Note2025-12-31T18:20:42Z<p>Luki1412: </p>
<hr />
<div><div style="margin:0.4em 1em;padding:0.3em;border-width: 2px; border-color: Blue; border-style:solid;display:inline;color:blue;background-color:rgb(200 230 255);"><strong style="display:table-cell;text-align:right;white-space:nowrap;padding-right:0.3em;">[[File:Note.png|text-bottom|link=|alt=]] Note:</strong><span style="display:table-cell;">{{{1}}}</span></div></div>Luki1412https://wiki.alliedmods.net/index.php?title=Template:Note&diff=11857Template:Note2025-12-31T18:07:01Z<p>Luki1412: </p>
<hr />
<div><div style="margin:0.4em 1em;padding:0.3em;border-width: 2px; border-color: Blue; border-style:solid;display:inline;color:blue;background-color:rgb(190 220 255);"><strong style="display:table-cell;text-align:right;white-space:nowrap;padding-right:0.3em;">[[File:Note.png|text-bottom|link=|alt=]] Note:</strong><span style="display:table-cell;">{{{1}}}</span></div></div>Luki1412https://wiki.alliedmods.net/index.php?title=Template:Note&diff=11856Template:Note2025-12-31T18:05:44Z<p>Luki1412: Added background</p>
<hr />
<div><div style="margin:0.4em 1em;padding:0.3em;border-width: 2px; border-color: Blue; border-style:solid;display:inline;color:blue;background-color:rgb(170 200 255);"><strong style="display:table-cell;text-align:right;white-space:nowrap;padding-right:0.3em;">[[File:Note.png|link=|alt=]] Note:</strong><span style="display:table-cell;">{{{1}}}</span></div></div>Luki1412https://wiki.alliedmods.net/index.php?title=Template:Note&diff=11855Template:Note2025-12-31T17:56:06Z<p>Luki1412: Changed text color</p>
<hr />
<div><div style="margin:0.4em 1em;padding:0.3em;border-width: 2px; border-color: Blue; border-style:solid;display:inline;color:blue"><strong style="display:table-cell;text-align:right;white-space:nowrap;padding-right:0.3em;">[[File:Note.png|link=|alt=]] Note:</strong><span style="display:table-cell;">{{{1}}}</span></div></div>Luki1412https://wiki.alliedmods.net/index.php?title=Template:Note&diff=11854Template:Note2025-12-31T17:55:20Z<p>Luki1412: Added border and padding and changed to inline</p>
<hr />
<div><div style="margin:0.4em 1em;padding:0.3em;border-width: 2px; border-color: Blue; border-style:solid;display:inline"><strong style="display:table-cell;text-align:right;white-space:nowrap;padding-right:0.3em;">[[File:Note.png|link=|alt=]] Note:</strong><span style="display:table-cell;">{{{1}}}</span></div></div>Luki1412https://wiki.alliedmods.net/index.php?title=Template:ForAdvancedDevelopers&diff=11853Template:ForAdvancedDevelopers2025-12-31T17:22:11Z<p>Luki1412: Added the link to the scripting category</p>
<hr />
<div><div style="padding: 0.75em 1.5em; border-width: 2px; border-color: Orange; border-style:solid; background-color: Moccasin; max-width: 60rem;"><br />
[[File:Wires.png|frameless|128px|left|link=|alt=]]<br />
<b style="font-size: 20px"><br />
For Internal Development<br />
</b><br />
<p><br />
This page is geared towards helping developers learn how to use the behind-the-scenes parts of {{{1|SourceMod}}} itself.<br />
If you're looking to contribute to or extend {{{1|SourceMod}}}, this is probably the page for you!<br />
To learn how to create and modify SourceMod plugins, check out the '''[[:Category:SourceMod_Scripting|scripting]]''' categories for articles about scripting for SourceMod with SourcePawn.<br />
</p><br />
</div></div>Luki1412https://wiki.alliedmods.net/index.php?title=Template:ForSysadmins&diff=11852Template:ForSysadmins2025-12-31T17:16:16Z<p>Luki1412: Added the link to the development category</p>
<hr />
<div><div style="padding: 0.75em 1.5em; border-width: 2px; border-color: LightPink; border-style:solid; background-color: MistyRose; max-width: 60rem;"><br />
[[File:FlorkSunglasses.png|frameless|64px|left|link=|alt=]]<br />
<b style="font-size: 20px"><br />
For System Administrators<br />
</b><br />
<p><br />
This page is geared towards helping a sysadmin install, manage, and maintain a {{{1|SourceMod}}} installation.<br />
If you're looking to create, develop, or modify {{{1|SourceMod}}} plugins, check out the '''[[:Category:SourceMod_Development|development]]''' pages for relevant documentation.<br />
</p><br />
</div></div>Luki1412https://wiki.alliedmods.net/index.php?title=Template:ForDevelopers&diff=11851Template:ForDevelopers2025-12-31T17:00:01Z<p>Luki1412: Added the link to the documentation</p>
<hr />
<div><div style="padding: 0.75em 1.5em; border-width: 2px; border-color: LightSeaGreen; border-style:solid; background-color: Azure; max-width: 60rem;"><br />
[[File:Silly goose.png|frameless|64px|left|link=|alt=]]<br />
<b style="font-size: 20px"><br />
For Developers & Modders<br />
</b><br />
<p><br />
This page is geared towards helping developers learn how to create and modify {{{1|SourceMod}}} plugins.<br />
To learn how to install and manage {{{1|SourceMod}}} itself, check out the '''[[:Category:SourceMod_Documentation|documentation]]''' categories for system-administrator geared articles.<br />
</p><br />
</div></div>Luki1412https://wiki.alliedmods.net/index.php?title=User_talk:Luki1412&diff=11850User talk:Luki14122025-11-20T17:12:17Z<p>Luki1412: Created page with "We can talk maybe"</p>
<hr />
<div>We can talk maybe</div>Luki1412https://wiki.alliedmods.net/index.php?title=User:Luki1412&diff=11849User:Luki14122025-11-20T17:11:04Z<p>Luki1412: Created page with "Why are you here? Go [https://forums.alliedmods.net/member.php?u=43109 here] instead"</p>
<hr />
<div>Why are you here?<br />
<br />
Go [https://forums.alliedmods.net/member.php?u=43109 here] instead</div>Luki1412https://wiki.alliedmods.net/index.php?title=DataPacks&diff=11848DataPacks2025-11-15T14:29:44Z<p>Luki1412: Added link to Timers/DataTimers</p>
<hr />
<div>DataPacks are a way to store and move around various types of data in [[:Category:SourceMod Scripting|SourceMod Scripting]]. Since some things are not possible in SourcePawn, such as a function consuming a String, DataPacks help us get these Strings and other items where they need to go.<br />
<br />
=Example of using a DataPack=<br />
Syntax:<br />
<sourcepawn><br />
//writing<br />
DataPack pack = new DataPack();<br />
pack.WriteCell(23);<br />
pack.WriteString("I'm a little teapot.");<br />
<br />
//reading<br />
pack.Reset(); //resets the index to the beginning, necessary for read.<br />
int cellValue = pack.ReadCell();<br />
char buffer[1024];<br />
pack.ReadString(buffer, 1024);<br />
</sourcepawn><br />
<br />
=Creating a DataPack=<br />
Creating a DataPack is very simple; all you need is a Handle to write to.<br />
<sourcepawn>Datapack dataPackHandle = new DataPack();</sourcepawn><br />
<br />
For more information on using Handles, see [[Handle API (SourceMod)]].<br />
<br />
=DataPack Functions=<br />
On you have created your DataPack, you can use a variety of functions to manage the DataPack.<br />
<br />
==WritePackCell==<br />
Syntax:<br />
<sourcepawn>native void WritePackCell(Handle pack, any cell);<br />
</sourcepawn><br />
<br />
==WritePackFloat==<br />
This function can be used to write a Float to a DataPack.<br />
<br />
Syntax:<br />
<sourcepawn>native void WritePackFloat(Handle pack, float val);<br />
</sourcepawn><br />
<br />
==WritePackString==<br />
This function can be used to write a String to a DataPack.<br />
<br />
Syntax:<br />
<sourcepawn>native void WritePackString(Handle pack, const char[] str);<br />
</sourcepawn><br />
<br />
==ReadPackCell==<br />
Syntax:<br />
<sourcepawn>native any ReadPackCell(Handle pack);<br />
</sourcepawn><br />
<br />
==ReadPackFloat==<br />
This function can be used to read a Float from a DataPack.<br />
<br />
Syntax:<br />
<sourcepawn>native float ReadPackFloat(Handle pack);<br />
</sourcepawn><br />
<br />
==ReadPackString==<br />
This function can be used to read a String from a DataPack.<br />
<br />
Syntax:<br />
<sourcepawn>native void ReadPackString(Handle pack, char[] buffer, maxlen);<br />
</sourcepawn><br />
<br />
==ResetPack==<br />
This function resets your position in the DataPack.<br />
<br />
Syntax:<br />
<sourcepawn>native void ResetPack(Handle pack, bool clear=false);<br />
</sourcepawn><br />
<br />
==GetPackPosition==<br />
This function gets your current position in the DataPack.<br />
<br />
Syntax:<br />
<sourcepawn>native int GetPackPosition(Handle pack);<br />
</sourcepawn><br />
<br />
==SetPackPosition==<br />
This function sets your current position in the DataPack.<br />
<br />
Syntax:<br />
<sourcepawn>native void SetPackPosition(Handle pack, int position);<br />
</sourcepawn><br />
<br />
=Disposing of a DataPack=<br />
To dispose of a DataPack, all you have to do is close its Handle.<br />
<br />
Example:<br />
<sourcepawn>CloseHandle(dataPackHandle);<br />
</sourcepawn><br />
<br />
=DataTimers=<br />
DataPacks can be used with timers, in order to send more than one value. For more information, visit [[Timers_(SourceMod_Scripting)]]<br />
<br />
[[Category:SourceMod Scripting]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=SDKHooks&diff=11847SDKHooks2025-09-07T17:24:19Z<p>Luki1412: </p>
<hr />
<div>==Introduction==<br />
SDKHooks was previously an external extension to Sourcemod. It was rolled in [https://wiki.alliedmods.net/Sourcemod_1.5.0_API_Changes#SDKHooks Sourcemod 1.5] and it does not need to be manually installed anymore.<br />
SDKHooks blocks hooking the same hook twice.<br />
<br />
==Hooks==<br />
Some information on various hooks below:<br />
===SDKHook_Blocked===<br />
===SDKHook_BlockedPost===<br />
===SDKHook_CanBeAutobalanced===<br />
===SDKHook_EndTouch===<br />
===SDKHook_EndTouchPost===<br />
===SDKHook_FireBulletsPost===<br />
Not all games use FireBullets so this hook will not trigger in such games.<br />
===SDKHook_GetMaxHealth===<br />
(ep2v and later)<br />
===SDKHook_GroundEntChangedPost===<br />
===SDKHook_OnTakeDamage===<br />
inflictor (3rd argument) is the entity that inflicts the damage. If a player directly damages another, inflictor should be equal to the attacking player id. An example of an indirect damage would be a grenade.<br />
<br />
====Under CSS====<br />
'''Non-regular cases for SDKHook_OnTakeDamage'''<br />
In the scenario where a player throw a grenade to another player then quickly disconnect, the attacker (2nd argument) will become the inflictor (3rd argument). <br />
<br />
In the scenario where a player fall; the attacker, which is also the inflictor, will be 0 (the world).<br />
<br />
In the scenario where a terrorist plants the bomb, when the bomb explodes, the attacker (2nd argument) will be the same as the inflictor (3rd argument) which will have the Classname "planted_c4".<br />
<br />
'''Some damage types'''<br />
A normal HEGrenade and the C4 inflict damage of type DMG_BLAST.<br />
<br />
A fall inflicts damage of type DMG_FALL.<br />
<br />
A grenade impact (for instance a flash hitting a teammate) will inflict damage of type DMG_CLUB.<br />
<br />
A normal gun bullet and the knife will inflict damage of type (DMG_BULLET | DMG_NEVERGIB) (non-headshot) or (DMG_BULLET | DMG_NEVERGIB | (1 << 30) ) (headshot).<br />
<br />
A single attack can trigger many SDKHook_OnTakeDamage; when a gun throws pullets for instance (shotgun and glock in burst-mode notably).<br />
<br />
<br />
(Regarding SM/Admin damaged; maybe place this is another section if someone can be sure that this would occur on all mods)<br />
<br />
sm_slap does not trigger SDKHook_OnTakeDamage.<br />
<br />
sm_burn will trigger two different callback : an entity with the classname "entityflame" will deal once 0 damage of type DMG_BURN and once 1 damage of type (DMG_BURN | DMG_DIRECT) every tick.<br />
<br />
'''Regarding SDKHook_OnTakeDamage and SDKHook_OnTakeDamageAlive'''<br />
<br />
SDKHook_OnTakeDamage/Post is triggered when hitting a teammate with mp_friendlyfire 0 (except in TF2), but not SDKHook_OnTakeDamageAlive.<br />
<br />
====Under TF2====<br />
Under TF2, the SDKHook_OnTakeDamage hook isn't 100% accurate, it's damage parameter is the weapon's base damage. the DMG_CRIT flag is for both crits and minicrits. Weapon spread and minicrit/crit damage is calculated after this call (in SDKHook_OnTakeDamageAlive/Post).<br />
<br />
'''Some damage types'''<br />
Shotgun = DMG_BUCKSHOT | DMG_SLOWBURN<br />
<br />
Rocket Launcher = DMG_SLOWBURN | DMG_RADIATION | DMG_BLAST<br />
<br />
If a crit, |= DMG_CRIT<br />
<br />
===SDKHook_OnTakeDamagePost===<br />
===SDKHook_OnTakeDamageAlive===<br />
This hook works in a similar way to SDKHook_OnTakeDamage but it gives the [https://bugs.alliedmods.net/show_bug.cgi?id=6249#c7 actual, calculated damage amount done to the player. The pre-hook will fire after an OnTakeDamage pre-hook, and the post-hook will fire before an OnTakeDamage post-hook. The health is subtracted in between pre and post unless the hook is blocked.] {{pr|149}}<br />
<br />
[https://forums.alliedmods.net/showthread.php?p=2309798#post2309798 OnTakeDamageAlive is also only called for players.]<br />
===SDKHook_OnTakeDamageAlivePost===<br />
===SDKHook_PreThink===<br />
Called before OnGameFrame(), but only for the hooked entity.<br />
===SDKHook_PreThinkPost===<br />
===SDKHook_PostThink===<br />
===SDKHook_PostThinkPost===<br />
===SDKHook_Reload===<br />
===SDKHook_ReloadPost===<br />
===SDKHook_SetTransmit===<br />
===SDKHook_ShouldCollide===<br />
===SDKHook_Spawn===<br />
Triggers when the hooked entity is about to spawn. Entity creation and spawn are not the same thing. Some entity properties are not available until the entity spawns.<br />
===SDKHook_SpawnPost===<br />
Triggers when the hooked entity was spawned.<br />
===SDKHook_StartTouch===<br />
Triggers when the hooked entity is about to be touched by another entity. Not all entities can trigger/fire touch events. Adjusting collision groups for the entity can fix that.<br />
===SDKHook_StartTouchPost===<br />
===SDKHook_Think===<br />
===SDKHook_ThinkPost===<br />
===SDKHook_Touch===<br />
===SDKHook_TouchPost===<br />
===SDKHook_TraceAttack===<br />
===SDKHook_TraceAttackPost===<br />
===SDKHook_Use===<br />
===SDKHook_UsePost===<br />
===SDKHook_VPhysicsUpdate===<br />
Triggers when the hooked entity is about to update.<br />
===SDKHook_VPhysicsUpdatePost===<br />
===SDKHook_WeaponCanSwitchTo===<br />
===SDKHook_WeaponCanSwitchToPost===<br />
===SDKHook_WeaponCanUse===<br />
===SDKHook_WeaponCanUsePost===<br />
===SDKHook_WeaponDrop===<br />
Triggers when the hooked weapon is about to be dropped.<br />
====Under TF2====<br />
When a weapon is dropped in tf2, a new entity is created called tf_dropped_weapon and this new entity is not the same entity as the one that player had equipped nor do they share entity IDs. They share the m_iAccountID property however, which contains the steam ID of the owner of the weapon that dropped it. You cannot prevent weapon drop through this hook in TF2.<br />
===SDKHook_WeaponDropPost===<br />
Triggers when the hooked weapon was dropped.<br />
===SDKHook_WeaponEquip===<br />
Triggers when the hooked weapon is about to be equipped.<br />
===SDKHook_WeaponEquipPost===<br />
Triggers when the hooked weapon was equipped.<br />
===SDKHook_WeaponSwitch===<br />
Triggers when the hooked weapon is about to be switched for another one.<br />
===SDKHook_WeaponSwitchPost===<br />
Triggers when the hooked weapon was switched for another one.<br />
[[Category:SourceMod Scripting]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=SDKHooks&diff=11846SDKHooks2025-09-07T15:35:07Z<p>Luki1412: </p>
<hr />
<div>==Introduction==<br />
SDKHooks was previously an external extension to Sourcemod. It was rolled in [https://wiki.alliedmods.net/Sourcemod_1.5.0_API_Changes#SDKHooks Sourcemod 1.5] and it does not need to be manually installed anymore.<br />
<br />
==Hooks==<br />
Some information on various hooks below:<br />
===SDKHook_Blocked===<br />
===SDKHook_BlockedPost===<br />
===SDKHook_CanBeAutobalanced===<br />
===SDKHook_EndTouch===<br />
===SDKHook_EndTouchPost===<br />
===SDKHook_FireBulletsPost===<br />
Not all games use FireBullets so this hook will not trigger in such games.<br />
===SDKHook_GetMaxHealth===<br />
(ep2v and later)<br />
===SDKHook_GroundEntChangedPost===<br />
===SDKHook_OnTakeDamage===<br />
inflictor (3rd argument) is the entity that inflicts the damage. If a player directly damages another, inflictor should be equal to the attacking player id. An example of an indirect damage would be a grenade.<br />
<br />
====Under CSS====<br />
'''Non-regular cases for SDKHook_OnTakeDamage'''<br />
In the scenario where a player throw a grenade to another player then quickly disconnect, the attacker (2nd argument) will become the inflictor (3rd argument). <br />
<br />
In the scenario where a player fall; the attacker, which is also the inflictor, will be 0 (the world).<br />
<br />
In the scenario where a terrorist plants the bomb, when the bomb explodes, the attacker (2nd argument) will be the same as the inflictor (3rd argument) which will have the Classname "planted_c4".<br />
<br />
'''Some damage types'''<br />
A normal HEGrenade and the C4 inflict damage of type DMG_BLAST.<br />
<br />
A fall inflicts damage of type DMG_FALL.<br />
<br />
A grenade impact (for instance a flash hitting a teammate) will inflict damage of type DMG_CLUB.<br />
<br />
A normal gun bullet and the knife will inflict damage of type (DMG_BULLET | DMG_NEVERGIB) (non-headshot) or (DMG_BULLET | DMG_NEVERGIB | (1 << 30) ) (headshot).<br />
<br />
A single attack can trigger many SDKHook_OnTakeDamage; when a gun throws pullets for instance (shotgun and glock in burst-mode notably).<br />
<br />
<br />
(Regarding SM/Admin damaged; maybe place this is another section if someone can be sure that this would occur on all mods)<br />
<br />
sm_slap does not trigger SDKHook_OnTakeDamage.<br />
<br />
sm_burn will trigger two different callback : an entity with the classname "entityflame" will deal once 0 damage of type DMG_BURN and once 1 damage of type (DMG_BURN | DMG_DIRECT) every tick.<br />
<br />
'''Regarding SDKHook_OnTakeDamage and SDKHook_OnTakeDamageAlive'''<br />
<br />
SDKHook_OnTakeDamage/Post is triggered when hitting a teammate with mp_friendlyfire 0 (except in TF2), but not SDKHook_OnTakeDamageAlive.<br />
<br />
====Under TF2====<br />
Under TF2, the SDKHook_OnTakeDamage hook isn't 100% accurate, it's damage parameter is the weapon's base damage. the DMG_CRIT flag is for both crits and minicrits. Weapon spread and minicrit/crit damage is calculated after this call (in SDKHook_OnTakeDamageAlive/Post).<br />
<br />
'''Some damage types'''<br />
Shotgun = DMG_BUCKSHOT | DMG_SLOWBURN<br />
<br />
Rocket Launcher = DMG_SLOWBURN | DMG_RADIATION | DMG_BLAST<br />
<br />
If a crit, |= DMG_CRIT<br />
<br />
===SDKHook_OnTakeDamagePost===<br />
===SDKHook_OnTakeDamageAlive===<br />
This hook works in a similar way to SDKHook_OnTakeDamage but it gives the [https://bugs.alliedmods.net/show_bug.cgi?id=6249#c7 actual, calculated damage amount done to the player. The pre-hook will fire after an OnTakeDamage pre-hook, and the post-hook will fire before an OnTakeDamage post-hook. The health is subtracted in between pre and post unless the hook is blocked.] {{pr|149}}<br />
<br />
[https://forums.alliedmods.net/showthread.php?p=2309798#post2309798 OnTakeDamageAlive is also only called for players.]<br />
===SDKHook_OnTakeDamageAlivePost===<br />
===SDKHook_PreThink===<br />
Called before OnGameFrame(), but only for the hooked entity.<br />
===SDKHook_PreThinkPost===<br />
===SDKHook_PostThink===<br />
===SDKHook_PostThinkPost===<br />
===SDKHook_Reload===<br />
===SDKHook_ReloadPost===<br />
===SDKHook_SetTransmit===<br />
===SDKHook_ShouldCollide===<br />
===SDKHook_Spawn===<br />
Triggers when the hooked entity is about to spawn. Entity creation and spawn are not the same thing. Some entity properties are not available until the entity spawns.<br />
===SDKHook_SpawnPost===<br />
Triggers when the hooked entity was spawned.<br />
===SDKHook_StartTouch===<br />
Triggers when the hooked entity is about to be touched by another entity. Not all entities can trigger/fire touch events. Adjusting collision groups for the entity can fix that.<br />
===SDKHook_StartTouchPost===<br />
===SDKHook_Think===<br />
===SDKHook_ThinkPost===<br />
===SDKHook_Touch===<br />
===SDKHook_TouchPost===<br />
===SDKHook_TraceAttack===<br />
===SDKHook_TraceAttackPost===<br />
===SDKHook_Use===<br />
===SDKHook_UsePost===<br />
===SDKHook_VPhysicsUpdate===<br />
Triggers when the hooked entity is about to move.<br />
===SDKHook_VPhysicsUpdatePost===<br />
===SDKHook_WeaponCanSwitchTo===<br />
===SDKHook_WeaponCanSwitchToPost===<br />
===SDKHook_WeaponCanUse===<br />
===SDKHook_WeaponCanUsePost===<br />
===SDKHook_WeaponDrop===<br />
Triggers when the hooked weapon is about to be dropped.<br />
====Under TF2====<br />
When a weapon is dropped in tf2, a new entity is created called tf_dropped_weapon and this new entity is not the same entity as the one that player had equipped nor do they share entity IDs. They share the m_iAccountID property however, which contains the steam ID of the owner of the weapon that dropped it. You cannot prevent weapon drop through this hook in TF2.<br />
===SDKHook_WeaponDropPost===<br />
Triggers when the hooked weapon was dropped.<br />
===SDKHook_WeaponEquip===<br />
Triggers when the hooked weapon is about to be equipped.<br />
===SDKHook_WeaponEquipPost===<br />
Triggers when the hooked weapon was equipped.<br />
===SDKHook_WeaponSwitch===<br />
Triggers when the hooked weapon is about to be switched for another one.<br />
===SDKHook_WeaponSwitchPost===<br />
Triggers when the hooked weapon was switched for another one.<br />
[[Category:SourceMod Scripting]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=SDKHooks&diff=11845SDKHooks2025-09-07T15:25:06Z<p>Luki1412: </p>
<hr />
<div>==Introduction==<br />
SDKHooks was previously an external extension to Sourcemod. It was rolled in [https://wiki.alliedmods.net/Sourcemod_1.5.0_API_Changes#SDKHooks Sourcemod 1.5] and it does not need to be manually installed anymore.<br />
<br />
==Hooks==<br />
Some information on various hooks below:<br />
===SDKHook_Blocked===<br />
===SDKHook_BlockedPost===<br />
===SDKHook_CanBeAutobalanced===<br />
===SDKHook_EndTouch===<br />
===SDKHook_EndTouchPost===<br />
===SDKHook_FireBulletsPost===<br />
===SDKHook_GetMaxHealth===<br />
(ep2v and later)<br />
===SDKHook_GroundEntChangedPost===<br />
===SDKHook_OnTakeDamage===<br />
inflictor (3rd argument) is the entity that inflicts the damage. If a player directly damages another, inflictor should be equal to the attacking player id. An example of an indirect damage would be a grenade.<br />
<br />
====Under CSS====<br />
'''Non-regular cases for SDKHook_OnTakeDamage'''<br />
In the scenario where a player throw a grenade to another player then quickly disconnect, the attacker (2nd argument) will become the inflictor (3rd argument). <br />
<br />
In the scenario where a player fall; the attacker, which is also the inflictor, will be 0 (the world).<br />
<br />
In the scenario where a terrorist plants the bomb, when the bomb explodes, the attacker (2nd argument) will be the same as the inflictor (3rd argument) which will have the Classname "planted_c4".<br />
<br />
'''Some damage types'''<br />
A normal HEGrenade and the C4 inflict damage of type DMG_BLAST.<br />
<br />
A fall inflicts damage of type DMG_FALL.<br />
<br />
A grenade impact (for instance a flash hitting a teammate) will inflict damage of type DMG_CLUB.<br />
<br />
A normal gun bullet and the knife will inflict damage of type (DMG_BULLET | DMG_NEVERGIB) (non-headshot) or (DMG_BULLET | DMG_NEVERGIB | (1 << 30) ) (headshot).<br />
<br />
A single attack can trigger many SDKHook_OnTakeDamage; when a gun throws pullets for instance (shotgun and glock in burst-mode notably).<br />
<br />
<br />
(Regarding SM/Admin damaged; maybe place this is another section if someone can be sure that this would occur on all mods)<br />
<br />
sm_slap does not trigger SDKHook_OnTakeDamage.<br />
<br />
sm_burn will trigger two different callback : an entity with the classname "entityflame" will deal once 0 damage of type DMG_BURN and once 1 damage of type (DMG_BURN | DMG_DIRECT) every tick.<br />
<br />
'''Regarding SDKHook_OnTakeDamage and SDKHook_OnTakeDamageAlive'''<br />
<br />
SDKHook_OnTakeDamage/Post is triggered when hitting a teammate with mp_friendlyfire 0 (except in TF2), but not SDKHook_OnTakeDamageAlive.<br />
<br />
====Under TF2====<br />
Under TF2, the SDKHook_OnTakeDamage hook isn't 100% accurate, it's damage parameter is the weapon's base damage. the DMG_CRIT flag is for both crits and minicrits. Weapon spread and minicrit/crit damage is calculated after this call (in SDKHook_OnTakeDamageAlive/Post).<br />
<br />
'''Some damage types'''<br />
Shotgun = DMG_BUCKSHOT | DMG_SLOWBURN<br />
<br />
Rocket Launcher = DMG_SLOWBURN | DMG_RADIATION | DMG_BLAST<br />
<br />
If a crit, |= DMG_CRIT<br />
<br />
===SDKHook_OnTakeDamagePost===<br />
===SDKHook_OnTakeDamageAlive===<br />
This hook works in a similar way to SDKHook_OnTakeDamage but it gives the [https://bugs.alliedmods.net/show_bug.cgi?id=6249#c7 actual, calculated damage amount done to the player. The pre-hook will fire after an OnTakeDamage pre-hook, and the post-hook will fire before an OnTakeDamage post-hook. The health is subtracted in between pre and post unless the hook is blocked.] {{pr|149}}<br />
<br />
[https://forums.alliedmods.net/showthread.php?p=2309798#post2309798 OnTakeDamageAlive is also only called for players.]<br />
===SDKHook_OnTakeDamageAlivePost===<br />
===SDKHook_PreThink===<br />
Called before OnGameFrame(), but only for the hooked entity.<br />
===SDKHook_PreThinkPost===<br />
===SDKHook_PostThink===<br />
===SDKHook_PostThinkPost===<br />
===SDKHook_Reload===<br />
===SDKHook_ReloadPost===<br />
===SDKHook_SetTransmit===<br />
===SDKHook_ShouldCollide===<br />
===SDKHook_Spawn===<br />
Triggers when the hooked entity is about to spawn. Entity creation and spawn are not the same thing. Some entity properties are not available until the entity spawns.<br />
===SDKHook_SpawnPost===<br />
Triggers when the hooked entity was spawned.<br />
===SDKHook_StartTouch===<br />
Triggers when the hooked entity is about to be touched by another entity. Not all entities can trigger/fire touch events. Adjusting collision groups for the entity can fix that.<br />
===SDKHook_StartTouchPost===<br />
===SDKHook_Think===<br />
===SDKHook_ThinkPost===<br />
===SDKHook_Touch===<br />
===SDKHook_TouchPost===<br />
===SDKHook_TraceAttack===<br />
===SDKHook_TraceAttackPost===<br />
===SDKHook_Use===<br />
===SDKHook_UsePost===<br />
===SDKHook_VPhysicsUpdate===<br />
Triggers when the hooked entity is about to move.<br />
===SDKHook_VPhysicsUpdatePost===<br />
===SDKHook_WeaponCanSwitchTo===<br />
===SDKHook_WeaponCanSwitchToPost===<br />
===SDKHook_WeaponCanUse===<br />
===SDKHook_WeaponCanUsePost===<br />
===SDKHook_WeaponDrop===<br />
Triggers when the hooked weapon is about to be dropped.<br />
====Under TF2====<br />
When a weapon is dropped in tf2, a new entity is created called tf_dropped_weapon and this new entity is not the same entity as the one that player had equipped nor do they share entity IDs. They share the m_iAccountID property however, which contains the steam ID of the owner of the weapon that dropped it. You cannot prevent weapon drop through this hook in TF2.<br />
===SDKHook_WeaponDropPost===<br />
Triggers when the hooked weapon was dropped.<br />
===SDKHook_WeaponEquip===<br />
Triggers when the hooked weapon is about to be equipped.<br />
===SDKHook_WeaponEquipPost===<br />
Triggers when the hooked weapon was equipped.<br />
===SDKHook_WeaponSwitch===<br />
Triggers when the hooked weapon is about to be switched for another one.<br />
===SDKHook_WeaponSwitchPost===<br />
Triggers when the hooked weapon was switched for another one.<br />
[[Category:SourceMod Scripting]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=SDKHooks&diff=11844SDKHooks2025-09-07T14:10:41Z<p>Luki1412: </p>
<hr />
<div>==Introduction==<br />
SDKHooks was previously an external extension to Sourcemod. It was rolled in [https://wiki.alliedmods.net/Sourcemod_1.5.0_API_Changes#SDKHooks Sourcemod 1.5] and it does not need to be manually installed anymore.<br />
<br />
==Hooks==<br />
Some information on various hooks below:<br />
===SDKHook_Blocked===<br />
===SDKHook_BlockedPost===<br />
===SDKHook_CanBeAutobalanced===<br />
===SDKHook_EndTouch===<br />
===SDKHook_EndTouchPost===<br />
===SDKHook_FireBulletsPost===<br />
===SDKHook_GetMaxHealth===<br />
(ep2v and later)<br />
===SDKHook_GroundEntChangedPost===<br />
===SDKHook_OnTakeDamage===<br />
inflictor (3rd argument) is the entity that inflicts the damage. If a player directly damages another, inflictor should be equal to the attacking player id. An example of an indirect damage would be a grenade.<br />
<br />
====Under CSS====<br />
'''Non-regular cases for SDKHook_OnTakeDamage'''<br />
In the scenario where a player throw a grenade to another player then quickly disconnect, the attacker (2nd argument) will become the inflictor (3rd argument). <br />
<br />
In the scenario where a player fall; the attacker, which is also the inflictor, will be 0 (the world).<br />
<br />
In the scenario where a terrorist plants the bomb, when the bomb explodes, the attacker (2nd argument) will be the same as the inflictor (3rd argument) which will have the Classname "planted_c4".<br />
<br />
'''Some damage types'''<br />
A normal HEGrenade and the C4 inflict damage of type DMG_BLAST.<br />
<br />
A fall inflicts damage of type DMG_FALL.<br />
<br />
A grenade impact (for instance a flash hitting a teammate) will inflict damage of type DMG_CLUB.<br />
<br />
A normal gun bullet and the knife will inflict damage of type (DMG_BULLET | DMG_NEVERGIB) (non-headshot) or (DMG_BULLET | DMG_NEVERGIB | (1 << 30) ) (headshot).<br />
<br />
A single attack can trigger many SDKHook_OnTakeDamage; when a gun throws pullets for instance (shotgun and glock in burst-mode notably).<br />
<br />
<br />
(Regarding SM/Admin damaged; maybe place this is another section if someone can be sure that this would occur on all mods)<br />
<br />
sm_slap does not trigger SDKHook_OnTakeDamage.<br />
<br />
sm_burn will trigger two different callback : an entity with the classname "entityflame" will deal once 0 damage of type DMG_BURN and once 1 damage of type (DMG_BURN | DMG_DIRECT) every tick.<br />
<br />
'''Regarding SDKHook_OnTakeDamage and SDKHook_OnTakeDamageAlive'''<br />
<br />
SDKHook_OnTakeDamage/Post is triggered when hitting a teammate with mp_friendlyfire 0 (except in TF2), but not SDKHook_OnTakeDamageAlive.<br />
<br />
====Under TF2====<br />
Under TF2, the SDKHook_OnTakeDamage hook isn't 100% accurate, it's damage parameter is the weapon's base damage. the DMG_CRIT flag is for both crits and minicrits. Weapon spread and minicrit/crit damage is calculated after this call (in SDKHook_OnTakeDamageAlive/Post).<br />
<br />
'''Some damage types'''<br />
Shotgun = DMG_BUCKSHOT | DMG_SLOWBURN<br />
<br />
Rocket Launcher = DMG_SLOWBURN | DMG_RADIATION | DMG_BLAST<br />
<br />
If a crit, |= DMG_CRIT<br />
<br />
===SDKHook_OnTakeDamagePost===<br />
===SDKHook_OnTakeDamageAlive===<br />
This hook works in a similar way to SDKHook_OnTakeDamage but it gives the [https://bugs.alliedmods.net/show_bug.cgi?id=6249#c7 actual, calculated damage amount done to the player. The pre-hook will fire after an OnTakeDamage pre-hook, and the post-hook will fire before an OnTakeDamage post-hook. The health is subtracted in between pre and post unless the hook is blocked.] {{pr|149}}<br />
<br />
[https://forums.alliedmods.net/showthread.php?p=2309798#post2309798 OnTakeDamageAlive is also only called for players.]<br />
===SDKHook_OnTakeDamageAlivePost===<br />
===SDKHook_PreThink===<br />
===SDKHook_PreThinkPost===<br />
===SDKHook_PostThink===<br />
===SDKHook_PostThinkPost===<br />
===SDKHook_Reload===<br />
===SDKHook_ReloadPost===<br />
===SDKHook_SetTransmit===<br />
===SDKHook_ShouldCollide===<br />
===SDKHook_Spawn===<br />
Triggers when the hooked entity is about to spawn. Entity creation and spawn are not the same thing. Some entity properties are not available until the entity spawns.<br />
===SDKHook_SpawnPost===<br />
Triggers when the hooked entity was spawned.<br />
===SDKHook_StartTouch===<br />
Triggers when the hooked entity is about to be touched by another entity. Not all entities can trigger/fire touch events. Adjusting collision groups for the entity can fix that.<br />
===SDKHook_StartTouchPost===<br />
===SDKHook_Think===<br />
===SDKHook_ThinkPost===<br />
===SDKHook_Touch===<br />
===SDKHook_TouchPost===<br />
===SDKHook_TraceAttack===<br />
===SDKHook_TraceAttackPost===<br />
===SDKHook_Use===<br />
===SDKHook_UsePost===<br />
===SDKHook_VPhysicsUpdate===<br />
===SDKHook_VPhysicsUpdatePost===<br />
===SDKHook_WeaponCanSwitchTo===<br />
===SDKHook_WeaponCanSwitchToPost===<br />
===SDKHook_WeaponCanUse===<br />
===SDKHook_WeaponCanUsePost===<br />
===SDKHook_WeaponDrop===<br />
Triggers when the hooked weapon is about to be dropped.<br />
====Under TF2====<br />
When a weapon is dropped in tf2, a new entity is created called tf_dropped_weapon and this new entity is not the same entity as the one that player had equipped nor do they share entity IDs. They share the m_iAccountID property however, which contains the steam ID of the owner of the weapon that dropped it. You cannot prevent weapon drop through this hook in TF2.<br />
===SDKHook_WeaponDropPost===<br />
Triggers when the hooked weapon was dropped.<br />
===SDKHook_WeaponEquip===<br />
Triggers when the hooked weapon is about to be equipped.<br />
===SDKHook_WeaponEquipPost===<br />
Triggers when the hooked weapon was equipped.<br />
===SDKHook_WeaponSwitch===<br />
Triggers when the hooked weapon is about to be switched.<br />
===SDKHook_WeaponSwitchPost===<br />
Triggers when the hooked weapon was switched.<br />
[[Category:SourceMod Scripting]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=SDKHooks&diff=11843SDKHooks2025-09-07T13:59:31Z<p>Luki1412: </p>
<hr />
<div>==Introduction==<br />
SDKHooks was previously an external extension to Sourcemod. It was rolled in [https://wiki.alliedmods.net/Sourcemod_1.5.0_API_Changes#SDKHooks Sourcemod 1.5] and it does not need to be manually installed anymore.<br />
<br />
==Hooks==<br />
Some information on various hooks below:<br />
===SDKHook_Blocked===<br />
===SDKHook_BlockedPost===<br />
===SDKHook_CanBeAutobalanced===<br />
===SDKHook_EndTouch===<br />
===SDKHook_EndTouchPost===<br />
===SDKHook_FireBulletsPost===<br />
===SDKHook_GetMaxHealth===<br />
(ep2v and later)<br />
===SDKHook_GroundEntChangedPost===<br />
===SDKHook_OnTakeDamage===<br />
inflictor (3rd argument) is the entity that inflicts the damage. If a player directly damages another, inflictor should be equal to the attacking player id. An example of an indirect damage would be a grenade.<br />
<br />
====Under CSS====<br />
'''Non-regular cases for SDKHook_OnTakeDamage'''<br />
In the scenario where a player throw a grenade to another player then quickly disconnect, the attacker (2nd argument) will become the inflictor (3rd argument). <br />
<br />
In the scenario where a player fall; the attacker, which is also the inflictor, will be 0 (the world).<br />
<br />
In the scenario where a terrorist plants the bomb, when the bomb explodes, the attacker (2nd argument) will be the same as the inflictor (3rd argument) which will have the Classname "planted_c4".<br />
<br />
'''Some damage types'''<br />
A normal HEGrenade and the C4 inflict damage of type DMG_BLAST.<br />
<br />
A fall inflicts damage of type DMG_FALL.<br />
<br />
A grenade impact (for instance a flash hitting a teammate) will inflict damage of type DMG_CLUB.<br />
<br />
A normal gun bullet and the knife will inflict damage of type (DMG_BULLET | DMG_NEVERGIB) (non-headshot) or (DMG_BULLET | DMG_NEVERGIB | (1 << 30) ) (headshot).<br />
<br />
A single attack can trigger many SDKHook_OnTakeDamage; when a gun throws pullets for instance (shotgun and glock in burst-mode notably).<br />
<br />
<br />
(Regarding SM/Admin damaged; maybe place this is another section if someone can be sure that this would occur on all mods)<br />
<br />
sm_slap does not trigger SDKHook_OnTakeDamage.<br />
<br />
sm_burn will trigger two different callback : an entity with the classname "entityflame" will deal once 0 damage of type DMG_BURN and once 1 damage of type (DMG_BURN | DMG_DIRECT) every tick.<br />
<br />
'''Regarding SDKHook_OnTakeDamage and SDKHook_OnTakeDamageAlive'''<br />
<br />
SDKHook_OnTakeDamage/Post is triggered when hitting a teammate with mp_friendlyfire 0 (except in TF2), but not SDKHook_OnTakeDamageAlive.<br />
<br />
====Under TF2====<br />
Under TF2, the SDKHook_OnTakeDamage hook isn't 100% accurate, it's damage parameter is the weapon's base damage. the DMG_CRIT flag is for both crits and minicrits. Weapon spread and minicrit/crit damage is calculated after this call (in SDKHook_OnTakeDamageAlive/Post).<br />
<br />
'''Some damage types'''<br />
Shotgun = DMG_BUCKSHOT | DMG_SLOWBURN<br />
<br />
Rocket Launcher = DMG_SLOWBURN | DMG_RADIATION | DMG_BLAST<br />
<br />
If a crit, |= DMG_CRIT<br />
<br />
===SDKHook_OnTakeDamagePost===<br />
===SDKHook_OnTakeDamageAlive===<br />
This hook works in a similar way to SDKHook_OnTakeDamage but it gives the [https://bugs.alliedmods.net/show_bug.cgi?id=6249#c7 actual, calculated damage amount done to the player. The pre-hook will fire after an OnTakeDamage pre-hook, and the post-hook will fire before an OnTakeDamage post-hook. The health is subtracted in between pre and post unless the hook is blocked.] {{pr|149}}<br />
<br />
[https://forums.alliedmods.net/showthread.php?p=2309798#post2309798 OnTakeDamageAlive is also only called for players.]<br />
===SDKHook_OnTakeDamageAlivePost===<br />
===SDKHook_PreThink===<br />
===SDKHook_PreThinkPost===<br />
===SDKHook_PostThink===<br />
===SDKHook_PostThinkPost===<br />
===SDKHook_Reload===<br />
===SDKHook_ReloadPost===<br />
===SDKHook_SetTransmit===<br />
===SDKHook_ShouldCollide===<br />
===SDKHook_Spawn===<br />
Triggers when the hooked entity is about to spawn. Entity creation and spawn are not the same thing. Some entity properties are not available until the entity spawns.<br />
===SDKHook_SpawnPost===<br />
Triggers when the hooked entity was spawned.<br />
===SDKHook_StartTouch===<br />
Triggers when the hooked entity is about to be touched by another entity. Not all entities can trigger/fire touch events. Adjusting collision groups for the entity can fix that.<br />
===SDKHook_StartTouchPost===<br />
===SDKHook_Think===<br />
===SDKHook_ThinkPost===<br />
===SDKHook_Touch===<br />
===SDKHook_TouchPost===<br />
===SDKHook_TraceAttack===<br />
===SDKHook_TraceAttackPost===<br />
===SDKHook_Use===<br />
===SDKHook_UsePost===<br />
===SDKHook_VPhysicsUpdate===<br />
===SDKHook_VPhysicsUpdatePost===<br />
===SDKHook_WeaponCanSwitchTo===<br />
===SDKHook_WeaponCanSwitchToPost===<br />
===SDKHook_WeaponCanUse===<br />
===SDKHook_WeaponCanUsePost===<br />
===SDKHook_WeaponDrop===<br />
Triggers when the hooked weapon is about to be dropped.<br />
====Under TF2====<br />
When a weapon is dropped in tf2, a new entity is created called tf_dropped_weapon and this new entity is not the same entity as the one that player had equipped nor do they share entity IDs. They share the m_iAccountID property however, which contains the steam ID of the owner of the weapon that dropped it. You cannot prevent weapon drop through this hook in TF2.<br />
===SDKHook_WeaponDropPost===<br />
Triggers when the hooked was dropped.<br />
===SDKHook_WeaponEquip===<br />
Triggers when the hooked weapon is about to be equipped.<br />
===SDKHook_WeaponEquipPost===<br />
Triggers when the hooked weapon was equipped.<br />
===SDKHook_WeaponSwitch===<br />
===SDKHook_WeaponSwitchPost===<br />
<br />
[[Category:SourceMod Scripting]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=SDKHooks&diff=11842SDKHooks2025-09-07T13:57:39Z<p>Luki1412: </p>
<hr />
<div>==Introduction==<br />
SDKHooks was previously an external extension to Sourcemod. It was rolled in [https://wiki.alliedmods.net/Sourcemod_1.5.0_API_Changes#SDKHooks Sourcemod 1.5] and it does not need to be manually installed anymore.<br />
<br />
==Hooks==<br />
Some information on various hooks below:<br />
===SDKHook_Blocked===<br />
===SDKHook_BlockedPost===<br />
===SDKHook_CanBeAutobalanced===<br />
===SDKHook_EndTouch===<br />
===SDKHook_EndTouchPost===<br />
===SDKHook_FireBulletsPost===<br />
===SDKHook_GetMaxHealth===<br />
(ep2v and later)<br />
===SDKHook_GroundEntChangedPost===<br />
===SDKHook_OnTakeDamage===<br />
inflictor (3rd argument) is the entity that inflicts the damage. If a player directly damages another, inflictor should be equal to the attacking player id. An example of an indirect damage would be a grenade.<br />
<br />
====Under CSS====<br />
'''Non-regular cases for SDKHook_OnTakeDamage'''<br />
In the scenario where a player throw a grenade to another player then quickly disconnect, the attacker (2nd argument) will become the inflictor (3rd argument). <br />
<br />
In the scenario where a player fall; the attacker, which is also the inflictor, will be 0 (the world).<br />
<br />
In the scenario where a terrorist plants the bomb, when the bomb explodes, the attacker (2nd argument) will be the same as the inflictor (3rd argument) which will have the Classname "planted_c4".<br />
<br />
'''Some damage types'''<br />
A normal HEGrenade and the C4 inflict damage of type DMG_BLAST.<br />
<br />
A fall inflicts damage of type DMG_FALL.<br />
<br />
A grenade impact (for instance a flash hitting a teammate) will inflict damage of type DMG_CLUB.<br />
<br />
A normal gun bullet and the knife will inflict damage of type (DMG_BULLET | DMG_NEVERGIB) (non-headshot) or (DMG_BULLET | DMG_NEVERGIB | (1 << 30) ) (headshot).<br />
<br />
A single attack can trigger many SDKHook_OnTakeDamage; when a gun throws pullets for instance (shotgun and glock in burst-mode notably).<br />
<br />
<br />
(Regarding SM/Admin damaged; maybe place this is another section if someone can be sure that this would occur on all mods)<br />
<br />
sm_slap does not trigger SDKHook_OnTakeDamage.<br />
<br />
sm_burn will trigger two different callback : an entity with the classname "entityflame" will deal once 0 damage of type DMG_BURN and once 1 damage of type (DMG_BURN | DMG_DIRECT) every tick.<br />
<br />
'''Regarding SDKHook_OnTakeDamage and SDKHook_OnTakeDamageAlive'''<br />
<br />
SDKHook_OnTakeDamage/Post is triggered when hitting a teammate with mp_friendlyfire 0 (except in TF2), but not SDKHook_OnTakeDamageAlive.<br />
<br />
====Under TF2====<br />
Under TF2, the SDKHook_OnTakeDamage hook isn't 100% accurate, it's damage parameter is the weapon's base damage. the DMG_CRIT flag is for both crits and minicrits. Weapon spread and minicrit/crit damage is calculated after this call (in SDKHook_OnTakeDamageAlive/Post).<br />
<br />
'''Some damage types'''<br />
Shotgun = DMG_BUCKSHOT | DMG_SLOWBURN<br />
<br />
Rocket Launcher = DMG_SLOWBURN | DMG_RADIATION | DMG_BLAST<br />
<br />
If a crit, |= DMG_CRIT<br />
<br />
===SDKHook_OnTakeDamagePost===<br />
===SDKHook_OnTakeDamageAlive===<br />
This hook works in a similar way to SDKHook_OnTakeDamage but it gives the [https://bugs.alliedmods.net/show_bug.cgi?id=6249#c7 actual, calculated damage amount done to the player. The pre-hook will fire after an OnTakeDamage pre-hook, and the post-hook will fire before an OnTakeDamage post-hook. The health is subtracted in between pre and post unless the hook is blocked.] {{pr|149}}<br />
<br />
[https://forums.alliedmods.net/showthread.php?p=2309798#post2309798 OnTakeDamageAlive is also only called for players.]<br />
===SDKHook_OnTakeDamageAlivePost===<br />
===SDKHook_PreThink===<br />
===SDKHook_PreThinkPost===<br />
===SDKHook_PostThink===<br />
===SDKHook_PostThinkPost===<br />
===SDKHook_Reload===<br />
===SDKHook_ReloadPost===<br />
===SDKHook_SetTransmit===<br />
===SDKHook_ShouldCollide===<br />
===SDKHook_Spawn===<br />
Triggers when the hooked entity is about to spawn. Entity creation and spawn are not the same thing. Some entity properties are not available until the entity spawns.<br />
===SDKHook_SpawnPost===<br />
Triggers when the hooked entity was spawned.<br />
===SDKHook_StartTouch===<br />
Triggers when the hooked entity is about to be touched by another entity. Not all entity can trigger/fire touch events.<br />
===SDKHook_StartTouchPost===<br />
===SDKHook_Think===<br />
===SDKHook_ThinkPost===<br />
===SDKHook_Touch===<br />
===SDKHook_TouchPost===<br />
===SDKHook_TraceAttack===<br />
===SDKHook_TraceAttackPost===<br />
===SDKHook_Use===<br />
===SDKHook_UsePost===<br />
===SDKHook_VPhysicsUpdate===<br />
===SDKHook_VPhysicsUpdatePost===<br />
===SDKHook_WeaponCanSwitchTo===<br />
===SDKHook_WeaponCanSwitchToPost===<br />
===SDKHook_WeaponCanUse===<br />
===SDKHook_WeaponCanUsePost===<br />
===SDKHook_WeaponDrop===<br />
Triggered when the hooked weapon is about to be dropped.<br />
====Under TF2====<br />
When a weapon is dropped in tf2, a new entity is created called tf_dropped_weapon and this new entity is not the same entity as the one that player had equipped nor do they share entity IDs. They share the m_iAccountID property however, which contains the steam ID of the owner of the weapon that dropped it. You cannot prevent weapon drop through this hook in TF2.<br />
===SDKHook_WeaponDropPost===<br />
Triggered when the hooked was dropped.<br />
===SDKHook_WeaponEquip===<br />
Triggered when the hooked weapon is about to be equipped.<br />
===SDKHook_WeaponEquipPost===<br />
Triggered when the hooked weapon was equipped.<br />
===SDKHook_WeaponSwitch===<br />
===SDKHook_WeaponSwitchPost===<br />
<br />
[[Category:SourceMod Scripting]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=SDKHooks&diff=11841SDKHooks2025-09-07T13:33:04Z<p>Luki1412: </p>
<hr />
<div>==Introduction==<br />
SDKHooks was previously an external extension to Sourcemod. It was rolled in [https://wiki.alliedmods.net/Sourcemod_1.5.0_API_Changes#SDKHooks Sourcemod 1.5] and it does not need to be manually installed anymore.<br />
<br />
==Hooks==<br />
Some information on various hooks below:<br />
===SDKHook_Blocked===<br />
===SDKHook_BlockedPost===<br />
===SDKHook_CanBeAutobalanced===<br />
===SDKHook_EndTouch===<br />
===SDKHook_EndTouchPost===<br />
===SDKHook_FireBulletsPost===<br />
===SDKHook_GetMaxHealth===<br />
(ep2v and later)<br />
===SDKHook_GroundEntChangedPost===<br />
===SDKHook_OnTakeDamage===<br />
inflictor (3rd argument) is the entity that inflicts the damage. If a player directly damages another, inflictor should be equal to the attacking player id. An example of an indirect damage would be a grenade.<br />
<br />
====Under CSS====<br />
'''Non-regular cases for SDKHook_OnTakeDamage'''<br />
In the scenario where a player throw a grenade to another player then quickly disconnect, the attacker (2nd argument) will become the inflictor (3rd argument). <br />
<br />
In the scenario where a player fall; the attacker, which is also the inflictor, will be 0 (the world).<br />
<br />
In the scenario where a terrorist plants the bomb, when the bomb explodes, the attacker (2nd argument) will be the same as the inflictor (3rd argument) which will have the Classname "planted_c4".<br />
<br />
'''Some damage types'''<br />
A normal HEGrenade and the C4 inflict damage of type DMG_BLAST.<br />
<br />
A fall inflicts damage of type DMG_FALL.<br />
<br />
A grenade impact (for instance a flash hitting a teammate) will inflict damage of type DMG_CLUB.<br />
<br />
A normal gun bullet and the knife will inflict damage of type (DMG_BULLET | DMG_NEVERGIB) (non-headshot) or (DMG_BULLET | DMG_NEVERGIB | (1 << 30) ) (headshot).<br />
<br />
A single attack can trigger many SDKHook_OnTakeDamage; when a gun throws pullets for instance (shotgun and glock in burst-mode notably).<br />
<br />
<br />
(Regarding SM/Admin damaged; maybe place this is another section if someone can be sure that this would occur on all mods)<br />
<br />
sm_slap does not trigger SDKHook_OnTakeDamage.<br />
<br />
sm_burn will trigger two different callback : an entity with the classname "entityflame" will deal once 0 damage of type DMG_BURN and once 1 damage of type (DMG_BURN | DMG_DIRECT) every tick.<br />
<br />
'''Regarding SDKHook_OnTakeDamage and SDKHook_OnTakeDamageAlive'''<br />
<br />
SDKHook_OnTakeDamage/Post is triggered when hitting a teammate with mp_friendlyfire 0 (except in TF2), but not SDKHook_OnTakeDamageAlive.<br />
<br />
====Under TF2====<br />
Under TF2, the SDKHook_OnTakeDamage hook isn't 100% accurate, it's damage parameter is the weapon's base damage. the DMG_CRIT flag is for both crits and minicrits. Weapon spread and minicrit/crit damage is calculated after this call (in SDKHook_OnTakeDamageAlive/Post).<br />
<br />
'''Some damage types'''<br />
Shotgun = DMG_BUCKSHOT | DMG_SLOWBURN<br />
<br />
Rocket Launcher = DMG_SLOWBURN | DMG_RADIATION | DMG_BLAST<br />
<br />
If a crit, |= DMG_CRIT<br />
<br />
===SDKHook_OnTakeDamagePost===<br />
===SDKHook_OnTakeDamageAlive===<br />
This hook works in a similar way to SDKHook_OnTakeDamage but it gives the [https://bugs.alliedmods.net/show_bug.cgi?id=6249#c7 actual, calculated damage amount done to the player. The pre-hook will fire after an OnTakeDamage pre-hook, and the post-hook will fire before an OnTakeDamage post-hook. The health is subtracted in between pre and post unless the hook is blocked.] {{pr|149}}<br />
<br />
[https://forums.alliedmods.net/showthread.php?p=2309798#post2309798 OnTakeDamageAlive is also only called for players.]<br />
===SDKHook_OnTakeDamageAlivePost===<br />
===SDKHook_PreThink===<br />
===SDKHook_PreThinkPost===<br />
===SDKHook_PostThink===<br />
===SDKHook_PostThinkPost===<br />
===SDKHook_Reload===<br />
===SDKHook_ReloadPost===<br />
===SDKHook_SetTransmit===<br />
===SDKHook_ShouldCollide===<br />
===SDKHook_Spawn===<br />
Entity creation and spawn are not the same thing. Some entity properties are not available until the entity spawns. This hook is before the entity spawns.<br />
===SDKHook_SpawnPost===<br />
===SDKHook_StartTouch===<br />
===SDKHook_StartTouchPost===<br />
===SDKHook_Think===<br />
===SDKHook_ThinkPost===<br />
===SDKHook_Touch===<br />
===SDKHook_TouchPost===<br />
===SDKHook_TraceAttack===<br />
===SDKHook_TraceAttackPost===<br />
===SDKHook_Use===<br />
===SDKHook_UsePost===<br />
===SDKHook_VPhysicsUpdate===<br />
===SDKHook_VPhysicsUpdatePost===<br />
===SDKHook_WeaponCanSwitchTo===<br />
===SDKHook_WeaponCanSwitchToPost===<br />
===SDKHook_WeaponCanUse===<br />
===SDKHook_WeaponCanUsePost===<br />
===SDKHook_WeaponDrop===<br />
Triggered when a weapon is about to be dropped.<br />
====Under TF2====<br />
When a weapon is dropped in tf2, a new entity is created called tf_dropped_weapon and this new entity is not the same entity as the one that player had equipped nor do they share entity IDs. They share the m_iAccountID property however, which contains the steam ID of the owner of the weapon that dropped it. You cannot prevent weapon drop through this hook in TF2.<br />
===SDKHook_WeaponDropPost===<br />
===SDKHook_WeaponEquip===<br />
===SDKHook_WeaponEquipPost===<br />
===SDKHook_WeaponSwitch===<br />
===SDKHook_WeaponSwitchPost===<br />
<br />
[[Category:SourceMod Scripting]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=SDKHooks&diff=11840SDKHooks2025-09-07T13:03:40Z<p>Luki1412: </p>
<hr />
<div>==Introduction==<br />
SDKHooks was previously an external extension to Sourcemod. It was rolled in [https://wiki.alliedmods.net/Sourcemod_1.5.0_API_Changes#SDKHooks Sourcemod 1.5] and it does not need to be manually installed anymore.<br />
<br />
==Hooks==<br />
Some information on various hooks below:<br />
===SDKHook_Blocked===<br />
===SDKHook_BlockedPost===<br />
===SDKHook_CanBeAutobalanced===<br />
===SDKHook_EndTouch===<br />
===SDKHook_EndTouchPost===<br />
===SDKHook_FireBulletsPost===<br />
===SDKHook_GetMaxHealth===<br />
(ep2v and later)<br />
===SDKHook_GroundEntChangedPost===<br />
===SDKHook_OnTakeDamage===<br />
inflictor (3rd argument) is the entity that inflicts the damage. If a player directly damages another, inflictor should be equal to the attacking player id. An example of an indirect damage would be a grenade.<br />
<br />
====Under CSS====<br />
'''Non-regular cases for SDKHook_OnTakeDamage'''<br />
In the scenario where a player throw a grenade to another player then quickly disconnect, the attacker (2nd argument) will become the inflictor (3rd argument). <br />
<br />
In the scenario where a player fall; the attacker, which is also the inflictor, will be 0 (the world).<br />
<br />
In the scenario where a terrorist plants the bomb, when the bomb explodes, the attacker (2nd argument) will be the same as the inflictor (3rd argument) which will have the Classname "planted_c4".<br />
<br />
'''Some damage types'''<br />
A normal HEGrenade and the C4 inflict damage of type DMG_BLAST.<br />
<br />
A fall inflicts damage of type DMG_FALL.<br />
<br />
A grenade impact (for instance a flash hitting a teammate) will inflict damage of type DMG_CLUB.<br />
<br />
A normal gun bullet and the knife will inflict damage of type (DMG_BULLET | DMG_NEVERGIB) (non-headshot) or (DMG_BULLET | DMG_NEVERGIB | (1 << 30) ) (headshot).<br />
<br />
A single attack can trigger many SDKHook_OnTakeDamage; when a gun throws pullets for instance (shotgun and glock in burst-mode notably).<br />
<br />
<br />
(Regarding SM/Admin damaged; maybe place this is another section if someone can be sure that this would occur on all mods)<br />
<br />
sm_slap does not trigger SDKHook_OnTakeDamage.<br />
<br />
sm_burn will trigger two different callback : an entity with the classname "entityflame" will deal once 0 damage of type DMG_BURN and once 1 damage of type (DMG_BURN | DMG_DIRECT) every tick.<br />
<br />
'''Regarding SDKHook_OnTakeDamage and SDKHook_OnTakeDamageAlive'''<br />
<br />
SDKHook_OnTakeDamage/Post is triggered when hitting a teammate with mp_friendlyfire 0 (except in TF2), but not SDKHook_OnTakeDamageAlive.<br />
<br />
====Under TF2====<br />
Under TF2, the SDKHook_OnTakeDamage hook isn't 100% accurate, it's damage parameter is the weapon's base damage. the DMG_CRIT flag is for both crits and minicrits. Weapon spread and minicrit/crit damage is calculated after this call (in SDKHook_OnTakeDamageAlive/Post).<br />
<br />
'''Some damage types'''<br />
Shotgun = DMG_BUCKSHOT | DMG_SLOWBURN<br />
<br />
Rocket Launcher = DMG_SLOWBURN | DMG_RADIATION | DMG_BLAST<br />
<br />
If a crit, |= DMG_CRIT<br />
<br />
===SDKHook_OnTakeDamagePost===<br />
===SDKHook_OnTakeDamageAlive===<br />
This hook works in a similar way to SDKHook_OnTakeDamage but it gives the [https://bugs.alliedmods.net/show_bug.cgi?id=6249#c7 actual, calculated damage amount done to the player. The pre-hook will fire after an OnTakeDamage pre-hook, and the post-hook will fire before an OnTakeDamage post-hook. The health is subtracted in between pre and post unless the hook is blocked.] {{pr|149}}<br />
<br />
[https://forums.alliedmods.net/showthread.php?p=2309798#post2309798 OnTakeDamageAlive is also only called for players.]<br />
===SDKHook_OnTakeDamageAlivePost===<br />
===SDKHook_PreThink===<br />
===SDKHook_PreThinkPost===<br />
===SDKHook_PostThink===<br />
===SDKHook_PostThinkPost===<br />
===SDKHook_Reload===<br />
===SDKHook_ReloadPost===<br />
===SDKHook_SetTransmit===<br />
===SDKHook_ShouldCollide===<br />
===SDKHook_Spawn===<br />
===SDKHook_SpawnPost===<br />
===SDKHook_StartTouch===<br />
===SDKHook_StartTouchPost===<br />
===SDKHook_Think===<br />
===SDKHook_ThinkPost===<br />
===SDKHook_Touch===<br />
===SDKHook_TouchPost===<br />
===SDKHook_TraceAttack===<br />
===SDKHook_TraceAttackPost===<br />
===SDKHook_Use===<br />
===SDKHook_UsePost===<br />
===SDKHook_VPhysicsUpdate===<br />
===SDKHook_VPhysicsUpdatePost===<br />
===SDKHook_WeaponCanSwitchTo===<br />
===SDKHook_WeaponCanSwitchToPost===<br />
===SDKHook_WeaponCanUse===<br />
===SDKHook_WeaponCanUsePost===<br />
===SDKHook_WeaponDrop===<br />
===SDKHook_WeaponDropPost===<br />
===SDKHook_WeaponEquip===<br />
===SDKHook_WeaponEquipPost===<br />
===SDKHook_WeaponSwitch===<br />
===SDKHook_WeaponSwitchPost===<br />
<br />
[[Category:SourceMod Scripting]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=SDKHooks&diff=11839SDKHooks2025-09-07T12:59:01Z<p>Luki1412: Added other hooks</p>
<hr />
<div>==Introduction==<br />
SDKHooks was previously an external extension to Sourcemod. It was rolled in [https://wiki.alliedmods.net/Sourcemod_1.5.0_API_Changes#SDKHooks Sourcemod 1.5] and it does not need to be manually installed anymore.<br />
<br />
==Hooks==<br />
Some information on various hooks below:<br />
==SDKHook_Blocked==<br />
==SDKHook_BlockedPost==<br />
==SDKHook_CanBeAutobalanced==<br />
==SDKHook_EndTouch==<br />
==SDKHook_EndTouchPost==<br />
==SDKHook_FireBulletsPost==<br />
==SDKHook_GetMaxHealth==<br />
(ep2v and later)<br />
==SDKHook_GroundEntChangedPost==<br />
==SDKHook_OnTakeDamage==<br />
inflictor (3rd argument) is the entity that inflicts the damage. If a player directly damages another, inflictor should be equal to the attacking player id. An example of an indirect damage would be a grenade.<br />
==SDKHook_OnTakeDamagePost==<br />
==SDKHook_OnTakeDamageAlive==<br />
This hook works in a similar way to SDKHook_OnTakeDamage but it gives the [https://bugs.alliedmods.net/show_bug.cgi?id=6249#c7 actual, calculated damage amount done to the player. The pre-hook will fire after an OnTakeDamage pre-hook, and the post-hook will fire before an OnTakeDamage post-hook. The health is subtracted in between pre and post unless the hook is blocked.] {{pr|149}}<br />
<br />
[https://forums.alliedmods.net/showthread.php?p=2309798#post2309798 OnTakeDamageAlive is also only called for players.]<br />
==SDKHook_OnTakeDamageAlivePost==<br />
==SDKHook_PreThink==<br />
==SDKHook_PreThinkPost==<br />
==SDKHook_PostThink==<br />
==SDKHook_PostThinkPost==<br />
==SDKHook_Reload==<br />
==SDKHook_ReloadPost==<br />
==SDKHook_SetTransmit==<br />
==SDKHook_ShouldCollide==<br />
==SDKHook_Spawn==<br />
==SDKHook_SpawnPost==<br />
==SDKHook_StartTouch==<br />
==SDKHook_StartTouchPost==<br />
==SDKHook_Think==<br />
==SDKHook_ThinkPost==<br />
==SDKHook_Touch==<br />
==SDKHook_TouchPost==<br />
==SDKHook_TraceAttack==<br />
==SDKHook_TraceAttackPost==<br />
==SDKHook_Use==<br />
==SDKHook_UsePost==<br />
==SDKHook_VPhysicsUpdate==<br />
==SDKHook_VPhysicsUpdatePost==<br />
==SDKHook_WeaponCanSwitchTo==<br />
==SDKHook_WeaponCanSwitchToPost==<br />
==SDKHook_WeaponCanUse==<br />
==SDKHook_WeaponCanUsePost==<br />
==SDKHook_WeaponDrop==<br />
==SDKHook_WeaponDropPost==<br />
==SDKHook_WeaponEquip==<br />
==SDKHook_WeaponEquipPost==<br />
==SDKHook_WeaponSwitch==<br />
==SDKHook_WeaponSwitchPost==<br />
<br />
==Under CSS==<br />
===Non-regular cases for SDKHook_OnTakeDamage===<br />
In the scenario where a player throw a grenade to another player then quickly disconnect, the attacker (2nd argument) will become the inflictor (3rd argument). <br />
<br />
In the scenario where a player fall; the attacker, which is also the inflictor, will be 0 (the world).<br />
<br />
In the scenario where a terrorist plants the bomb, when the bomb explodes, the attacker (2nd argument) will be the same as the inflictor (3rd argument) which will have the Classname "planted_c4".<br />
<br />
===Some damage types===<br />
A normal HEGrenade and the C4 inflict damage of type DMG_BLAST.<br />
<br />
A fall inflicts damage of type DMG_FALL.<br />
<br />
A grenade impact (for instance a flash hitting a teammate) will inflict damage of type DMG_CLUB.<br />
<br />
A normal gun bullet and the knife will inflict damage of type (DMG_BULLET | DMG_NEVERGIB) (non-headshot) or (DMG_BULLET | DMG_NEVERGIB | (1 << 30) ) (headshot).<br />
<br />
A single attack can trigger many SDKHook_OnTakeDamage; when a gun throws pullets for instance (shotgun and glock in burst-mode notably).<br />
<br />
<br />
(Regarding SM/Admin damaged; maybe place this is another section if someone can be sure that this would occur on all mods)<br />
<br />
sm_slap does not trigger SDKHook_OnTakeDamage.<br />
<br />
sm_burn will trigger two different callback : an entity with the classname "entityflame" will deal once 0 damage of type DMG_BURN and once 1 damage of type (DMG_BURN | DMG_DIRECT) every tick.<br />
<br />
===Regarding SDKHook_OnTakeDamage and SDKHook_OnTakeDamageAlive===<br />
<br />
SDKHook_OnTakeDamage/Post is triggered when hitting a teammate with mp_friendlyfire 0 (except in TF2), but not SDKHook_OnTakeDamageAlive.<br />
<br />
==Under TF2==<br />
Under TF2, the SDKHook_OnTakeDamage hook isn't 100% accurate, it's damage parameter is the weapon's base damage. the DMG_CRIT flag is for both crits and minicrits. Weapon spread and minicrit/crit damage is calculated after this call (in SDKHook_OnTakeDamageAlive/Post).<br />
<br />
===Some damage types===<br />
Shotgun = DMG_BUCKSHOT | DMG_SLOWBURN<br />
<br />
Rocket Launcher = DMG_SLOWBURN | DMG_RADIATION | DMG_BLAST<br />
<br />
If a crit, |= DMG_CRIT<br />
<br />
[[Category:SourceMod Scripting]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=Rcon&diff=11838Rcon2025-09-02T19:51:36Z<p>Luki1412: </p>
<hr />
<div>Rcon is a TCP/IP protocol for remote connections to the server console of a game server that supports it. This connection allows administering console commands directly to the server and therefore can be a security risk.<br />
<br />
More information about this protocol's implementation in source games can be found [https://developer.valvesoftware.com/wiki/Source_RCON_Protocol here].</div>Luki1412https://wiki.alliedmods.net/index.php?title=Rcon&diff=11837Rcon2025-09-02T19:47:50Z<p>Luki1412: </p>
<hr />
<div>Rcon is a TCP/IP protocol for remote connections to the server console of a game server that supports it. This connection allows administering console commands directly to the server therefore can be a security risk.<br />
<br />
More information about this protocol's implementation in source games can be found [https://developer.valvesoftware.com/wiki/Source_RCON_Protocol here]</div>Luki1412https://wiki.alliedmods.net/index.php?title=Rcon&diff=11836Rcon2025-09-02T19:46:34Z<p>Luki1412: Created page with "Rcon is a TCP/IP protocol for remote connections to the server console of a game server that supports it. This connection allows administering console commands directly to the..."</p>
<hr />
<div>Rcon is a TCP/IP protocol for remote connections to the server console of a game server that supports it. This connection allows administering console commands directly to the server.<br />
<br />
More information about this protocol's implementation in source games can be found here:[https://developer.valvesoftware.com/wiki/Source_RCON_Protocol]</div>Luki1412https://wiki.alliedmods.net/index.php?title=Installing_SourceMod&diff=11835Installing SourceMod2025-09-02T19:19:32Z<p>Luki1412: </p>
<hr />
<div>{{Languages|Installing_SourceMod}}<br />
<br />
Installing SourceMod is very simple, and it can be added with almost no configuration changes.<br />
<br />
=Prerequisites=<br />
A GUI Web Browser to retrieve Metamod:Source and SourceMod compressed archives.<br />
A tool to copy archive to your dedicated server host.<br />
<br />
SourceMod requires [[Metamod:Source]] 1.9.0 or higher (it is recommended that the latest version is used). [http://www.metamodsource.net/ Click here] to visit the Metamod:Source homepage. Instructions to install Metamod:Source manually can be found [[Installing Metamod:Source|here]].<br />
<br />
SourceMod will run on almost any mod built using the Source SDK. Only the latest release of a mod is officially supported.<br />
<br />
Valve sometimes makes changes in their games that break SourceMod between releases. When this happens, you may need to install snapshot versions of Metamod:Source and SourceMod. You can see if this is required on the [[Required Versions (SourceMod)|Required Versions]] page.<br />
<br />
=Uploading/Installing=<br />
==Local Server==<br />
To install [http://www.sourcemod.net/downloads.php SourceMod] locally, simply extract the <tt>.zip</tt> (Windows) or <tt>.tar.gz</tt> (Linux) package to your mod folder (i.e. <tt>cstrike</tt> for Counter-Strike, <tt>dod</tt> for Day of Defeat, et cetera).<br />
<br />
==Remote Server==<br />
To install SourceMod remotely, first extract the <tt>.zip</tt> (Windows) or <tt>.tar.gz</tt> (Linux) package to your local computer (for example, your Desktop). You will see an <tt>addons</tt> folder. <br />
<br />
Using a tool such as [https://encrypted.google.com/#q=FTP FTP], locate your mod folder (i.e. <tt>cstrike</tt> for Counter-Strike:Source, <tt>dod</tt> for Day of Defeat:Source, et cetera). Underneath this folder, you should have an <tt>addons</tt> folder (if not, Metamod:Source is probably not installed). From your local <tt>addons</tt> folder, upload the entire contents to your remote <tt>addons</tt> folder. When done, your remote <tt>addons</tt> folder should have a <tt>sourcemod</tt> folder.<br />
<br />
If you have trouble with these steps, you need to get acquainted with FTP and server management. However, you can also ask your server provider for help. Some providers also have web interfaces for managing your server.<br />
<br />
Alternatively, if you copied the tar.gz to your srcds directory, execute the following from the cstrike sub directory:<br />
tar -xzf ../sourcemod-1.1.0.tar.gz<br />
<br />
=Scripting folder=<br />
The scripting folder addons\sourcemod\scripting contains sourcemod plugins source code and sourcemod plugin compiler. This folder is not needed for running sourcemod. It is used for plugin development and compilation.<br />
<br />
=Checking the Install=<br />
Your folder layout should look like:<br />
*<tt>[mod]</tt> - Your mod's folder<br />
**<tt>addons</tt><br />
***<tt>metamod</tt> - Metamod:Source<br />
***<tt>sourcemod</tt> - SourceMod<br />
<br />
Once SourceMod is uploaded/copied and configured with Metamod:Source, restart your server completely. If it is local, shut it down and restart it. If it is remote, you may need to ask your server provider for help. However, it is often safe to issue a "quit" command via [[rcon]], since most providers will automatically restart your server.<br />
<br />
First, in your [[server console]] (not client console), type:<br />
<pre>meta list</pre><br />
<br />
If the install worked, you will see something like:<br />
<pre>] meta list<br />
Listing 1 plugin:<br />
[01] SourceMod (1.1.0.2489) by AlliedModders LLC</pre><br />
<br />
You should then be able to use the SourceMod root console command, which can be invoked with simply:<br />
<pre>sm</pre><br />
<br />
For example:<br />
<pre>] sm version<br />
SourceMod Version Information:<br />
SourceMod Version: 1.1.0.2489<br />
SourcePawn Engine: SourcePawn 1.1, jit-x86 (build 1.1.0-svn)<br />
SourcePawn API: v1 = 4, v2 = 2<br />
Compiled on: Sep 5 2008 02:02:12<br />
http://www.sourcemod.net/<br />
</pre><br />
<br />
<br />
Lastly, assuming you have already setup your administration user (if not, see [[Adding Admins (SourceMod)|this page]]), you can test the in game menu by joining the server, and in the client console type the following:<br />
<pre>sm_admin</pre><br />
You should see a menu popup with all you options.<br />
<br />
=Troubleshooting=<br />
If the install failed, you will generally see one of four symptoms. <br />
<br />
==Metamod reports NOFILE or FAILED==<br />
If "meta list" replies with something like this:<br />
<pre>] meta list<br />
Listing 1 plugin:<br />
[01] <NOFILE></pre><br />
<br />
Most likely, either the files are not located in the correct place, or the file could not be loaded. For more information, use the following command (except use the correct list number):<br />
<pre>meta info 1</pre><br />
<br />
==Metamod lists no plugins==<br />
If "meta list" replies with something like this:<br />
<pre>] meta list<br />
Listing 0 plugins:</pre><br />
<br />
There are several causes of this error.<br />
<br />
# The most common cause is that sourcemod.vdf can't be located in the addons/metamod folder. Verify that sourcemod.vdf is present in this folder.<br />
# If sourcemod.vdf is present, make sure you are using the correct build of Sourcemod (zip = windows, tar.gz = linux).<br />
<br />
==Metamod says nothing==<br />
If "meta list" has no reply at all, Metamod:Source is not properly installed. [[Installing Metamod:Source|This wiki page]] may provide you with clues on how to solve this problem.<br />
<br />
<br />
[[Category:SourceMod Documentation]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=Optimizing_Plugins_(SourceMod_Scripting)&diff=11834Optimizing Plugins (SourceMod Scripting)2025-09-02T19:11:40Z<p>Luki1412: </p>
<hr />
<div>==Introduction==<br />
This guide contains some general suggestions as to how to improve local performance in your code. However, '''take note'''. Do not use this as a guide to prematurely optimizing your program. You should focus on making your scripts easily readable and maintainable. Premature optimization can make your code more complex, introducing bugs that you otherwise wouldn't have had.<br />
<br />
If you do notice performance problems on your server, and you think they are introduced by your plugin, there are a few steps you can take. The best way to start is to get a profiler. You can use the [[SourceMod Profiler]] to tell you how much time is being spent in script functions.<br />
<br />
However, if you are worried about your code, you can also try to estimate the cost of operations in your program. Anything that happens repeatedly in a small period of time - the contents of a loop, the body of a timer, an <tt>OnGameFrame</tt> hook - are good targets.<br />
<br />
'''DISCLAIMER:''' The units of time in this article are comparative only. We estimate most SourcePawn operations as costing 1-10 cycles, where a cycle is measured in nanoseconds.<br />
<br />
=Estimating Cost=<br />
<br />
The goal of estimating cost is to figure out two things:<br />
* How expensive an operation is, run only once.<br />
* How many times the operation is repeated.<br />
<br />
Let's try this with a simple example loop below. Most syntactic language features have a simple cost. Natives can be trickier.<br />
<br />
<sourcepawn>for (int i = 0; i < strlen(string); i++)<br />
{<br />
if (string[i] == '"')<br />
{<br />
return i;<br />
}<br />
}<br />
</sourcepawn><br />
<br />
First, let's determine how many times this loop will run. If the length of <tt>string</tt> is ''n'', then the loop will run ''n'' times. Next, let's see what each iteration of the loop costs:<br />
* <tt>strlen(string)</tt>: This has to count all of the characters in |string|. Let's say counting a character costs 1 unit of time. Therefore, |strlen(string)| will cost ''n'' units of time.<br />
* <tt>if (string[i] == '"')</tt>: This contains an array load and comparison. Let's say those each cost 1 unit of time, totaling 2.<br />
* <tt>i++</tt>: This increments a local variable. Let's say that costs 1 unit of time.<br />
<br />
Therefore, every iteration of the loop costs <tt>n + 3</tt> units of time.<br />
<br />
That means this loop may cost up to <tt>(n * (n + 3))</tt> units of time. Now, if we know that <tt>n</tt> is always small - say, under 100 - that might not be a problem. But what happens if the string has 10,000 characters? Now, the loop will take over 100,000,000 units of time! If a "unit of time" is even as small as a nanosecond, that loop will take a whole tenth of a second, delaying the server by multiple frames!<br />
<br />
This example is easy to fix. We can identify that <tt>strlen</tt> magnifies the cost of the loop, and rewrite it like this:<br />
<sourcepawn>int length = strlen(string);<br />
for (int i = 0; i < length; i++)<br />
{<br />
if (string[i] == '"')<br />
{<br />
return i;<br />
}<br />
}<br />
</sourcepawn><br />
<br />
Now the cost of this loop is just: <tt>n</tt> times a very, very small amount of time.<br />
<br />
=Avoid Large KeyValues=<br />
KeyValues is an n-ary structure using linked lists. This type of structure is extremely expensive to allocate and traverse. While it might be suitable for tiny pieces of information (that is, under 10KB of data or so), its complexity growth is very poor.<br />
<br />
If you load KeyValues data, you should make an effort to, at the very least, cache its Handle so you don't need to reparse the file every time. Caching its contents on a needed basis would be a bonus as well.<br />
<br />
If you're trying to use a KeyValues file with thousands of entries and updating/loading it on events such as player connections or disconnections, you will find that the structure will grow to an unmanageably slow size. If that's the case, you should consider moving to something like SQLite or MySQL.<br />
<br />
=Consider using "switch" statements instead of "if else" statements where possible=<br />
Consider the following code:<br />
<sourcepawn><br />
int iConVarMode = GetConVarInt(g_hCVMode);<br />
<br />
if (iConVarMode == 0)<br />
{<br />
// do stuff<br />
}<br />
else if (iConVarMode == 1)<br />
{<br />
// do stuff<br />
}<br />
else if (iConVarMode == 2)<br />
{<br />
// do stuff<br />
}<br />
else<br />
{<br />
// do stuff<br />
}<br />
</sourcepawn><br />
Since we are checking the same variable for its value multiple times, it is better to use a switch statement here:<br />
<sourcepawn><br />
int iConVarMode = GetConVarInt(g_hCVMode);<br />
<br />
switch (iConVarMode)<br />
{<br />
case 0:<br />
{<br />
// do stuff<br />
}<br />
case 1:<br />
{<br />
// do stuff<br />
}<br />
case 2:<br />
{<br />
// do stuff<br />
}<br />
default:<br />
{<br />
// do stuff<br />
}<br />
}<br />
</sourcepawn><br />
[[Category:SourceMod Scripting]]</div>Luki1412https://wiki.alliedmods.net/index.php?title=SourceMod_Profiler&diff=11833SourceMod Profiler2025-09-02T18:42:45Z<p>Luki1412: </p>
<hr />
<div>SourceMod has built-in profiling support for plugins with integration into the game's "vprof" system.<br />
<br />
See the "sm prof" command for more details.<br />
<br />
Run the command "vprof_generate_report" after you start profiling, to generate a report txt file in the game folder server_root_folder\<game>\vprof<br />
<br />
[[Category:SourceMod Development]]<br />
[[Category:SourceMod Scripting]]</div>Luki1412