AlliedModders Wiki - User contributions [en]

SDKTools (SourceMod Scripting)

2021-10-28T16:33:02Z

Peace-Maker: Add CRC32 section specialization

The SDKTools extension is an extension for various functions provided by the Source SDK. Additionally, it has the ability to dynamically call many C++ functions in the SDK, for example, from CBaseEntity or any derived class.

SDKTools contains simplified versions of SDK functions pre-written for ease of use. These can be found in the additional include files:
*<tt>sdktools_functions.inc</tt> - Popular functions from the SDK.
*<tt>sdktools_sound.inc</tt> - [[#Sound Functions|Sound-related functions]].
*<tt>sdktools_tempents.inc</tt> - [[#TempEnt Functions|TempEnt-related functions]].
*<tt>sdktools_tempents_stocks.inc</tt> - [[TempEnts (SourceMod SDKTools)|TempEnt Stocks for convenience]].

SDKTools is powered by "BinTools," a powerful extension for creating dynamic C/C++ calls. BinTools is automatically loaded by SDKTools.

=GameConfigs=
GameConfig files go into the "gamedata" folder under "sourcemod." In older revisions it was under "sourcemod/configs" which is now deprecated.

==Virtual Offsets==
For adding virtual offsets, add sub-sections to the "Offsets" section of your game config file. For example:

<pre>
"Games"
{
"cstrike"
{
"Offsets"
{
"GiveNamedItem"
{
"windows" "329"
"linux" "330"
}
"EyePosition"
{
"windows" "117"
"linux" "118"
}

// Get offset of CPlayerResource::m_iBotDifficulty sendprop.
// Dynamic way for FindSendPropInfo(class, prop);
"BotDifficulty"
{
"class" "CPlayerResource"
"prop" "m_iBotDifficulty"
}
}
}
}</pre>

==Signature Scans==
For automated signature scans, add sub-sections to the "Signatures" section of your game config file. These are the properties for a signature:
*<tt>library</tt>: The library to search for the pattern or symbol for: "server", "engine" or "matchmaking_ds" (defaults to "server").
*<tt>windows</tt>, <tt>linux</tt> or <tt>mac</tt>: A pattern or symbol for that platform:

You can put a pattern to search for in memory or a symbol name to lookup:
*A signature written in binary; for example, "\x56" instead of "0x56" -- the '*' (\x2A) character is a single byte wildcard.
*A named symbol. To use a named symbol, start the string with the '@' character. If a signature begins with '@', write the character in hexadecimal as above.

Example:
<pre>
"Games"
{
"cstrike"
{
"Signatures"
{
"RoundRespawn"
{
"library" "server"
"windows" "\x56\x8B\xF1\x8B\x06\xFF\x90*\x04\x00\x00\x8B\x86*\x0D\x00"
"linux" "@_ZN9CCSPlayer12RoundRespawnEv"
}
}
}
}</pre>

==Raw address lookups==
Lets you peek and poke (limitation may apply) the Source Dedicated Server memory space, and get a raw address value in an automated way.

Example:
<pre>
"Games"
{
"left4dead2"
{
"Addresses"
{
"CDirector"
{
"windows"
{
"signature" "DirectorMusicBanks_OnRoundStart"
"read" "8"
}
"linux"
{
"signature" "TheDirector"
}
"read" "0"
// Since SourceMod 1.9
"offset" "4"
}
}
"Signatures"
{
/* Used solely to get the offset for TheDirector */
"DirectorMusicBanks_OnRoundStart"
{
"library" "server"
"windows" "\x83\xEC\x14\x57\x8B\xF9\x8B\x0D\x2A\x2A\x2A\x2A\xE8\x2A\x2A\x2A\x2A\x84\xC0\x0F\x2A\x2A\x2A\x2A\x2A\x53\x55\x6A\x24\xE8"
/* 83 EC 14 57 8B F9 8B 0D ? ? ? ? E8 ? ? ? ? 84 C0 0F ? ? ? ? ? 53 55 6A 24 E8 */
}

/* Find the Director/ZombieManager singleton classes */

"TheDirector"
{
"library" "server"
"linux" "@TheDirector"
}
}
}
}
</pre>

The data in an Address entry is parse from top to bottom as commands. This example would accomplish the same thing as the following pseudo-C++ code:

<pre>
BYTE * GetCDirectorAddress()
{
BYTE * pAddr;

#if WINDOWS

pAddr = FindSignature("DirectorMusicBanks_OnRoundStart");
pAddr = *(pAddr + 8);

#elif LINUX

pAddr = FindSignature("TheDirector");

#endif

pAddr = *(pAddr + 0);
// Since SourceMod 1.9
pAddr = pAddr + 4;

return pAddr;
}</pre>

To invoke this address lookup in your Sourcepawn code, you would simply set up your GameConf handle and run something like the following:

<pre>
stock Address:GetTheDirector()
{
return GameConfGetAddress(g_hMyGameConf, "CDirector");
}</pre>

For more code examples, [https://github.com/confoglteam/l4d2_direct l4d2_direct] relies heavily on Address: functions.

==Custom Key Values==
To read arbitary key value pairs from a gamedata file, add them to the "Keys" section of your game config file.
You can have different values per platform or have a key only be available on selected platforms.

Example:
<pre>
"Games"
{
"cstrike"
{
"Keys"
{
"INTERFACEVERSION_GAMEEVENTSMANAGER2" "GAMEEVENTSMANAGER002"

// Different values per platform (since SourceMod 1.10+)
"MyGreatKey"
{
"windows" "this is wundows speaking"
"linux" "linux best linux"
"mac" "wat"
}

"JustForLinux"
{
"linux" "not relevant for other platforms!"
}

}
}
}</pre>

You can access the keys using
<pre>
char buffer[512];
GameConfGetKeyValue(g_hMyGameConf, "MyGreatKey", buffer, sizeof(buffer));
</pre>

==Inheritance==
If you wish for multiple mods to inherit from one block, you can add a special "#supported" section as the first section under a "#default" section. For example:

<pre>
"Games"
{
"#default"
{
"#supported"
{
"game" "dod"
"engine" "sdk2013"
}

"Signatures"
{
// ...
}
}
}</pre>

This specifies that the given block will be read for Day of Defeat as well as any game on the Source 2013 engine branch. You can add multiple "game" or "engine" keys under the "#supported" section to list all mods or engines this section should apply to.

==Specializing per game version based on CRC32 value==
If a game has multiple stable versions, you can select to apply a gamedata section to a specific game version. You can add a special "CRC" section as the first section under a "#default" section, which allows you to list the hex-encoded CRC32 values of the game's server binary that the section should apply to.

<pre>
"Games"
{
"#default"
{
"CRC"
{
"server"
{
"linux" "186F31F8"
"windows" "D41B675F"
}
}

"Signatures"
{
// ...
}
}
}</pre>

The section would only apply if the game's server binary's CRC32 hash matches the given value for the current platform. At the moment, only the "server" binary is supported. You can add multiple "#default" and "CRC" section combinations to cover different game versions.

=Calling Functions=
Calling functions is complicated and requires strict attention to the C++ API you are trying to use. If you make a mistake, something bad '''will''' happen (and if not, you got lucky!) SDKTools is more complicated than PimpinJuice's "Hacks" extension because it precompiles all of the information needed to convert from Plugin memory to C++ types. This precompilation step ensures better safety and speed, but it lengthens the preparation process.

With that said, let's look at an overview of the call creation process. Before making calls, we must ''prepare'' the call. This will give us a <tt>Handle</tt> which will let us make as many calls as we like.
<ol>
<li>Init - The preparation must be initialized. Here we can specify the calling convention, which is either static, or BaseEntity/BasePlayer-based. BasePlayer should be used when only player entities should be allowed as the <tt>this</tt> pointer.</li>
<li>Destination - The call must have a destination address or virtual index to use. This is normally done via <tt>PrepSDKCall_SetFromConf</tt> which ties into gameconf files.</li>
<li>Return Info - If the call has return information, it must be set via <tt>PrepSDKCall_SetReturnInfo</tt>.</li>
<li>Parameters - Each parameter (if any) must be added with <tt>PrepSDKCall_AddParameter</tt>.</li>
<li>Finalize - The call must be finalized with <tt>EndPrepSDKCall</tt>, which will return a <tt>Handle</tt>. If it doesn't, one or more of the preparation operations failed.</li>
</ol>

For the examples below, consider a plugin called "sdkexamples.sp" which has a gamedata file of "plugin.sdkexamples.txt" containing the definitions in the first section.

==RoundRespawn Example==
CCSPlayer::RoundRespawn is a Counter-Strike Source function which respawns players. It used by CS:S DM. Prototype:
<pre>void CCSPlayer::RoundRespawn()</pre>

SDKCall example:
<sourcepawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hRoundRespawn;

public void OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");
StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Signature, "RoundRespawn");
hRoundRespawn = EndPrepSDKCall();
}

void RespawnPlayer(int client)
{
SDKCall(hRoundRespawn, client);
}</sourcepawn>

Note that we did not have to set any extra information for parameters or return info, since CCSPlayer::RoundRespawn has no parameters and has a void return.

==GiveNamedItem Example==
GiveNamedItem will give a player a named item. Prototype:
<pre>virtual CBaseEntity *CBasePlayer::GiveNamedItem(const char *item, int iSubType = 0);</pre>

<sourcepawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hGiveNamedItem;

public OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");

StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "GiveNamedItem");
PrepSDKCall_SetReturnInfo(SDKType_CBaseEntity, SDKPass_Pointer);
PrepSDKCall_AddParameter(SDKType_String, SDKPass_Pointer);
PrepSDKCall_AddParameter(SDKType_PlainOldData, SDKPass_Plain);
hGiveNamedItem = EndPrepSDKCall();
}

any GiveItem(int client, const char[] item)
{
return SDKCall(hGiveNamedItem, client, item, 0);
}</sourcepawn>

==GetEyePosition Example==
Prototype:
<pre>virtual Vector CBaseEntity::EyePosition();</pre>

<sourcepawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hGetEyePosition;

public void OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");

StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "EyePosition");
PrepSDKCall_SetReturnInfo(SDKType_Vector, SDKPass_ByValue);
hGetEyePosition= EndPrepSDKCall();
}

any GetEyePosition(int client, float pos[3])
{
SDKCall(hGetEyePosition, client, pos);
}</sourcepawn>

Note that the vector is returned as the third parameter (first parameter after the <tt>this</tt> pointer).

=TempEnt Functions=
TempEnts, also called "temporary entities," "tempentities," or "TEs," are quick graphical displays that are too simple to justify the overhead of a <tt>CBaseEntity</tt> instantiation or full server-side networkability. In the SDK, they are statically defined instances that can be "played back" to the client by simply sending a copy of its network class properties.

Temporary Entities are mod-dependent, in that a mod can change any of their properties or even the <tt>ITempEnts</tt> class definition. Because of this, SourceMod takes a very flexible approach:
*First, a temp entity is ''started'' by name using <tt>TE_Start</tt>. A list of all tempent names and their network classes can be dumped with <tt>sm_print_telist</tt> (SDKTools must be loaded).
*Second, all of the tempent's properties are set via the <tt>TE_Write</tt> natives. All tempent properties can be dumped to a file using <tt>sm_dump_teprops</tt>.
*Third, the properties are transmitted using <tt>TE_Send</tt>, <tt>TE_SendToAll</tt>, or <tt>TE_SendToClient</tt>.

As a convenience, SourceMod provides a number of pre-written stocks for SDK-defined temporary entities. While the <tt>TE_*</tt> natives are guaranteed to work on any fully-supported SourceMod mod, the <tt>TE_Setup*</tt> stocks are not, as a mod might change the property layouts or the functionalities of the SDK-defined tempents.

Some examples are below. For pictures, see [[TempEnts (SourceMod SDKTools)]].

Using stocks:
<sourcepawn>void SparkClient(int client, const float pos[3], const float dir[3])
{
TE_SetupMetalSparks(pos, dir);
TE_SendToClient(client);
}</sourcepawn>

Not using stocks:
<sourcepawn>void SparkClient(int client, const float pos[3], const float dir[3])
{
TE_Start("Metal Sparks");
TE_WriteVector("m_vecPos", pos);
TE_WriteVector("m_vecDir", dir);
TE_SendToClient(client);
}</sourcepawn>

=Sound Functions=
SDKTools exposes various sound-related members of IVEngineServer and IEngineSound. The basic functions are in <tt>sdktools_sound.inc</tt>:
*<tt>EmitAmbientSound</tt>: Plays an ambient sound from an origin.
*<tt>EmitSound, EmitSoundToClient, EmitSoundToAll</tt>: Plays a sound to a list of clients from a specific entity.

There are a few important properties about sounds:
*Entity: The entity the sound should come from. When playing a generic sound file to player(s), you should use <tt>SOUND_FROM_PLAYER</tt>, which is a special SourceMod macro for making the sound come from the player target. For ambient sounds you'd use <tt>SOUND_FROM_WORLD</tt>, and for sounds from an entity you'd use the entity index.
*Channel: Exposed as <tt>SNDCHAN_*</tt>, normally you only need to use <tt>SNDCHAN_AUTO</tt>. The channel affects how the sound is spatialized[?]
*Level: The decibel level. There are a number of predefined levels as <tt>SNDLEVEL_*</tt> -- the standard one is <tt>SNDLEVEL_NORMAL</tt>. Half-Life 1 used attenuation values instead; you can convert from these using <tt>ATTN_TO_SNDLEVEL()</tt>.
*Volume: The volume, on a scale of 0.0 to 1.0. To use a volume other than the default, the <tt>SND_CHANGEVOL</tt> flag should be included in the "flags" parameter. The default volume is <tt>SNDVOL_NORMAL</tt>.
*Pitch: The pitch; predefined values are <tt>SNDPITCH_*</tt> with <tt>SNDPITCH_NORMAL</tt> being the default. <tt>SND_CHANGEPITCH</tt> should be passed to use a non-default pitch.
*Origin: If specified, an origin to play the sound from.

Some very simple examples:
<sourcepawn>
EmitSoundToClient(client, "bot/affirmative.wav");
EmitSoundToAll("radio/terwin.wav");
</sourcepawn>

=Supported Mods=
SDKTools must have specific support added for each mod. So far, default support exists for the following modifications:
*Counter-Strike: Source
*Day of Defeat: Source
*Dystopia
*Half-Life 2: Deathmatch
*Insurgency (only some of the CBasePlayer SDK functions are available)
*Pirates, Vikings, and Knights II
*The Ship
*SourceForts

=See Also=
*[[Vfunc_offsets_%28SourceMM%29|Virtual Functions]]
*[[TempEnts (SourceMod SDKTools)|TempEnts]]
*[[Useful_Signatures_%28Source%29|Useful Signatures]]
*[[Signature_Scanning|Signature Scanning]]

[[Category:SourceMod Scripting]]

SDKTools (SourceMod Scripting)

2021-10-28T16:20:22Z

Peace-Maker: /* Inheritance */

The SDKTools extension is an extension for various functions provided by the Source SDK. Additionally, it has the ability to dynamically call many C++ functions in the SDK, for example, from CBaseEntity or any derived class.

SDKTools contains simplified versions of SDK functions pre-written for ease of use. These can be found in the additional include files:
*<tt>sdktools_functions.inc</tt> - Popular functions from the SDK.
*<tt>sdktools_sound.inc</tt> - [[#Sound Functions|Sound-related functions]].
*<tt>sdktools_tempents.inc</tt> - [[#TempEnt Functions|TempEnt-related functions]].
*<tt>sdktools_tempents_stocks.inc</tt> - [[TempEnts (SourceMod SDKTools)|TempEnt Stocks for convenience]].

SDKTools is powered by "BinTools," a powerful extension for creating dynamic C/C++ calls. BinTools is automatically loaded by SDKTools.

=GameConfigs=
GameConfig files go into the "gamedata" folder under "sourcemod." In older revisions it was under "sourcemod/configs" which is now deprecated.

==Virtual Offsets==
For adding virtual offsets, add sub-sections to the "Offsets" section of your game config file. For example:

<pre>
"Games"
{
"cstrike"
{
"Offsets"
{
"GiveNamedItem"
{
"windows" "329"
"linux" "330"
}
"EyePosition"
{
"windows" "117"
"linux" "118"
}

// Get offset of CPlayerResource::m_iBotDifficulty sendprop.
// Dynamic way for FindSendPropInfo(class, prop);
"BotDifficulty"
{
"class" "CPlayerResource"
"prop" "m_iBotDifficulty"
}
}
}
}</pre>

==Signature Scans==
For automated signature scans, add sub-sections to the "Signatures" section of your game config file. These are the properties for a signature:
*<tt>library</tt>: The library to search for the pattern or symbol for: "server", "engine" or "matchmaking_ds" (defaults to "server").
*<tt>windows</tt>, <tt>linux</tt> or <tt>mac</tt>: A pattern or symbol for that platform:

You can put a pattern to search for in memory or a symbol name to lookup:
*A signature written in binary; for example, "\x56" instead of "0x56" -- the '*' (\x2A) character is a single byte wildcard.
*A named symbol. To use a named symbol, start the string with the '@' character. If a signature begins with '@', write the character in hexadecimal as above.

Example:
<pre>
"Games"
{
"cstrike"
{
"Signatures"
{
"RoundRespawn"
{
"library" "server"
"windows" "\x56\x8B\xF1\x8B\x06\xFF\x90*\x04\x00\x00\x8B\x86*\x0D\x00"
"linux" "@_ZN9CCSPlayer12RoundRespawnEv"
}
}
}
}</pre>

==Raw address lookups==
Lets you peek and poke (limitation may apply) the Source Dedicated Server memory space, and get a raw address value in an automated way.

Example:
<pre>
"Games"
{
"left4dead2"
{
"Addresses"
{
"CDirector"
{
"windows"
{
"signature" "DirectorMusicBanks_OnRoundStart"
"read" "8"
}
"linux"
{
"signature" "TheDirector"
}
"read" "0"
// Since SourceMod 1.9
"offset" "4"
}
}
"Signatures"
{
/* Used solely to get the offset for TheDirector */
"DirectorMusicBanks_OnRoundStart"
{
"library" "server"
"windows" "\x83\xEC\x14\x57\x8B\xF9\x8B\x0D\x2A\x2A\x2A\x2A\xE8\x2A\x2A\x2A\x2A\x84\xC0\x0F\x2A\x2A\x2A\x2A\x2A\x53\x55\x6A\x24\xE8"
/* 83 EC 14 57 8B F9 8B 0D ? ? ? ? E8 ? ? ? ? 84 C0 0F ? ? ? ? ? 53 55 6A 24 E8 */
}

/* Find the Director/ZombieManager singleton classes */

"TheDirector"
{
"library" "server"
"linux" "@TheDirector"
}
}
}
}
</pre>

The data in an Address entry is parse from top to bottom as commands. This example would accomplish the same thing as the following pseudo-C++ code:

<pre>
BYTE * GetCDirectorAddress()
{
BYTE * pAddr;

#if WINDOWS

pAddr = FindSignature("DirectorMusicBanks_OnRoundStart");
pAddr = *(pAddr + 8);

#elif LINUX

pAddr = FindSignature("TheDirector");

#endif

pAddr = *(pAddr + 0);
// Since SourceMod 1.9
pAddr = pAddr + 4;

return pAddr;
}</pre>

To invoke this address lookup in your Sourcepawn code, you would simply set up your GameConf handle and run something like the following:

<pre>
stock Address:GetTheDirector()
{
return GameConfGetAddress(g_hMyGameConf, "CDirector");
}</pre>

For more code examples, [https://github.com/confoglteam/l4d2_direct l4d2_direct] relies heavily on Address: functions.

==Custom Key Values==
To read arbitary key value pairs from a gamedata file, add them to the "Keys" section of your game config file.
You can have different values per platform or have a key only be available on selected platforms.

Example:
<pre>
"Games"
{
"cstrike"
{
"Keys"
{
"INTERFACEVERSION_GAMEEVENTSMANAGER2" "GAMEEVENTSMANAGER002"

// Different values per platform (since SourceMod 1.10+)
"MyGreatKey"
{
"windows" "this is wundows speaking"
"linux" "linux best linux"
"mac" "wat"
}

"JustForLinux"
{
"linux" "not relevant for other platforms!"
}

}
}
}</pre>

You can access the keys using
<pre>
char buffer[512];
GameConfGetKeyValue(g_hMyGameConf, "MyGreatKey", buffer, sizeof(buffer));
</pre>

==Inheritance==
If you wish for multiple mods to inherit from one block, you can add a special "#supported" section as the first section under a "#default" section. For example:

<pre>
"Games"
{
"#default"
{
"#supported"
{
"game" "dod"
"engine" "sdk2013"
}

"Signatures"
{
"RoundRespawn"
{
// ...
}
}
}
}</pre>

This specifies that the given block will be read for Day of Defeat as well as any game on the Source 2013 engine branch. You can add multiple "game" or "engine" keys under the "#supported" section to list all mods or engines this section should apply to.

=Calling Functions=
Calling functions is complicated and requires strict attention to the C++ API you are trying to use. If you make a mistake, something bad '''will''' happen (and if not, you got lucky!) SDKTools is more complicated than PimpinJuice's "Hacks" extension because it precompiles all of the information needed to convert from Plugin memory to C++ types. This precompilation step ensures better safety and speed, but it lengthens the preparation process.

With that said, let's look at an overview of the call creation process. Before making calls, we must ''prepare'' the call. This will give us a <tt>Handle</tt> which will let us make as many calls as we like.
<ol>
<li>Init - The preparation must be initialized. Here we can specify the calling convention, which is either static, or BaseEntity/BasePlayer-based. BasePlayer should be used when only player entities should be allowed as the <tt>this</tt> pointer.</li>
<li>Destination - The call must have a destination address or virtual index to use. This is normally done via <tt>PrepSDKCall_SetFromConf</tt> which ties into gameconf files.</li>
<li>Return Info - If the call has return information, it must be set via <tt>PrepSDKCall_SetReturnInfo</tt>.</li>
<li>Parameters - Each parameter (if any) must be added with <tt>PrepSDKCall_AddParameter</tt>.</li>
<li>Finalize - The call must be finalized with <tt>EndPrepSDKCall</tt>, which will return a <tt>Handle</tt>. If it doesn't, one or more of the preparation operations failed.</li>
</ol>

For the examples below, consider a plugin called "sdkexamples.sp" which has a gamedata file of "plugin.sdkexamples.txt" containing the definitions in the first section.

==RoundRespawn Example==
CCSPlayer::RoundRespawn is a Counter-Strike Source function which respawns players. It used by CS:S DM. Prototype:
<pre>void CCSPlayer::RoundRespawn()</pre>

SDKCall example:
<sourcepawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hRoundRespawn;

public void OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");
StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Signature, "RoundRespawn");
hRoundRespawn = EndPrepSDKCall();
}

void RespawnPlayer(int client)
{
SDKCall(hRoundRespawn, client);
}</sourcepawn>

Note that we did not have to set any extra information for parameters or return info, since CCSPlayer::RoundRespawn has no parameters and has a void return.

==GiveNamedItem Example==
GiveNamedItem will give a player a named item. Prototype:
<pre>virtual CBaseEntity *CBasePlayer::GiveNamedItem(const char *item, int iSubType = 0);</pre>

<sourcepawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hGiveNamedItem;

public OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");

StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "GiveNamedItem");
PrepSDKCall_SetReturnInfo(SDKType_CBaseEntity, SDKPass_Pointer);
PrepSDKCall_AddParameter(SDKType_String, SDKPass_Pointer);
PrepSDKCall_AddParameter(SDKType_PlainOldData, SDKPass_Plain);
hGiveNamedItem = EndPrepSDKCall();
}

any GiveItem(int client, const char[] item)
{
return SDKCall(hGiveNamedItem, client, item, 0);
}</sourcepawn>

==GetEyePosition Example==
Prototype:
<pre>virtual Vector CBaseEntity::EyePosition();</pre>

<sourcepawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hGetEyePosition;

public void OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");

StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "EyePosition");
PrepSDKCall_SetReturnInfo(SDKType_Vector, SDKPass_ByValue);
hGetEyePosition= EndPrepSDKCall();
}

any GetEyePosition(int client, float pos[3])
{
SDKCall(hGetEyePosition, client, pos);
}</sourcepawn>

Note that the vector is returned as the third parameter (first parameter after the <tt>this</tt> pointer).

=TempEnt Functions=
TempEnts, also called "temporary entities," "tempentities," or "TEs," are quick graphical displays that are too simple to justify the overhead of a <tt>CBaseEntity</tt> instantiation or full server-side networkability. In the SDK, they are statically defined instances that can be "played back" to the client by simply sending a copy of its network class properties.

Temporary Entities are mod-dependent, in that a mod can change any of their properties or even the <tt>ITempEnts</tt> class definition. Because of this, SourceMod takes a very flexible approach:
*First, a temp entity is ''started'' by name using <tt>TE_Start</tt>. A list of all tempent names and their network classes can be dumped with <tt>sm_print_telist</tt> (SDKTools must be loaded).
*Second, all of the tempent's properties are set via the <tt>TE_Write</tt> natives. All tempent properties can be dumped to a file using <tt>sm_dump_teprops</tt>.
*Third, the properties are transmitted using <tt>TE_Send</tt>, <tt>TE_SendToAll</tt>, or <tt>TE_SendToClient</tt>.

As a convenience, SourceMod provides a number of pre-written stocks for SDK-defined temporary entities. While the <tt>TE_*</tt> natives are guaranteed to work on any fully-supported SourceMod mod, the <tt>TE_Setup*</tt> stocks are not, as a mod might change the property layouts or the functionalities of the SDK-defined tempents.

Some examples are below. For pictures, see [[TempEnts (SourceMod SDKTools)]].

Using stocks:
<sourcepawn>void SparkClient(int client, const float pos[3], const float dir[3])
{
TE_SetupMetalSparks(pos, dir);
TE_SendToClient(client);
}</sourcepawn>

Not using stocks:
<sourcepawn>void SparkClient(int client, const float pos[3], const float dir[3])
{
TE_Start("Metal Sparks");
TE_WriteVector("m_vecPos", pos);
TE_WriteVector("m_vecDir", dir);
TE_SendToClient(client);
}</sourcepawn>

=Sound Functions=
SDKTools exposes various sound-related members of IVEngineServer and IEngineSound. The basic functions are in <tt>sdktools_sound.inc</tt>:
*<tt>EmitAmbientSound</tt>: Plays an ambient sound from an origin.
*<tt>EmitSound, EmitSoundToClient, EmitSoundToAll</tt>: Plays a sound to a list of clients from a specific entity.

There are a few important properties about sounds:
*Entity: The entity the sound should come from. When playing a generic sound file to player(s), you should use <tt>SOUND_FROM_PLAYER</tt>, which is a special SourceMod macro for making the sound come from the player target. For ambient sounds you'd use <tt>SOUND_FROM_WORLD</tt>, and for sounds from an entity you'd use the entity index.
*Channel: Exposed as <tt>SNDCHAN_*</tt>, normally you only need to use <tt>SNDCHAN_AUTO</tt>. The channel affects how the sound is spatialized[?]
*Level: The decibel level. There are a number of predefined levels as <tt>SNDLEVEL_*</tt> -- the standard one is <tt>SNDLEVEL_NORMAL</tt>. Half-Life 1 used attenuation values instead; you can convert from these using <tt>ATTN_TO_SNDLEVEL()</tt>.
*Volume: The volume, on a scale of 0.0 to 1.0. To use a volume other than the default, the <tt>SND_CHANGEVOL</tt> flag should be included in the "flags" parameter. The default volume is <tt>SNDVOL_NORMAL</tt>.
*Pitch: The pitch; predefined values are <tt>SNDPITCH_*</tt> with <tt>SNDPITCH_NORMAL</tt> being the default. <tt>SND_CHANGEPITCH</tt> should be passed to use a non-default pitch.
*Origin: If specified, an origin to play the sound from.

Some very simple examples:
<sourcepawn>
EmitSoundToClient(client, "bot/affirmative.wav");
EmitSoundToAll("radio/terwin.wav");
</sourcepawn>

=Supported Mods=
SDKTools must have specific support added for each mod. So far, default support exists for the following modifications:
*Counter-Strike: Source
*Day of Defeat: Source
*Dystopia
*Half-Life 2: Deathmatch
*Insurgency (only some of the CBasePlayer SDK functions are available)
*Pirates, Vikings, and Knights II
*The Ship
*SourceForts

=See Also=
*[[Vfunc_offsets_%28SourceMM%29|Virtual Functions]]
*[[TempEnts (SourceMod SDKTools)|TempEnts]]
*[[Useful_Signatures_%28Source%29|Useful Signatures]]
*[[Signature_Scanning|Signature Scanning]]

[[Category:SourceMod Scripting]]

SQL (SourceMod Scripting)

2021-06-06T14:57:27Z

Peace-Maker: Mention Postgres driver

{{Languages|SQL (SourceMod_Scripting)}}
This article is an introduction to using SourceMod's SQL features. It is not an introduction or tutorial about SQL or any specific SQL implementation.

SourceMod's SQL layer is formally called ''DBI'', or the '''D'''ata'''b'''ase '''I'''nterface. The interface is a generic abstraction of common SQL functions. To connect to a specific database implementation (such as MySQL, or sqLite), a SourceMod DBI "driver" must be loaded. Currently, there are drivers for MySQL, PostgreSQL (pgsql), and SQLite.

SourceMod automatically detects and loads drivers on demand (if they exist, of course). All database natives are in <tt>scripting/include/dbi.inc</tt>. The C++ API is in <tt>public/IDBDriver.h</tt>.

=Connecting=
There are two ways to connect to a database. The first is through named configurations. Named configurations are preset configurations listed in <tt>configs/databases.cfg</tt>. SourceMod specifies that if SQL is being used, there should always be one configuration named "default."

An example of such a configuration looks like:
<pre> "default"
{
"host" "localhost"
"database" "sourcemod"
"user" "root"
"pass" ""
//"timeout" "0"
//"port" "0"
}</pre>

Connections based on named configurations can be instantiated with either <tt>SQL_Connect</tt> or <tt>SQL_DefConnect</tt>.

The other option is to use <tt>SQL_ConnectCustom</tt> and manually specify all connection parameters by passing a keyvalue handle containing them.

Example of a typical connection:
<sourcepawn>char error[255];
Database db = SQL_DefConnect(error, sizeof(error));

if (db == null)
{
PrintToServer("Could not connect: %s", error);
}
else
{
delete db;
}</sourcepawn>

=Queries=

==No Results==
The simplest queries are ones which do not return results -- for example, CREATE, DROP, UPDATE, INSERT, and DELETE. For such queries it is recommended to use <tt>SQL_FastQuery()</tt>. The name does not imply that the query will be faster, but rather, it is faster to write code using this function. For example, given that <tt>db</tt> is a valid database Handle:

<sourcepawn>if (!SQL_FastQuery(db, "UPDATE stats SET players = players + 1"))
{
char error[255];
SQL_GetError(db, error, sizeof(error));
PrintToServer("Failed to query (error: %s)", error);
}</sourcepawn>

==Results==
If a query returns a result set and the results must be processed, you must use <tt>SQL_Query()</tt>. Unlike <tt>SQL_FastQuery()</tt>, this function returns a Handle which must be closed.

An example of a query which will produce results is:
<sourcepawn>DBResultSet query = SQL_Query(db, "SELECT userid FROM vb_user WHERE username = 'BAILOPAN'");
if (query == null)
{
char error[255];
SQL_GetError(db, error, sizeof(error));
PrintToServer("Failed to query (error: %s)", error);
}
else
{
/* Process results here! */

/* Free the Handle */
delete query;
}</sourcepawn>

=Prepared Statements=
Prepared statements are another method of querying. The idea behind a prepared statement is that you construct a query "template" once, and re-use it as many times as needed. Prepared statements have the following benefits:
*A good SQL implementation will be able to cache the query better if it is a prepared statement.
*You don't have to rebuild the entire query string every execution.
*You don't have to allocate a new query structure on every execution.
*Input is "always" secure (more on this later).

A prepared statement has "markers" for inputs. For example, let's consider a function that takes in a database Handle and a name, and retrieves some info from a table:
<sourcepawn>int GetSomeInfo(Database db, const char[] name)
{
DBResultSet hQuery;
char query[100];

/* Create enough space to make sure our string is quoted properly */
int buffer_len = strlen(name) * 2 + 1;
char[] new_name = new char[buffer_len];

/* Ask the SQL driver to make sure our string is safely quoted */
db.Escape(name, new_name, buffer_len);

/* Build the query */
Format(query, sizeof(query), "SELECT userid FROM vb_user WHERE username = '%s'", new_name);

/* Execute the query */
if ((hQuery = SQL_Query(query)) == null)
{
return 0;
}

/* Get some info here */

delete hQuery;

/* return info; */
}</sourcepawn>

Observe a version with prepared statements:
<sourcepawn>DBStatement hUserStmt = null;
int GetSomeInfo(Database db, const char[] name)
{
/* Check if we haven't already created the statement */
if (hUserStmt == null)
{
char error[255];
hUserStmt = SQL_PrepareQuery(db, "SELECT userid FROM vb_user WHERE username = ?", error, sizeof(error));
if (hUserStmt == null)
{
return 0;
}
}

SQL_BindParamString(hUserStmt, 0, name, false);
if (!SQL_Execute(hUserStmt))
{
return 0;
}

/* Get some info here */
/* return info; */
}</sourcepawn>

The important differences:
*The input string (<tt>name</tt>) did not need to be backticked (quoted). The SQL engine automatically performs all type safety and insertion checks.
*There was no need for quotation marks around the parameter marker, <tt>?</tt>, even though it accepted a string.
*We only needed to create the statement Handle once; after that it can live for the lifetime of the database connection.

=Processing Results=
Processing results is done in the same manner for both normal queries and prepared statements. The important functions are:
*<tt>SQL_GetRowCount()</tt> - Returns the number of rows.
*<tt>SQL_FetchRow()</tt> - Fetches the next row if one is available.
*<tt>SQL_Fetch[Int|String|Float]()</tt> - Fetches data from a field in the current row.

Let's consider a sample table that looks like this:
<sql>CREATE TABLE users (
name VARCHAR(64) NOT NULL PRIMARY KEY,
age INT UNSIGNED NOT NULL
);</sql>

The following example has code that will print out all users matching a certain age. There is an example for both prepared statements and normal queries.
<sourcepawn>void PrintResults(Handle query)
{
/* Even if we have just one row, you must call SQL_FetchRow() first */
char name[MAX_NAME_LENGTH];
while (SQL_FetchRow(query))
{
SQL_FetchString(query, 0, name, sizeof(name));
PrintToServer("Name \"%s\" was found.", name);
}
}

bool GetByAge_Query(Database db, int age)
{
char query[100];
Format(query, sizeof(query), "SELECT name FROM users WHERE age = %d", age);

DBResultSet hQuery = SQL_Query(db, query);
if (hQuery == null)
{
return false;
}

PrintResults(hQuery);

delete hQuery;

return true;
}

DBStatement hAgeStmt = null;
bool GetByAge_Statement(Database db, int age)
{
if (hAgeSmt == null)
{
char error[255];
if ((hAgeStmt = SQL_PrepareQuery(db,
"SELECT name FROM users WHERE age = ?",
error,
sizeof(error))) == null)
{
return false;
}
}

SQL_BindParamInt(hAgeStmt, 0, age);
if (!SQL_Execute(hAgeStmt))
{
return false;
}

PrintResults(hAgeStmt);

return true;
}</sourcepawn>

Note that these examples did not close the statement Handles. These examples assume a global database instance that is only closed when the plugin is unloaded. For plugins which maintain temporary database connections, prepared statement Handles must be freed or else the database connection will never be closed.

=Threading=
SourceMod supports threaded SQL querying. That is, SQL operations can be completed in a separate thread from main gameplay. If your database server is remote or requires a network connection, queries can cause noticeable gameplay lag, and supporting threading is often a good idea if your queries occur in the middle of gameplay.

Threaded queries are ''asynchronous''. That is, they are dispatched and you can only find the results through a callback. Although the callback is guaranteed to fire eventually, it may not fire in any specific given timeframe. Certain drivers may not support threading; if this is the case, an RTE will be thrown. If the threader cannot start or the threader is currently disabled, SourceMod will transparently execute the query in the main thread as a fallback.

==Operations==
All threaded operations (except connecting) use the same callback for result notification: <tt>SQLQueryCallback</tt>. The parameters are:
*<tt>db</tt> - The cloned database handle. If the db handle was not found or was invalidated, <tt>null</tt> is passed.
*<tt>results</tt> - Result object, or null on failure.
*<tt>error</tt> - An error string.
*<tt>data</tt> - Custom data that can be passed via some SQL operations.

The following operations can be done via threads:
*Connection, via <tt>SQL_TConnect</tt>.
*Querying, via <tt>SQL_TQuery()</tt>.
*''Note: prepared statements are not yet available for the threader.''

It is always safe to chain one operation from another.

===Connecting===
It is not necessary to make a threaded connection in order to make threaded queries. However, creating a threaded connection will not pause the game server if a connection cannot be immediately established.
Connecting however uses a different callback: <tt>SQLConnectCallback</tt>.

The following parameters are used for the threaded connection callback:
*<tt>db</tt>: Handle to the database connection, or <tt>null</tt> if it could not be found.
*<tt>error</tt>: The error string, if any.
*<tt>data</tt>: Unused (0)

Example:
<sourcepawn>Database hDatabase = null;

void StartSQL()
{
Database.Connect(GotDatabase);
}

public void GotDatabase(Database db, const char[] error, any data)
{
if (db == null)
{
LogError("Database failure: %s", error);
}
else
{
hDatabase = db;
}
}</sourcepawn>

===Querying===
Threaded queries can be performed on any database Handle as long as the driver supports threading. All query results for the first result set are retrieved while in the thread. If your query returns more than one set of results (for example, <tt>CALL</tt> on MySQL with certain functions), the behaviour of the threader is undefined at this time. Note that if you want to perform both threaded and non-threaded queries on the same connection, you MUST read the "Locking" section below.

Query operations use the following callback parameters:
*<tt>owner</tt>: A Handle to the database used to query. The Handle is not the same as the Handle originally passed; however, it will test positively with <tt>SQL_IsSameConnection</tt>. The Handle can be cloned but it cannot be closed (it is closed automatically). It may be <tt>null</tt> in the case of a serious error (for example, the driver being unloaded).
*<tt>hndl</tt>: A Handle to the query. It can be cloned, but not closed (it is closed automatically). It may be <tt>null</tt> if there was an error.
*<tt>error</tt>: Error string, if any.
*<tt>data</tt>: Optional user-defined data passed in through <tt>SQL_TQuery()</tt>.

Example, continuing from above:
<sourcepawn>void CheckSteamID(int userid, const char[] auth)
{
char query[255];
FormatEx(query, sizeof(query), "SELECT userid FROM users WHERE steamid = '%s'", auth);
hdatabase.Query(T_CheckSteamID, query, userid);
}

public void T_CheckSteamID(Database db, DBResultSet results, const char[] error, any data)
{
int client = 0;

/* Make sure the client didn't disconnect while the thread was running */
if ((client = GetClientOfUserId(data)) == 0)
{
return;
}

if (db == null || results == null || error[0] != '\0')
{
LogError("Query failed! %s", error);
KickClient(client, "Authorization failed");
}
else if (results.RowCount == 0)
{
KickClient(client, "You are not a member");
}
}
</sourcepawn>

==Locking==
It is possible to run both threaded and non-threaded queries on the same connection. However, without the proper precautions, you could corrupt the network stream (even if it's local), corrupt memory, or otherwise cause a crash in the SQL driver. To solve this, SourceMod has ''database locking''. Locking is done via <tt>SQL_LockDatabase()</tt> and <tt>SQL_UnlockDatabase</tt>.

Whenever performing any of the following non-threaded operations on a database, it is absolutely necessary to enclose the entire operation with a lock:
*<tt>SQL_Query()</tt> (and <tt>SQL_FetchMoreResults</tt> pairings)
*<tt>SQL_FastQuery</tt>
*<tt>SQL_PrepareQuery</tt>
*<tt>SQL_Bind*</tt> and <tt>SQL_Execute</tt> pairings

The rule of thumb is: if your operation is going to use the database connection, it must be locked until the operation is fully completed.

Example:
<sourcepawn>bool GetByAge_Query(Database db, int age)
{
char query[100];
FormatEx(query, sizeof(query), "SELECT name FROM users WHERE age = %d", age);

SQL_LockDatabase(db);

DBResultSet hQuery = SQL_Query(db, query);
if (hQuery == null)
{
SQL_UnlockDatabase(db);
return false;
}

SQL_UnlockDatabase(db);

PrintResults(hQuery);

delete hQuery;

return true;
}</sourcepawn>

Note that it was only necessary to lock the query; SourceMod pre-fetches the result set, and thus the network queue is clean.

===Warnings===
*Never call <tt>SQL_LockDatabase</tt> right before a threaded operation. You will deadlock the server and have to terminate/kill it.
*Always pair every Lock with an Unlock. Otherwise you risk a deadlock.
*If your query returns multiple result sets, for example, a procedure call on MySQL that returns results, you must lock both the query and the entire fetch operation. SourceMod is only able to fetch one result set at a time, and all result sets must be cleared before a new query is started.

==Priority==
Threaded SQL operations are placed in a simple priority queue. The priority levels are <tt>High</tt>, <tt>Medium</tt>, and <tt>Low</tt>. Connections always have the highest priority.

Changing the priority can be useful if you have many queries with different purposes. For example, a statistics plugin might execute 10 queries on death, and one query on join. Because the statistics might rely on the join info, the join query might need to be high priority, while the death queries can be low priority.

You should never simply assign a high priority to all of your queries simply because you want them to get done fast. Not only does it not work that way, but you may be inserting subtle problems into other plugins by being greedy.

=SQLite=
==Introduction==
[http://www.sqlite.org/ SQLite] is a fast local-file SQL database engine and SourceMod provides a DBI driver for it. SQLite differs from MySQL, and thus MySQL queries may not work in SQLite. The driver type for connections is <tt>sqlite</tt>.

==Usage==
Since SQLite is local only, most of the connection parameters can be ignored. The only connection parameter required is <tt>database</tt>, which specifies the file name of the database. Databases are created on demand if they do not already exist, and are stored in <tt>addons/sourcemod/data/sqlite</tt>. An extension of ".sq3" is automatically appended to the file name.

Additionally, you can specify sub-folders in the database name. For example, "cssdm/players" will become <tt>addons/sourcemod/data/sqlite/cssdm/players.sq3</tt>.

SQLite supports the threading layer, and requires all of the same rules as the MySQL driver (including locks on shared connections).

==External Links==
*[http://www.sqlite.org SQLite Homepage]
*[http://sqlitebrowser.sourceforge.net/ SQLite Browser]

[[Category:SourceMod Scripting]]

{{LanguageSwitch}}

SDKTools (SourceMod Scripting)

2018-02-06T15:42:25Z

Peace-Maker: Add documentation for "offset" key in "Addresses" section.

The SDKTools extension is an extension for various functions provided by the Source SDK. Additionally, it has the ability to dynamically call many C++ functions in the SDK, for example, from CBaseEntity or any derived class.

SDKTools contains simplified versions of SDK functions pre-written for ease of use. These can be found in the additional include files:
*<tt>sdktools_functions.inc</tt> - Popular functions from the SDK.
*<tt>sdktools_sound.inc</tt> - [[#Sound Functions|Sound-related functions]].
*<tt>sdktools_tempents.inc</tt> - [[#TempEnt Functions|TempEnt-related functions]].
*<tt>sdktools_tempents_stocks.inc</tt> - [[TempEnts (SourceMod SDKTools)|TempEnt Stocks for convenience]].

SDKTools is powered by "BinTools," a powerful extension for creating dynamic C/C++ calls. BinTools is automatically loaded by SDKTools.

=GameConfigs=
GameConfig files go into the "gamedata" folder under "sourcemod." In older revisions it was under "sourcemod/configs" which is now deprecated.

==Virtual Offsets==
For adding virtual offsets, add sub-sections to the "Offsets" section of your game config file. For example:

<pre>
"Games"
{
"cstrike"
{
"Offsets"
{
"GiveNamedItem"
{
"windows" "329"
"linux" "330"
}
"EyePosition"
{
"windows" "117"
"linux" "118"
}

// Get offset of CPlayerResource::m_iBotDifficulty sendprop.
// Dynamic way for FindSendPropInfo(class, prop);
"BotDifficulty"
{
"class" "CPlayerResource"
"prop" "m_iBotDifficulty"
}
}
}
}</pre>

==Signature Scans==
For automated signature scans, add sub-sections to the "Signatures" section of your game config file. These are the properties for a signature:
*<tt>library</tt>: The library to search for the pattern or symbol for: "server", "engine" or "matchmaking_ds" (defaults to "server").
*<tt>windows</tt>, <tt>linux</tt> or <tt>mac</tt>: A pattern or symbol for that platform:

You can put a pattern to search for in memory or a symbol name to lookup:
*A signature written in binary; for example, "\x56" instead of "0x56" -- the '*' (\x2A) character is a single byte wildcard.
*A named symbol. To use a named symbol, start the string with the '@' character. If a signature begins with '@', write the character in hexadecimal as above.

Example:
<pre>
"Games"
{
"cstrike"
{
"Signatures"
{
"RoundRespawn"
{
"library" "server"
"windows" "\x56\x8B\xF1\x8B\x06\xFF\x90*\x04\x00\x00\x8B\x86*\x0D\x00"
"linux" "@_ZN9CCSPlayer12RoundRespawnEv"
}
}
}
}</pre>

==Raw address lookups==
Lets you peek and poke (limitation may apply) the Source Dedicated Server memory space, and get a raw address value in an automated way.

Example:
<pre>
"Games"
{
"left4dead2"
{
"Addresses"
{
"CDirector"
{
"windows"
{
"signature" "DirectorMusicBanks_OnRoundStart"
"read" "8"
}
"linux"
{
"signature" "TheDirector"
}
"read" "0"
// Since SourceMod 1.9
"offset" "4"
}
}
"Signatures"
{
/* Used solely to get the offset for TheDirector */
"DirectorMusicBanks_OnRoundStart"
{
"library" "server"
"windows" "\x83\xEC\x14\x57\x8B\xF9\x8B\x0D\x2A\x2A\x2A\x2A\xE8\x2A\x2A\x2A\x2A\x84\xC0\x0F\x2A\x2A\x2A\x2A\x2A\x53\x55\x6A\x24\xE8"
/* 83 EC 14 57 8B F9 8B 0D ? ? ? ? E8 ? ? ? ? 84 C0 0F ? ? ? ? ? 53 55 6A 24 E8 */
}

/* Find the Director/ZombieManager singleton classes */

"TheDirector"
{
"library" "server"
"linux" "@TheDirector"
}
}
}
}
</pre>

The data in an Address entry is parse from top to bottom as commands. This example would accomplish the same thing as the following pseudo-C++ code:

<pre>
BYTE * GetCDirectorAddress()
{
BYTE * pAddr;

#if WINDOWS

pAddr = FindSignature("DirectorMusicBanks_OnRoundStart");
pAddr = *(pAddr + 8);

#elif LINUX

pAddr = FindSignature("TheDirector");

#endif

pAddr = *(pAddr + 0);
// Since SourceMod 1.9
pAddr = pAddr + 4;

return pAddr;
}</pre>

To invoke this address lookup in your Sourcepawn code, you would simply set up your GameConf handle and run something like the following:

<pre>
stock Address:GetTheDirector()
{
return GameConfGetAddress(g_hMyGameConf, "CDirector");
}</pre>

For more code examples, [https://github.com/confoglteam/l4d2_direct l4d2_direct] relies heavily on Address: functions.

==Custom Key Values==
To read arbitary key value pairs from a gamedata file, add them to the "Keys" section of your game config file.
You can have different values per platform or have a key only be available on selected platforms.

Example:
<pre>
"Games"
{
"cstrike"
{
"Keys"
{
"INTERFACEVERSION_GAMEEVENTSMANAGER2" "GAMEEVENTSMANAGER002"

// Different values per platform (since SourceMod 1.10+)
"MyGreatKey"
{
"windows" "this is wundows speaking"
"linux" "linux best linux"
"mac" "wat"
}

"JustForLinux"
{
"linux" "not relevant for other platforms!"
}

}
}
}</pre>

You can access the keys using
<pre>
char buffer[512];
GameConfGetKeyValue(g_hMyGameConf, "MyGreatKey", buffer, sizeof(buffer));
</pre>

==Inheritance==
If you wish for multiple mods to inherit from one block, you can add a special "#supported" section under a "#default" section. For example:

<pre>
"Games"
{
"#default"
{
"#supported"
{
"game" "dod"
}
}
}</pre>

This specifies that the given block will be read for Day of Defeat as well.

=Calling Functions=
Calling functions is complicated and requires strict attention to the C++ API you are trying to use. If you make a mistake, something bad '''will''' happen (and if not, you got lucky!) SDKTools is more complicated than PimpinJuice's "Hacks" extension because it precompiles all of the information needed to convert from Plugin memory to C++ types. This precompilation step ensures better safety and speed, but it lengthens the preparation process.

With that said, let's look at an overview of the call creation process. Before making calls, we must ''prepare'' the call. This will give us a <tt>Handle</tt> which will let us make as many calls as we like.
<ol>
<li>Init - The preparation must be initialized. Here we can specify the calling convention, which is either static, or BaseEntity/BasePlayer-based. BasePlayer should be used when only player entities should be allowed as the <tt>this</tt> pointer.</li>
<li>Destination - The call must have a destination address or virtual index to use. This is normally done via <tt>PrepSDKCall_SetFromConf</tt> which ties into gameconf files.</li>
<li>Return Info - If the call has return information, it must be set via <tt>PrepSDKCall_SetReturnInfo</tt>.</li>
<li>Parameters - Each parameter (if any) must be added with <tt>PrepSDKCall_AddParameter</tt>.</li>
<li>Finalize - The call must be finalized with <tt>EndPrepSDKCall</tt>, which will return a <tt>Handle</tt>. If it doesn't, one or more of the preparation operations failed.</li>
</ol>

For the examples below, consider a plugin called "sdkexamples.sp" which has a gamedata file of "plugin.sdkexamples.txt" containing the definitions in the first section.

==RoundRespawn Example==
CCSPlayer::RoundRespawn is a Counter-Strike Source function which respawns players. It used by CS:S DM. Prototype:
<pre>void CCSPlayer::RoundRespawn()</pre>

SDKCall example:
<pawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hRoundRespawn;

public void OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");
StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Signature, "RoundRespawn");
hRoundRespawn = EndPrepSDKCall();
}

void RespawnPlayer(int client)
{
SDKCall(hRoundRespawn, client);
}</pawn>

Note that we did not have to set any extra information for parameters or return info, since CCSPlayer::RoundRespawn has no parameters and has a void return.

==GiveNamedItem Example==
GiveNamedItem will give a player a named item. Prototype:
<pre>virtual CBaseEntity *CBasePlayer::GiveNamedItem(const char *item, int iSubType = 0);</pre>

<pawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hGiveNamedItem;

public OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");

StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "GiveNamedItem");
PrepSDKCall_SetReturnInfo(SDKType_CBaseEntity, SDKPass_Pointer);
PrepSDKCall_AddParameter(SDKType_String, SDKPass_Pointer);
PrepSDKCall_AddParameter(SDKType_PlainOldData, SDKPass_Plain);
hGiveNamedItem = EndPrepSDKCall();
}

any GiveItem(int client, const char[] item)
{
return SDKCall(hGiveNamedItem, client, item, 0);
}</pawn>

==GetEyePosition Example==
Prototype:
<pre>virtual Vector CBaseEntity::EyePosition();</pre>

<pawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hGetEyePosition;

public void OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");

StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "EyePosition");
PrepSDKCall_SetReturnInfo(SDKType_Vector, SDKPass_ByValue);
hGetEyePosition= EndPrepSDKCall();
}

any GetEyePosition(int client, float pos[3])
{
SDKCall(hGetEyePosition, client, pos);
}</pawn>

Note that the vector is returned as the third parameter (first parameter after the <tt>this</tt> pointer).

=TempEnt Functions=
TempEnts, also called "temporary entities," "tempentities," or "TEs," are quick graphical displays that are too simple to justify the overhead of a <tt>CBaseEntity</tt> instantiation or full server-side networkability. In the SDK, they are statically defined instances that can be "played back" to the client by simply sending a copy of its network class properties.

Temporary Entities are mod-dependent, in that a mod can change any of their properties or even the <tt>ITempEnts</tt> class definition. Because of this, SourceMod takes a very flexible approach:
*First, a temp entity is ''started'' by name using <tt>TE_Start</tt>. A list of all tempent names and their network classes can be dumped with <tt>sm_print_telist</tt> (SDKTools must be loaded).
*Second, all of the tempent's properties are set via the <tt>TE_Write</tt> natives. All tempent properties can be dumped to a file using <tt>sm_dump_teprops</tt>.
*Third, the properties are transmitted using <tt>TE_Send</tt>, <tt>TE_SendToAll</tt>, or <tt>TE_SendToClient</tt>.

As a convenience, SourceMod provides a number of pre-written stocks for SDK-defined temporary entities. While the <tt>TE_*</tt> natives are guaranteed to work on any fully-supported SourceMod mod, the <tt>TE_Setup*</tt> stocks are not, as a mod might change the property layouts or the functionalities of the SDK-defined tempents.

Some examples are below. For pictures, see [[TempEnts (SourceMod SDKTools)]].

Using stocks:
<pawn>void SparkClient(int client, const float pos[3], const float dir[3])
{
TE_SetupMetalSparks(pos, dir);
TE_SendToClient(client);
}</pawn>

Not using stocks:
<pawn>void SparkClient(int client, const float pos[3], const float dir[3])
{
TE_Start("Metal Sparks");
TE_WriteVector("m_vecPos", pos);
TE_WriteVector("m_vecDir", dir);
TE_SendToClient(client);
}</pawn>

=Sound Functions=
SDKTools exposes various sound-related members of IVEngineServer and IEngineSound. The basic functions are in <tt>sdktools_sound.inc</tt>:
*<tt>EmitAmbientSound</tt>: Plays an ambient sound from an origin.
*<tt>EmitSound, EmitSoundToClient, EmitSoundToAll</tt>: Plays a sound to a list of clients from a specific entity.

There are a few important properties about sounds:
*Entity: The entity the sound should come from. When playing a generic sound file to player(s), you should use <tt>SOUND_FROM_PLAYER</tt>, which is a special SourceMod macro for making the sound come from the player target. For ambient sounds you'd use <tt>SOUND_FROM_WORLD</tt>, and for sounds from an entity you'd use the entity index.
*Channel: Exposed as <tt>SNDCHAN_*</tt>, normally you only need to use <tt>SNDCHAN_AUTO</tt>. The channel affects how the sound is spatialized[?]
*Level: The decibel level. There are a number of predefined levels as <tt>SNDLEVEL_*</tt> -- the standard one is <tt>SNDLEVEL_NORMAL</tt>. Half-Life 1 used attenuation values instead; you can convert from these using <tt>ATTN_TO_SNDLEVEL()</tt>.
*Volume: The volume, on a scale of 0.0 to 1.0. To use a volume other than the default, the <tt>SND_CHANGEVOL</tt> flag should be included in the "flags" parameter. The default volume is <tt>SNDVOL_NORMAL</tt>.
*Pitch: The pitch; predefined values are <tt>SNDPITCH_*</tt> with <tt>SNDPITCH_NORMAL</tt> being the default. <tt>SND_CHANGEPITCH</tt> should be passed to use a non-default pitch.
*Origin: If specified, an origin to play the sound from.

Some very simple examples:
<pawn>
EmitSoundToClient(client, "bot/affirmative.wav");
EmitSoundToAll("radio/terwin.wav");
</pawn>

=Supported Mods=
SDKTools must have specific support added for each mod. So far, default support exists for the following modifications:
*Counter-Strike: Source
*Day of Defeat: Source
*Dystopia
*Half-Life 2: Deathmatch
*Insurgency (only some of the CBasePlayer SDK functions are available)
*Pirates, Vikings, and Knights II
*The Ship
*SourceForts

=See Also=
*[[Vfunc_offsets_%28SourceMM%29|Virtual Functions]]
*[[TempEnts (SourceMod SDKTools)|TempEnts]]
*[[Useful_Signatures_%28Source%29|Useful Signatures]]

[[Category:SourceMod Scripting]]

SDKTools (SourceMod Scripting)

2018-02-06T15:37:43Z

Peace-Maker: Update "Signatures" section description

The SDKTools extension is an extension for various functions provided by the Source SDK. Additionally, it has the ability to dynamically call many C++ functions in the SDK, for example, from CBaseEntity or any derived class.

SDKTools contains simplified versions of SDK functions pre-written for ease of use. These can be found in the additional include files:
*<tt>sdktools_functions.inc</tt> - Popular functions from the SDK.
*<tt>sdktools_sound.inc</tt> - [[#Sound Functions|Sound-related functions]].
*<tt>sdktools_tempents.inc</tt> - [[#TempEnt Functions|TempEnt-related functions]].
*<tt>sdktools_tempents_stocks.inc</tt> - [[TempEnts (SourceMod SDKTools)|TempEnt Stocks for convenience]].

SDKTools is powered by "BinTools," a powerful extension for creating dynamic C/C++ calls. BinTools is automatically loaded by SDKTools.

=GameConfigs=
GameConfig files go into the "gamedata" folder under "sourcemod." In older revisions it was under "sourcemod/configs" which is now deprecated.

==Virtual Offsets==
For adding virtual offsets, add sub-sections to the "Offsets" section of your game config file. For example:

<pre>
"Games"
{
"cstrike"
{
"Offsets"
{
"GiveNamedItem"
{
"windows" "329"
"linux" "330"
}
"EyePosition"
{
"windows" "117"
"linux" "118"
}

// Get offset of CPlayerResource::m_iBotDifficulty sendprop.
// Dynamic way for FindSendPropInfo(class, prop);
"BotDifficulty"
{
"class" "CPlayerResource"
"prop" "m_iBotDifficulty"
}
}
}
}</pre>

==Signature Scans==
For automated signature scans, add sub-sections to the "Signatures" section of your game config file. These are the properties for a signature:
*<tt>library</tt>: The library to search for the pattern or symbol for: "server", "engine" or "matchmaking_ds" (defaults to "server").
*<tt>windows</tt>, <tt>linux</tt> or <tt>mac</tt>: A pattern or symbol for that platform:

You can put a pattern to search for in memory or a symbol name to lookup:
*A signature written in binary; for example, "\x56" instead of "0x56" -- the '*' (\x2A) character is a single byte wildcard.
*A named symbol. To use a named symbol, start the string with the '@' character. If a signature begins with '@', write the character in hexadecimal as above.

Example:
<pre>
"Games"
{
"cstrike"
{
"Signatures"
{
"RoundRespawn"
{
"library" "server"
"windows" "\x56\x8B\xF1\x8B\x06\xFF\x90*\x04\x00\x00\x8B\x86*\x0D\x00"
"linux" "@_ZN9CCSPlayer12RoundRespawnEv"
}
}
}
}</pre>

==Raw address lookups==
Lets you peek and poke (limitation may apply) the Source Dedicated Server memory space, and get a raw address value in an automated way.

Example:
<pre>
"Games"
{
"left4dead2"
{
"Addresses"
{
"CDirector"
{
"windows"
{
"signature" "DirectorMusicBanks_OnRoundStart"
"read" "8"
}
"linux"
{
"signature" "TheDirector"
}
"read" "0"
}
}
"Signatures"
{
/* Used solely to get the offset for TheDirector */
"DirectorMusicBanks_OnRoundStart"
{
"library" "server"
"windows" "\x83\xEC\x14\x57\x8B\xF9\x8B\x0D\x2A\x2A\x2A\x2A\xE8\x2A\x2A\x2A\x2A\x84\xC0\x0F\x2A\x2A\x2A\x2A\x2A\x53\x55\x6A\x24\xE8"
/* 83 EC 14 57 8B F9 8B 0D ? ? ? ? E8 ? ? ? ? 84 C0 0F ? ? ? ? ? 53 55 6A 24 E8 */
}

/* Find the Director/ZombieManager singleton classes */

"TheDirector"
{
"library" "server"
"linux" "@TheDirector"
}
}
}
}
</pre>

The data in an Address entry is parse from top to bottom as commands. This example would accomplish the same thing as the following pseudo-C++ code:

<pre>
BYTE * GetCDirectorAddress()
{
BYTE * pAddr;

#if WINDOWS

pAddr = FindSignature("DirectorMusicBanks_OnRoundStart");
pAddr = *(pAddr + 8);

#elif LINUX

pAddr = FindSignature("TheDirector");

#endif

pAddr = *(pAddr + 0);

return pAddr;
}</pre>

To invoke this address lookup in your Sourcepawn code, you would simply set up your GameConf handle and run something like the following:

<pre>
stock Address:GetTheDirector()
{
return GameConfGetAddress(g_hMyGameConf, "CDirector");
}</pre>

For more code examples, [https://github.com/confoglteam/l4d2_direct l4d2_direct] relies heavily on Address: functions.

==Custom Key Values==
To read arbitary key value pairs from a gamedata file, add them to the "Keys" section of your game config file.
You can have different values per platform or have a key only be available on selected platforms.

Example:
<pre>
"Games"
{
"cstrike"
{
"Keys"
{
"INTERFACEVERSION_GAMEEVENTSMANAGER2" "GAMEEVENTSMANAGER002"

// Different values per platform (since SourceMod 1.10+)
"MyGreatKey"
{
"windows" "this is wundows speaking"
"linux" "linux best linux"
"mac" "wat"
}

"JustForLinux"
{
"linux" "not relevant for other platforms!"
}

}
}
}</pre>

You can access the keys using
<pre>
char buffer[512];
GameConfGetKeyValue(g_hMyGameConf, "MyGreatKey", buffer, sizeof(buffer));
</pre>

==Inheritance==
If you wish for multiple mods to inherit from one block, you can add a special "#supported" section under a "#default" section. For example:

<pre>
"Games"
{
"#default"
{
"#supported"
{
"game" "dod"
}
}
}</pre>

This specifies that the given block will be read for Day of Defeat as well.

=Calling Functions=
Calling functions is complicated and requires strict attention to the C++ API you are trying to use. If you make a mistake, something bad '''will''' happen (and if not, you got lucky!) SDKTools is more complicated than PimpinJuice's "Hacks" extension because it precompiles all of the information needed to convert from Plugin memory to C++ types. This precompilation step ensures better safety and speed, but it lengthens the preparation process.

With that said, let's look at an overview of the call creation process. Before making calls, we must ''prepare'' the call. This will give us a <tt>Handle</tt> which will let us make as many calls as we like.
<ol>
<li>Init - The preparation must be initialized. Here we can specify the calling convention, which is either static, or BaseEntity/BasePlayer-based. BasePlayer should be used when only player entities should be allowed as the <tt>this</tt> pointer.</li>
<li>Destination - The call must have a destination address or virtual index to use. This is normally done via <tt>PrepSDKCall_SetFromConf</tt> which ties into gameconf files.</li>
<li>Return Info - If the call has return information, it must be set via <tt>PrepSDKCall_SetReturnInfo</tt>.</li>
<li>Parameters - Each parameter (if any) must be added with <tt>PrepSDKCall_AddParameter</tt>.</li>
<li>Finalize - The call must be finalized with <tt>EndPrepSDKCall</tt>, which will return a <tt>Handle</tt>. If it doesn't, one or more of the preparation operations failed.</li>
</ol>

For the examples below, consider a plugin called "sdkexamples.sp" which has a gamedata file of "plugin.sdkexamples.txt" containing the definitions in the first section.

==RoundRespawn Example==
CCSPlayer::RoundRespawn is a Counter-Strike Source function which respawns players. It used by CS:S DM. Prototype:
<pre>void CCSPlayer::RoundRespawn()</pre>

SDKCall example:
<pawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hRoundRespawn;

public void OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");
StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Signature, "RoundRespawn");
hRoundRespawn = EndPrepSDKCall();
}

void RespawnPlayer(int client)
{
SDKCall(hRoundRespawn, client);
}</pawn>

Note that we did not have to set any extra information for parameters or return info, since CCSPlayer::RoundRespawn has no parameters and has a void return.

==GiveNamedItem Example==
GiveNamedItem will give a player a named item. Prototype:
<pre>virtual CBaseEntity *CBasePlayer::GiveNamedItem(const char *item, int iSubType = 0);</pre>

<pawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hGiveNamedItem;

public OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");

StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "GiveNamedItem");
PrepSDKCall_SetReturnInfo(SDKType_CBaseEntity, SDKPass_Pointer);
PrepSDKCall_AddParameter(SDKType_String, SDKPass_Pointer);
PrepSDKCall_AddParameter(SDKType_PlainOldData, SDKPass_Plain);
hGiveNamedItem = EndPrepSDKCall();
}

any GiveItem(int client, const char[] item)
{
return SDKCall(hGiveNamedItem, client, item, 0);
}</pawn>

==GetEyePosition Example==
Prototype:
<pre>virtual Vector CBaseEntity::EyePosition();</pre>

<pawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hGetEyePosition;

public void OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");

StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "EyePosition");
PrepSDKCall_SetReturnInfo(SDKType_Vector, SDKPass_ByValue);
hGetEyePosition= EndPrepSDKCall();
}

any GetEyePosition(int client, float pos[3])
{
SDKCall(hGetEyePosition, client, pos);
}</pawn>

Note that the vector is returned as the third parameter (first parameter after the <tt>this</tt> pointer).

=TempEnt Functions=
TempEnts, also called "temporary entities," "tempentities," or "TEs," are quick graphical displays that are too simple to justify the overhead of a <tt>CBaseEntity</tt> instantiation or full server-side networkability. In the SDK, they are statically defined instances that can be "played back" to the client by simply sending a copy of its network class properties.

Temporary Entities are mod-dependent, in that a mod can change any of their properties or even the <tt>ITempEnts</tt> class definition. Because of this, SourceMod takes a very flexible approach:
*First, a temp entity is ''started'' by name using <tt>TE_Start</tt>. A list of all tempent names and their network classes can be dumped with <tt>sm_print_telist</tt> (SDKTools must be loaded).
*Second, all of the tempent's properties are set via the <tt>TE_Write</tt> natives. All tempent properties can be dumped to a file using <tt>sm_dump_teprops</tt>.
*Third, the properties are transmitted using <tt>TE_Send</tt>, <tt>TE_SendToAll</tt>, or <tt>TE_SendToClient</tt>.

As a convenience, SourceMod provides a number of pre-written stocks for SDK-defined temporary entities. While the <tt>TE_*</tt> natives are guaranteed to work on any fully-supported SourceMod mod, the <tt>TE_Setup*</tt> stocks are not, as a mod might change the property layouts or the functionalities of the SDK-defined tempents.

Some examples are below. For pictures, see [[TempEnts (SourceMod SDKTools)]].

Using stocks:
<pawn>void SparkClient(int client, const float pos[3], const float dir[3])
{
TE_SetupMetalSparks(pos, dir);
TE_SendToClient(client);
}</pawn>

Not using stocks:
<pawn>void SparkClient(int client, const float pos[3], const float dir[3])
{
TE_Start("Metal Sparks");
TE_WriteVector("m_vecPos", pos);
TE_WriteVector("m_vecDir", dir);
TE_SendToClient(client);
}</pawn>

=Sound Functions=
SDKTools exposes various sound-related members of IVEngineServer and IEngineSound. The basic functions are in <tt>sdktools_sound.inc</tt>:
*<tt>EmitAmbientSound</tt>: Plays an ambient sound from an origin.
*<tt>EmitSound, EmitSoundToClient, EmitSoundToAll</tt>: Plays a sound to a list of clients from a specific entity.

There are a few important properties about sounds:
*Entity: The entity the sound should come from. When playing a generic sound file to player(s), you should use <tt>SOUND_FROM_PLAYER</tt>, which is a special SourceMod macro for making the sound come from the player target. For ambient sounds you'd use <tt>SOUND_FROM_WORLD</tt>, and for sounds from an entity you'd use the entity index.
*Channel: Exposed as <tt>SNDCHAN_*</tt>, normally you only need to use <tt>SNDCHAN_AUTO</tt>. The channel affects how the sound is spatialized[?]
*Level: The decibel level. There are a number of predefined levels as <tt>SNDLEVEL_*</tt> -- the standard one is <tt>SNDLEVEL_NORMAL</tt>. Half-Life 1 used attenuation values instead; you can convert from these using <tt>ATTN_TO_SNDLEVEL()</tt>.
*Volume: The volume, on a scale of 0.0 to 1.0. To use a volume other than the default, the <tt>SND_CHANGEVOL</tt> flag should be included in the "flags" parameter. The default volume is <tt>SNDVOL_NORMAL</tt>.
*Pitch: The pitch; predefined values are <tt>SNDPITCH_*</tt> with <tt>SNDPITCH_NORMAL</tt> being the default. <tt>SND_CHANGEPITCH</tt> should be passed to use a non-default pitch.
*Origin: If specified, an origin to play the sound from.

Some very simple examples:
<pawn>
EmitSoundToClient(client, "bot/affirmative.wav");
EmitSoundToAll("radio/terwin.wav");
</pawn>

=Supported Mods=
SDKTools must have specific support added for each mod. So far, default support exists for the following modifications:
*Counter-Strike: Source
*Day of Defeat: Source
*Dystopia
*Half-Life 2: Deathmatch
*Insurgency (only some of the CBasePlayer SDK functions are available)
*Pirates, Vikings, and Knights II
*The Ship
*SourceForts

=See Also=
*[[Vfunc_offsets_%28SourceMM%29|Virtual Functions]]
*[[TempEnts (SourceMod SDKTools)|TempEnts]]
*[[Useful_Signatures_%28Source%29|Useful Signatures]]

[[Category:SourceMod Scripting]]

SDKTools (SourceMod Scripting)

2018-02-06T15:27:22Z

Peace-Maker: Add documentation for sendprop offset lookup in "Offsets"

The SDKTools extension is an extension for various functions provided by the Source SDK. Additionally, it has the ability to dynamically call many C++ functions in the SDK, for example, from CBaseEntity or any derived class.

SDKTools contains simplified versions of SDK functions pre-written for ease of use. These can be found in the additional include files:
*<tt>sdktools_functions.inc</tt> - Popular functions from the SDK.
*<tt>sdktools_sound.inc</tt> - [[#Sound Functions|Sound-related functions]].
*<tt>sdktools_tempents.inc</tt> - [[#TempEnt Functions|TempEnt-related functions]].
*<tt>sdktools_tempents_stocks.inc</tt> - [[TempEnts (SourceMod SDKTools)|TempEnt Stocks for convenience]].

SDKTools is powered by "BinTools," a powerful extension for creating dynamic C/C++ calls. BinTools is automatically loaded by SDKTools.

=GameConfigs=
GameConfig files go into the "gamedata" folder under "sourcemod." In older revisions it was under "sourcemod/configs" which is now deprecated.

==Virtual Offsets==
For adding virtual offsets, add sub-sections to the "Offsets" section of your game config file. For example:

<pre>
"Games"
{
"cstrike"
{
"Offsets"
{
"GiveNamedItem"
{
"windows" "329"
"linux" "330"
}
"EyePosition"
{
"windows" "117"
"linux" "118"
}

// Get offset of CPlayerResource::m_iBotDifficulty sendprop.
// Dynamic way for FindSendPropInfo(class, prop);
"BotDifficulty"
{
"class" "CPlayerResource"
"prop" "m_iBotDifficulty"
}
}
}
}</pre>

==Signature Scans==
For automated signature scans, add sub-sections to the "Signatures" section of your game config file. There are three properties for a signature:
*<tt>library</tt>: Must be "server" right now.
*<tt>windows</tt>: A signature written in binary; for example, "\x56" instead of "0x56" -- the '*' character is a single byte wildcard.
*<tt>linux</tt>: Either a signature as with <tt>windows</tt>, or a named symbol. To use a named symbol, start the string with the '@' character. If a signature begins with '@', write the character in hexadecimal as above.

Example:
<pre>
"Games"
{
"cstrike"
{
"Signatures"
{
"RoundRespawn"
{
"library" "server"
"windows" "\x56\x8B\xF1\x8B\x06\xFF\x90*\x04\x00\x00\x8B\x86*\x0D\x00"
"linux" "@_ZN9CCSPlayer12RoundRespawnEv"
}
}
}
}</pre>

==Raw address lookups==
Lets you peek and poke (limitation may apply) the Source Dedicated Server memory space, and get a raw address value in an automated way.

Example:
<pre>
"Games"
{
"left4dead2"
{
"Addresses"
{
"CDirector"
{
"windows"
{
"signature" "DirectorMusicBanks_OnRoundStart"
"read" "8"
}
"linux"
{
"signature" "TheDirector"
}
"read" "0"
}
}
"Signatures"
{
/* Used solely to get the offset for TheDirector */
"DirectorMusicBanks_OnRoundStart"
{
"library" "server"
"windows" "\x83\xEC\x14\x57\x8B\xF9\x8B\x0D\x2A\x2A\x2A\x2A\xE8\x2A\x2A\x2A\x2A\x84\xC0\x0F\x2A\x2A\x2A\x2A\x2A\x53\x55\x6A\x24\xE8"
/* 83 EC 14 57 8B F9 8B 0D ? ? ? ? E8 ? ? ? ? 84 C0 0F ? ? ? ? ? 53 55 6A 24 E8 */
}

/* Find the Director/ZombieManager singleton classes */

"TheDirector"
{
"library" "server"
"linux" "@TheDirector"
}
}
}
}
</pre>

The data in an Address entry is parse from top to bottom as commands. This example would accomplish the same thing as the following pseudo-C++ code:

<pre>
BYTE * GetCDirectorAddress()
{
BYTE * pAddr;

#if WINDOWS

pAddr = FindSignature("DirectorMusicBanks_OnRoundStart");
pAddr = *(pAddr + 8);

#elif LINUX

pAddr = FindSignature("TheDirector");

#endif

pAddr = *(pAddr + 0);

return pAddr;
}</pre>

To invoke this address lookup in your Sourcepawn code, you would simply set up your GameConf handle and run something like the following:

<pre>
stock Address:GetTheDirector()
{
return GameConfGetAddress(g_hMyGameConf, "CDirector");
}</pre>

For more code examples, [https://github.com/confoglteam/l4d2_direct l4d2_direct] relies heavily on Address: functions.

==Custom Key Values==
To read arbitary key value pairs from a gamedata file, add them to the "Keys" section of your game config file.
You can have different values per platform or have a key only be available on selected platforms.

Example:
<pre>
"Games"
{
"cstrike"
{
"Keys"
{
"INTERFACEVERSION_GAMEEVENTSMANAGER2" "GAMEEVENTSMANAGER002"

// Different values per platform (since SourceMod 1.10+)
"MyGreatKey"
{
"windows" "this is wundows speaking"
"linux" "linux best linux"
"mac" "wat"
}

"JustForLinux"
{
"linux" "not relevant for other platforms!"
}

}
}
}</pre>

You can access the keys using
<pre>
char buffer[512];
GameConfGetKeyValue(g_hMyGameConf, "MyGreatKey", buffer, sizeof(buffer));
</pre>

==Inheritance==
If you wish for multiple mods to inherit from one block, you can add a special "#supported" section under a "#default" section. For example:

<pre>
"Games"
{
"#default"
{
"#supported"
{
"game" "dod"
}
}
}</pre>

This specifies that the given block will be read for Day of Defeat as well.

=Calling Functions=
Calling functions is complicated and requires strict attention to the C++ API you are trying to use. If you make a mistake, something bad '''will''' happen (and if not, you got lucky!) SDKTools is more complicated than PimpinJuice's "Hacks" extension because it precompiles all of the information needed to convert from Plugin memory to C++ types. This precompilation step ensures better safety and speed, but it lengthens the preparation process.

With that said, let's look at an overview of the call creation process. Before making calls, we must ''prepare'' the call. This will give us a <tt>Handle</tt> which will let us make as many calls as we like.
<ol>
<li>Init - The preparation must be initialized. Here we can specify the calling convention, which is either static, or BaseEntity/BasePlayer-based. BasePlayer should be used when only player entities should be allowed as the <tt>this</tt> pointer.</li>
<li>Destination - The call must have a destination address or virtual index to use. This is normally done via <tt>PrepSDKCall_SetFromConf</tt> which ties into gameconf files.</li>
<li>Return Info - If the call has return information, it must be set via <tt>PrepSDKCall_SetReturnInfo</tt>.</li>
<li>Parameters - Each parameter (if any) must be added with <tt>PrepSDKCall_AddParameter</tt>.</li>
<li>Finalize - The call must be finalized with <tt>EndPrepSDKCall</tt>, which will return a <tt>Handle</tt>. If it doesn't, one or more of the preparation operations failed.</li>
</ol>

For the examples below, consider a plugin called "sdkexamples.sp" which has a gamedata file of "plugin.sdkexamples.txt" containing the definitions in the first section.

==RoundRespawn Example==
CCSPlayer::RoundRespawn is a Counter-Strike Source function which respawns players. It used by CS:S DM. Prototype:
<pre>void CCSPlayer::RoundRespawn()</pre>

SDKCall example:
<pawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hRoundRespawn;

public void OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");
StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Signature, "RoundRespawn");
hRoundRespawn = EndPrepSDKCall();
}

void RespawnPlayer(int client)
{
SDKCall(hRoundRespawn, client);
}</pawn>

Note that we did not have to set any extra information for parameters or return info, since CCSPlayer::RoundRespawn has no parameters and has a void return.

==GiveNamedItem Example==
GiveNamedItem will give a player a named item. Prototype:
<pre>virtual CBaseEntity *CBasePlayer::GiveNamedItem(const char *item, int iSubType = 0);</pre>

<pawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hGiveNamedItem;

public OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");

StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "GiveNamedItem");
PrepSDKCall_SetReturnInfo(SDKType_CBaseEntity, SDKPass_Pointer);
PrepSDKCall_AddParameter(SDKType_String, SDKPass_Pointer);
PrepSDKCall_AddParameter(SDKType_PlainOldData, SDKPass_Plain);
hGiveNamedItem = EndPrepSDKCall();
}

any GiveItem(int client, const char[] item)
{
return SDKCall(hGiveNamedItem, client, item, 0);
}</pawn>

==GetEyePosition Example==
Prototype:
<pre>virtual Vector CBaseEntity::EyePosition();</pre>

<pawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hGetEyePosition;

public void OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");

StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "EyePosition");
PrepSDKCall_SetReturnInfo(SDKType_Vector, SDKPass_ByValue);
hGetEyePosition= EndPrepSDKCall();
}

any GetEyePosition(int client, float pos[3])
{
SDKCall(hGetEyePosition, client, pos);
}</pawn>

Note that the vector is returned as the third parameter (first parameter after the <tt>this</tt> pointer).

=TempEnt Functions=
TempEnts, also called "temporary entities," "tempentities," or "TEs," are quick graphical displays that are too simple to justify the overhead of a <tt>CBaseEntity</tt> instantiation or full server-side networkability. In the SDK, they are statically defined instances that can be "played back" to the client by simply sending a copy of its network class properties.

Temporary Entities are mod-dependent, in that a mod can change any of their properties or even the <tt>ITempEnts</tt> class definition. Because of this, SourceMod takes a very flexible approach:
*First, a temp entity is ''started'' by name using <tt>TE_Start</tt>. A list of all tempent names and their network classes can be dumped with <tt>sm_print_telist</tt> (SDKTools must be loaded).
*Second, all of the tempent's properties are set via the <tt>TE_Write</tt> natives. All tempent properties can be dumped to a file using <tt>sm_dump_teprops</tt>.
*Third, the properties are transmitted using <tt>TE_Send</tt>, <tt>TE_SendToAll</tt>, or <tt>TE_SendToClient</tt>.

As a convenience, SourceMod provides a number of pre-written stocks for SDK-defined temporary entities. While the <tt>TE_*</tt> natives are guaranteed to work on any fully-supported SourceMod mod, the <tt>TE_Setup*</tt> stocks are not, as a mod might change the property layouts or the functionalities of the SDK-defined tempents.

Some examples are below. For pictures, see [[TempEnts (SourceMod SDKTools)]].

Using stocks:
<pawn>void SparkClient(int client, const float pos[3], const float dir[3])
{
TE_SetupMetalSparks(pos, dir);
TE_SendToClient(client);
}</pawn>

Not using stocks:
<pawn>void SparkClient(int client, const float pos[3], const float dir[3])
{
TE_Start("Metal Sparks");
TE_WriteVector("m_vecPos", pos);
TE_WriteVector("m_vecDir", dir);
TE_SendToClient(client);
}</pawn>

=Sound Functions=
SDKTools exposes various sound-related members of IVEngineServer and IEngineSound. The basic functions are in <tt>sdktools_sound.inc</tt>:
*<tt>EmitAmbientSound</tt>: Plays an ambient sound from an origin.
*<tt>EmitSound, EmitSoundToClient, EmitSoundToAll</tt>: Plays a sound to a list of clients from a specific entity.

There are a few important properties about sounds:
*Entity: The entity the sound should come from. When playing a generic sound file to player(s), you should use <tt>SOUND_FROM_PLAYER</tt>, which is a special SourceMod macro for making the sound come from the player target. For ambient sounds you'd use <tt>SOUND_FROM_WORLD</tt>, and for sounds from an entity you'd use the entity index.
*Channel: Exposed as <tt>SNDCHAN_*</tt>, normally you only need to use <tt>SNDCHAN_AUTO</tt>. The channel affects how the sound is spatialized[?]
*Level: The decibel level. There are a number of predefined levels as <tt>SNDLEVEL_*</tt> -- the standard one is <tt>SNDLEVEL_NORMAL</tt>. Half-Life 1 used attenuation values instead; you can convert from these using <tt>ATTN_TO_SNDLEVEL()</tt>.
*Volume: The volume, on a scale of 0.0 to 1.0. To use a volume other than the default, the <tt>SND_CHANGEVOL</tt> flag should be included in the "flags" parameter. The default volume is <tt>SNDVOL_NORMAL</tt>.
*Pitch: The pitch; predefined values are <tt>SNDPITCH_*</tt> with <tt>SNDPITCH_NORMAL</tt> being the default. <tt>SND_CHANGEPITCH</tt> should be passed to use a non-default pitch.
*Origin: If specified, an origin to play the sound from.

Some very simple examples:
<pawn>
EmitSoundToClient(client, "bot/affirmative.wav");
EmitSoundToAll("radio/terwin.wav");
</pawn>

=Supported Mods=
SDKTools must have specific support added for each mod. So far, default support exists for the following modifications:
*Counter-Strike: Source
*Day of Defeat: Source
*Dystopia
*Half-Life 2: Deathmatch
*Insurgency (only some of the CBasePlayer SDK functions are available)
*Pirates, Vikings, and Knights II
*The Ship
*SourceForts

=See Also=
*[[Vfunc_offsets_%28SourceMM%29|Virtual Functions]]
*[[TempEnts (SourceMod SDKTools)|TempEnts]]
*[[Useful_Signatures_%28Source%29|Useful Signatures]]

[[Category:SourceMod Scripting]]

SDKTools (SourceMod Scripting)

2018-02-06T15:13:20Z

Peace-Maker: Add gamedata "Keys" section documentation

The SDKTools extension is an extension for various functions provided by the Source SDK. Additionally, it has the ability to dynamically call many C++ functions in the SDK, for example, from CBaseEntity or any derived class.

SDKTools contains simplified versions of SDK functions pre-written for ease of use. These can be found in the additional include files:
*<tt>sdktools_functions.inc</tt> - Popular functions from the SDK.
*<tt>sdktools_sound.inc</tt> - [[#Sound Functions|Sound-related functions]].
*<tt>sdktools_tempents.inc</tt> - [[#TempEnt Functions|TempEnt-related functions]].
*<tt>sdktools_tempents_stocks.inc</tt> - [[TempEnts (SourceMod SDKTools)|TempEnt Stocks for convenience]].

SDKTools is powered by "BinTools," a powerful extension for creating dynamic C/C++ calls. BinTools is automatically loaded by SDKTools.

=GameConfigs=
GameConfig files go into the "gamedata" folder under "sourcemod." In older revisions it was under "sourcemod/configs" which is now deprecated.

==Virtual Offsets==
For adding virtual offsets, add sub-sections to the "Offsets" section of your game config file. For example:

<pre>
"Games"
{
"cstrike"
{
"Offsets"
{
"GiveNamedItem"
{
"windows" "329"
"linux" "330"
}
"EyePosition"
{
"windows" "117"
"linux" "118"
}
}
}
}</pre>

==Signature Scans==
For automated signature scans, add sub-sections to the "Signatures" section of your game config file. There are three properties for a signature:
*<tt>library</tt>: Must be "server" right now.
*<tt>windows</tt>: A signature written in binary; for example, "\x56" instead of "0x56" -- the '*' character is a single byte wildcard.
*<tt>linux</tt>: Either a signature as with <tt>windows</tt>, or a named symbol. To use a named symbol, start the string with the '@' character. If a signature begins with '@', write the character in hexadecimal as above.

Example:
<pre>
"Games"
{
"cstrike"
{
"Signatures"
{
"RoundRespawn"
{
"library" "server"
"windows" "\x56\x8B\xF1\x8B\x06\xFF\x90*\x04\x00\x00\x8B\x86*\x0D\x00"
"linux" "@_ZN9CCSPlayer12RoundRespawnEv"
}
}
}
}</pre>

==Raw address lookups==
Lets you peek and poke (limitation may apply) the Source Dedicated Server memory space, and get a raw address value in an automated way.

Example:
<pre>
"Games"
{
"left4dead2"
{
"Addresses"
{
"CDirector"
{
"windows"
{
"signature" "DirectorMusicBanks_OnRoundStart"
"read" "8"
}
"linux"
{
"signature" "TheDirector"
}
"read" "0"
}
}
"Signatures"
{
/* Used solely to get the offset for TheDirector */
"DirectorMusicBanks_OnRoundStart"
{
"library" "server"
"windows" "\x83\xEC\x14\x57\x8B\xF9\x8B\x0D\x2A\x2A\x2A\x2A\xE8\x2A\x2A\x2A\x2A\x84\xC0\x0F\x2A\x2A\x2A\x2A\x2A\x53\x55\x6A\x24\xE8"
/* 83 EC 14 57 8B F9 8B 0D ? ? ? ? E8 ? ? ? ? 84 C0 0F ? ? ? ? ? 53 55 6A 24 E8 */
}

/* Find the Director/ZombieManager singleton classes */

"TheDirector"
{
"library" "server"
"linux" "@TheDirector"
}
}
}
}
</pre>

The data in an Address entry is parse from top to bottom as commands. This example would accomplish the same thing as the following pseudo-C++ code:

<pre>
BYTE * GetCDirectorAddress()
{
BYTE * pAddr;

#if WINDOWS

pAddr = FindSignature("DirectorMusicBanks_OnRoundStart");
pAddr = *(pAddr + 8);

#elif LINUX

pAddr = FindSignature("TheDirector");

#endif

pAddr = *(pAddr + 0);

return pAddr;
}</pre>

To invoke this address lookup in your Sourcepawn code, you would simply set up your GameConf handle and run something like the following:

<pre>
stock Address:GetTheDirector()
{
return GameConfGetAddress(g_hMyGameConf, "CDirector");
}</pre>

For more code examples, [https://github.com/confoglteam/l4d2_direct l4d2_direct] relies heavily on Address: functions.

==Custom Key Values==
To read arbitary key value pairs from a gamedata file, add them to the "Keys" section of your game config file.
You can have different values per platform or have a key only be available on selected platforms.

Example:
<pre>
"Games"
{
"cstrike"
{
"Keys"
{
"INTERFACEVERSION_GAMEEVENTSMANAGER2" "GAMEEVENTSMANAGER002"

// Different values per platform (since SourceMod 1.10+)
"MyGreatKey"
{
"windows" "this is wundows speaking"
"linux" "linux best linux"
"mac" "wat"
}

"JustForLinux"
{
"linux" "not relevant for other platforms!"
}

}
}
}</pre>

You can access the keys using
<pre>
char buffer[512];
GameConfGetKeyValue(g_hMyGameConf, "MyGreatKey", buffer, sizeof(buffer));
</pre>

==Inheritance==
If you wish for multiple mods to inherit from one block, you can add a special "#supported" section under a "#default" section. For example:

<pre>
"Games"
{
"#default"
{
"#supported"
{
"game" "dod"
}
}
}</pre>

This specifies that the given block will be read for Day of Defeat as well.

=Calling Functions=
Calling functions is complicated and requires strict attention to the C++ API you are trying to use. If you make a mistake, something bad '''will''' happen (and if not, you got lucky!) SDKTools is more complicated than PimpinJuice's "Hacks" extension because it precompiles all of the information needed to convert from Plugin memory to C++ types. This precompilation step ensures better safety and speed, but it lengthens the preparation process.

With that said, let's look at an overview of the call creation process. Before making calls, we must ''prepare'' the call. This will give us a <tt>Handle</tt> which will let us make as many calls as we like.
<ol>
<li>Init - The preparation must be initialized. Here we can specify the calling convention, which is either static, or BaseEntity/BasePlayer-based. BasePlayer should be used when only player entities should be allowed as the <tt>this</tt> pointer.</li>
<li>Destination - The call must have a destination address or virtual index to use. This is normally done via <tt>PrepSDKCall_SetFromConf</tt> which ties into gameconf files.</li>
<li>Return Info - If the call has return information, it must be set via <tt>PrepSDKCall_SetReturnInfo</tt>.</li>
<li>Parameters - Each parameter (if any) must be added with <tt>PrepSDKCall_AddParameter</tt>.</li>
<li>Finalize - The call must be finalized with <tt>EndPrepSDKCall</tt>, which will return a <tt>Handle</tt>. If it doesn't, one or more of the preparation operations failed.</li>
</ol>

For the examples below, consider a plugin called "sdkexamples.sp" which has a gamedata file of "plugin.sdkexamples.txt" containing the definitions in the first section.

==RoundRespawn Example==
CCSPlayer::RoundRespawn is a Counter-Strike Source function which respawns players. It used by CS:S DM. Prototype:
<pre>void CCSPlayer::RoundRespawn()</pre>

SDKCall example:
<pawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hRoundRespawn;

public void OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");
StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Signature, "RoundRespawn");
hRoundRespawn = EndPrepSDKCall();
}

void RespawnPlayer(int client)
{
SDKCall(hRoundRespawn, client);
}</pawn>

Note that we did not have to set any extra information for parameters or return info, since CCSPlayer::RoundRespawn has no parameters and has a void return.

==GiveNamedItem Example==
GiveNamedItem will give a player a named item. Prototype:
<pre>virtual CBaseEntity *CBasePlayer::GiveNamedItem(const char *item, int iSubType = 0);</pre>

<pawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hGiveNamedItem;

public OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");

StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "GiveNamedItem");
PrepSDKCall_SetReturnInfo(SDKType_CBaseEntity, SDKPass_Pointer);
PrepSDKCall_AddParameter(SDKType_String, SDKPass_Pointer);
PrepSDKCall_AddParameter(SDKType_PlainOldData, SDKPass_Plain);
hGiveNamedItem = EndPrepSDKCall();
}

any GiveItem(int client, const char[] item)
{
return SDKCall(hGiveNamedItem, client, item, 0);
}</pawn>

==GetEyePosition Example==
Prototype:
<pre>virtual Vector CBaseEntity::EyePosition();</pre>

<pawn>#include <sourcemod>
#include <sdktools>

Handle hGameConf;
Handle hGetEyePosition;

public void OnPluginStart()
{
hGameConf = LoadGameConfigFile("plugin.sdkexamples");

StartPrepSDKCall(SDKCall_Player);
PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "EyePosition");
PrepSDKCall_SetReturnInfo(SDKType_Vector, SDKPass_ByValue);
hGetEyePosition= EndPrepSDKCall();
}

any GetEyePosition(int client, float pos[3])
{
SDKCall(hGetEyePosition, client, pos);
}</pawn>

Note that the vector is returned as the third parameter (first parameter after the <tt>this</tt> pointer).

=TempEnt Functions=
TempEnts, also called "temporary entities," "tempentities," or "TEs," are quick graphical displays that are too simple to justify the overhead of a <tt>CBaseEntity</tt> instantiation or full server-side networkability. In the SDK, they are statically defined instances that can be "played back" to the client by simply sending a copy of its network class properties.

Temporary Entities are mod-dependent, in that a mod can change any of their properties or even the <tt>ITempEnts</tt> class definition. Because of this, SourceMod takes a very flexible approach:
*First, a temp entity is ''started'' by name using <tt>TE_Start</tt>. A list of all tempent names and their network classes can be dumped with <tt>sm_print_telist</tt> (SDKTools must be loaded).
*Second, all of the tempent's properties are set via the <tt>TE_Write</tt> natives. All tempent properties can be dumped to a file using <tt>sm_dump_teprops</tt>.
*Third, the properties are transmitted using <tt>TE_Send</tt>, <tt>TE_SendToAll</tt>, or <tt>TE_SendToClient</tt>.

As a convenience, SourceMod provides a number of pre-written stocks for SDK-defined temporary entities. While the <tt>TE_*</tt> natives are guaranteed to work on any fully-supported SourceMod mod, the <tt>TE_Setup*</tt> stocks are not, as a mod might change the property layouts or the functionalities of the SDK-defined tempents.

Some examples are below. For pictures, see [[TempEnts (SourceMod SDKTools)]].

Using stocks:
<pawn>void SparkClient(int client, const float pos[3], const float dir[3])
{
TE_SetupMetalSparks(pos, dir);
TE_SendToClient(client);
}</pawn>

Not using stocks:
<pawn>void SparkClient(int client, const float pos[3], const float dir[3])
{
TE_Start("Metal Sparks");
TE_WriteVector("m_vecPos", pos);
TE_WriteVector("m_vecDir", dir);
TE_SendToClient(client);
}</pawn>

=Sound Functions=
SDKTools exposes various sound-related members of IVEngineServer and IEngineSound. The basic functions are in <tt>sdktools_sound.inc</tt>:
*<tt>EmitAmbientSound</tt>: Plays an ambient sound from an origin.
*<tt>EmitSound, EmitSoundToClient, EmitSoundToAll</tt>: Plays a sound to a list of clients from a specific entity.

There are a few important properties about sounds:
*Entity: The entity the sound should come from. When playing a generic sound file to player(s), you should use <tt>SOUND_FROM_PLAYER</tt>, which is a special SourceMod macro for making the sound come from the player target. For ambient sounds you'd use <tt>SOUND_FROM_WORLD</tt>, and for sounds from an entity you'd use the entity index.
*Channel: Exposed as <tt>SNDCHAN_*</tt>, normally you only need to use <tt>SNDCHAN_AUTO</tt>. The channel affects how the sound is spatialized[?]
*Level: The decibel level. There are a number of predefined levels as <tt>SNDLEVEL_*</tt> -- the standard one is <tt>SNDLEVEL_NORMAL</tt>. Half-Life 1 used attenuation values instead; you can convert from these using <tt>ATTN_TO_SNDLEVEL()</tt>.
*Volume: The volume, on a scale of 0.0 to 1.0. To use a volume other than the default, the <tt>SND_CHANGEVOL</tt> flag should be included in the "flags" parameter. The default volume is <tt>SNDVOL_NORMAL</tt>.
*Pitch: The pitch; predefined values are <tt>SNDPITCH_*</tt> with <tt>SNDPITCH_NORMAL</tt> being the default. <tt>SND_CHANGEPITCH</tt> should be passed to use a non-default pitch.
*Origin: If specified, an origin to play the sound from.

Some very simple examples:
<pawn>
EmitSoundToClient(client, "bot/affirmative.wav");
EmitSoundToAll("radio/terwin.wav");
</pawn>

=Supported Mods=
SDKTools must have specific support added for each mod. So far, default support exists for the following modifications:
*Counter-Strike: Source
*Day of Defeat: Source
*Dystopia
*Half-Life 2: Deathmatch
*Insurgency (only some of the CBasePlayer SDK functions are available)
*Pirates, Vikings, and Knights II
*The Ship
*SourceForts

=See Also=
*[[Vfunc_offsets_%28SourceMM%29|Virtual Functions]]
*[[TempEnts (SourceMod SDKTools)|TempEnts]]
*[[Useful_Signatures_%28Source%29|Useful Signatures]]

[[Category:SourceMod Scripting]]

Nuclear Dawn Events

2014-10-04T18:24:37Z

Peace-Maker:

:''Refer back to [[Game Events (Source)]] for more events.''

=== player_death ===
{{qnotice|}} 
{{begin-hl2msg|player_death|string}}
{{hl2msg|short|userid|user ID who died}}
{{hl2msg|short|attacker|user ID who killed}}
{{hl2msg|string|weapon|weapon name killed used}}
{{hl2msg|short|weaponid|weapon id}}
{{hl2msg|long|damagebits|bits}}
{{hl2msg|long|customkill|custom bits}}
{{hl2msg|short|priority|}}
{{end-hl2msg}}
=== player_hurt ===
{{qnotice|}} 
{{begin-hl2msg|player_hurt|string}}
{{hl2msg|1|local|Not networked}}
{{hl2msg|short|userid|user ID who was hurt}}
{{hl2msg|short|attacker|user id who attacked}}
{{hl2msg|short|health|remaining health points}}
{{hl2msg|string|weapon|weapon name attacker used, if not the world}}
{{hl2msg|short|dmg_health|damage done to health}}
{{hl2msg|byte|hitgroup|hitgroup that was damaged}}
{{hl2msg|long|type|damage type}}
{{end-hl2msg}}
=== player_changeclass ===
{{qnotice|Called when a player changes class}} 
{{begin-hl2msg|player_changeclass|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|class|}}
{{hl2msg|short|subclass|}}
{{end-hl2msg}}
=== spec_target_updated ===
{{qnotice|}} 
{{begin-hl2msg|spec_target_updated|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== achievement_earned ===
{{qnotice|}} 
{{begin-hl2msg|achievement_earned|string}}
{{hl2msg|short|player|}}
{{hl2msg|short|achievement|}}
{{end-hl2msg}}
=== player_spawned_at_tgate ===
{{qnotice|}} 
{{begin-hl2msg|player_spawned_at_tgate|string}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}
=== structure_death ===
{{qnotice|fired when we sell a structure}} 
{{begin-hl2msg|structure_death|string}}
{{hl2msg|short|type|type of structure sold}}
{{hl2msg|short|team|the team the structure belonged to}}
{{hl2msg|short|entindex|The entidx of the structure}}
{{hl2msg|short|attacker|userid of attacking player}}
{{hl2msg|string|weapon|weapon name the attacker used}}
{{end-hl2msg}}
=== structure_damage_sparse ===
{{qnotice|is only fired for every 100hp taken. no spamz here}} 
{{begin-hl2msg|structure_damage_sparse|string}}
{{hl2msg|short|entindex|entity index of structure being damaged}}
{{hl2msg|short|ownerteam|team that owns the structure - Todo: optimize this out!}}
{{hl2msg|bool|bunker|was it the bunker?}}
{{hl2msg|local|userid|user id that damaged the structure}}
{{end-hl2msg}}
=== structure_sold ===
{{qnotice|fired when we sell a structure}} 
{{begin-hl2msg|structure_sold|string}}
{{hl2msg|short|type|type of structure sold}}
{{hl2msg|short|ownerteam|the team the structure belonged to}}
{{end-hl2msg}}
=== structure_fully_auto_repaired ===
{{qnotice|fired when a damaged structure gets healed to 100% hp using auto repair}} 
{{begin-hl2msg|structure_fully_auto_repaired|string}}
{{hl2msg|short|type|type of structure repaired}}
{{hl2msg|short|entindex|entity index of repaired structure}}
{{hl2msg|short|ownerteam|team that the structure belongs to}}
{{end-hl2msg}}
=== structure_fully_man_repaired ===
{{qnotice|fired when a damaged structure gets healed to 100% hp by supports}} 
{{begin-hl2msg|structure_fully_man_repaired|string}}
{{hl2msg|short|type|type of structure repaired}}
{{hl2msg|short|entindex|entity index of repaired structure}}
{{hl2msg|short|ownerteam|team that the structure belongs to}}
{{hl2msg|local|userid|user id that repaired the sturcture}}
{{end-hl2msg}}
=== structure_built ===
{{qnotice|structure fully built. fired client-side. commander only. same team.}} 
{{begin-hl2msg|structure_built|string}}
{{hl2msg|short|entindex|structure entity index}}
{{end-hl2msg}}
=== structure_power_outage ===
{{qnotice|structure out of power. fired client-side. commander only. same team.}} 
{{begin-hl2msg|structure_power_outage|string}}
{{hl2msg|short|entindex|structure entity index}}
{{end-hl2msg}}
=== resource_start_capture ===
{{qnotice|Used to show the capture hud panel}} 
{{begin-hl2msg|resource_start_capture|string}}
{{hl2msg|short|userid|user id that is starting the capture}}
{{hl2msg|short|entindex|resource point getting capped}}
{{hl2msg|short|type|type of resource point}}
{{hl2msg|short|capteam|team that is capping}}
{{hl2msg|short|ownerteam|team that currently owns the point (check for unassigned)}}
{{end-hl2msg}}
=== resource_end_capture ===
{{qnotice|Used to hide the capture hud panel}} 
{{begin-hl2msg|resource_end_capture|string}}
{{hl2msg|short|userid|user id that is starting the capture}}
{{hl2msg|short|entindex|resource point that got captured}}
{{end-hl2msg}}
=== resource_break_capture ===
{{qnotice|}} 
{{begin-hl2msg|resource_break_capture|string}}
{{hl2msg|short|entindex|}}
{{hl2msg|float|time_remaining|}}
{{end-hl2msg}}
=== resource_extract ===
{{qnotice|Resource point has extracted some resources}} 
{{begin-hl2msg|resource_extract|string}}
{{hl2msg|short|entindex|resource point that extracted the resources}}
{{hl2msg|short|amount|resource point that extracted the resources}}
{{end-hl2msg}}
=== resource_captured ===
{{qnotice|When a resource point gets fully captured by a team}} 
{{begin-hl2msg|resource_captured|string}}
{{hl2msg|short|entindex|entity index of the captrd point}}
{{hl2msg|short|type|the resource point type that got captured}}
{{hl2msg|short|team|team that captured the point}}
{{end-hl2msg}}
=== power_requested ===
{{qnotice|An entity is requesting a power connection}} 
{{begin-hl2msg|power_requested|string}}
{{hl2msg|short|teamid|The team who's power system got updated}}
{{hl2msg|short|entid|The entity index that is requesting a power connection}}
{{end-hl2msg}}
=== power_removed ===
{{qnotice|An entity is requesting a power connection}} 
{{begin-hl2msg|power_removed|string}}
{{hl2msg|short|teamid|The team who's power system got updated}}
{{hl2msg|short|entid|The entity index that is requesting a power connection}}
{{end-hl2msg}}
=== power_updated ===
{{qnotice|When the power nexus gets updated}} 
{{begin-hl2msg|power_updated|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== enter_pregame ===
{{qnotice|}} 
{{begin-hl2msg|enter_pregame|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== enter_vehicle ===
{{qnotice|}} 
{{begin-hl2msg|enter_vehicle|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|seat|}}
{{hl2msg|short|entidx|}}
{{end-hl2msg}}
=== exit_vehicle ===
{{qnotice|}} 
{{begin-hl2msg|exit_vehicle|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|seat|}}
{{hl2msg|short|entidx|}}
{{end-hl2msg}}
=== show_freezepanel ===
{{qnotice|}} 
{{begin-hl2msg|show_freezepanel|string}}
{{hl2msg|short|killer|entindex of the killer entity}}
{{end-hl2msg}}
=== hide_freezepanel ===
{{qnotice|}} 
{{begin-hl2msg|hide_freezepanel|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== freezecam_started ===
{{qnotice|}} 
{{begin-hl2msg|freezecam_started|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== spawn_map_changed ===
{{qnotice|Called when a tgate is built, removed, or power state changes}} 
{{begin-hl2msg|spawn_map_changed|string}}
{{hl2msg|short|teamid|}}
{{end-hl2msg}}
=== overviewmap_key_released ===
{{qnotice|}} 
{{begin-hl2msg|overviewmap_key_released|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== slot_key_pressed ===
{{qnotice|}} 
{{begin-hl2msg|slot_key_pressed|string}}
{{hl2msg|short|slot|}}
{{end-hl2msg}}
=== ironsight_key_pressed ===
{{qnotice|}} 
{{begin-hl2msg|ironsight_key_pressed|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== ability_key_pressed ===
{{qnotice|}} 
{{begin-hl2msg|ability_key_pressed|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== weapon_reload ===
{{qnotice|}} 
{{begin-hl2msg|weapon_reload|string}}
{{hl2msg|short|userid|}}
{{hl2msg|bool|manual|player manually started the reload}}
{{end-hl2msg}}
=== weapon_fire_at_40 ===
{{qnotice|}} 
{{begin-hl2msg|weapon_fire_at_40|string}}
{{hl2msg|short|userid|}}
{{hl2msg|string|weapon|used weapon name}}
{{hl2msg|short|weaponid|used weapon ID}}
{{hl2msg|short|count|number of bullets}}
{{end-hl2msg}}
=== entity_visible ===
{{qnotice|}} 
{{begin-hl2msg|entity_visible|string}}
{{hl2msg|short|userid|The player who sees the entity}}
{{hl2msg|long|subject|Entindex of the entity they see}}
{{hl2msg|string|classname|Classname of the entity they see}}
{{hl2msg|string|entityname|name of the entity they see}}
{{end-hl2msg}}
=== player_left_bunker_building ===
{{qnotice|}} 
{{begin-hl2msg|player_left_bunker_building|string}}
{{hl2msg|short|userid|The player who left the bunker}}
{{hl2msg|short|entidx|The bunker they left}}
{{end-hl2msg}}
=== player_entered_bunker_building ===
{{qnotice|}} 
{{begin-hl2msg|player_entered_bunker_building|string}}
{{hl2msg|short|userid|The player who entered the bunker}}
{{hl2msg|short|entidx|The bunker they entered}}
{{end-hl2msg}}
=== player_entered_commander_mode ===
{{qnotice|}} 
{{begin-hl2msg|player_entered_commander_mode|string}}
{{hl2msg|short|userid|Player who entered commander mode}}
{{end-hl2msg}}
=== player_enter_commander_mode_failed ===
{{qnotice|}} 
{{begin-hl2msg|player_enter_commander_mode_failed|string}}
{{hl2msg|short|userid|Player who tried to enter commander mode}}
{{end-hl2msg}}
=== player_left_commander_mode ===
{{qnotice|}} 
{{begin-hl2msg|player_left_commander_mode|string}}
{{hl2msg|short|userid|Player who left commander mode}}
{{end-hl2msg}}
=== player_restocked_from_supply_struct ===
{{qnotice|}} 
{{begin-hl2msg|player_restocked_from_supply_struct|string}}
{{hl2msg|short|userid|Player who was restocked}}
{{hl2msg|short|entidx|Entity they got supply from}}
{{end-hl2msg}}
=== player_opened_armoury_menu ===
{{qnotice|}} 
{{begin-hl2msg|player_opened_armoury_menu|string}}
{{hl2msg|short|userid|Player opened kit menu from armoury}}
{{end-hl2msg}}
=== commander_move_2d ===
{{qnotice|}} 
{{begin-hl2msg|commander_move_2d|string}}
{{hl2msg|1|local|Local only}}
{{hl2msg|short|userid|Player that moved the commander camera}}
{{end-hl2msg}}
=== commander_move_z ===
{{qnotice|}} 
{{begin-hl2msg|commander_move_z|string}}
{{hl2msg|1|local|Local only}}
{{hl2msg|short|userid|Player that moved the commander camera up/down}}
{{end-hl2msg}}
=== commander_minimap_move ===
{{qnotice|}} 
{{begin-hl2msg|commander_minimap_move|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|userid|Player that moved the commander camera}}
{{end-hl2msg}}
=== player_exited_tgate ===
{{qnotice|}} 
{{begin-hl2msg|player_exited_tgate|string}}
{{hl2msg|short|userid|Player that left the gate}}
{{end-hl2msg}}
=== commander_left_valid_area ===
{{qnotice|}} 
{{begin-hl2msg|commander_left_valid_area|string}}
{{hl2msg|short|userid|The commander that left valid "airspace"}}
{{end-hl2msg}}
=== commander_entered_valid_area ===
{{qnotice|}} 
{{begin-hl2msg|commander_entered_valid_area|string}}
{{hl2msg|short|userid|The commander that entered valid "airspace"}}
{{end-hl2msg}}
=== round_win ===
{{qnotice|}} 
{{begin-hl2msg|round_win|string}}
{{hl2msg|short|team|The winning team}}
{{hl2msg|short|type|Type of win}}
{{end-hl2msg}}
=== transport_gate_created ===
{{qnotice|}} 
{{begin-hl2msg|transport_gate_created|string}}
{{hl2msg|short|teamid|Team that created the gate}}
{{hl2msg|short|entindex|Entity id of the new gate}}
{{end-hl2msg}}
=== last_tgate_destroyed ===
{{qnotice|}} 
{{begin-hl2msg|last_tgate_destroyed|string}}
{{hl2msg|short|teamid|Team who's last tgate got pwnd}}
{{end-hl2msg}}
=== player_stats_updated ===
{{qnotice|}} 
{{begin-hl2msg|player_stats_updated|string}}
{{hl2msg|bool|forceupload|}}
{{end-hl2msg}}
=== failed_to_build ===
{{qnotice|}} 
{{begin-hl2msg|failed_to_build|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|userid|the commander that tried to build something with no power}}
{{hl2msg|short|reason|(eBuildErrorReason) 0: Ok, 1: No Power, 2: No Line of sight, 3: obstruction, 4: invalid build area}}
{{end-hl2msg}}
=== commander_hint_closed ===
{{qnotice|The local commander closed a hint (used to re-evaluate tiered hints)}} 
{{begin-hl2msg|commander_hint_closed|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_selected_structure ===
{{qnotice|The local commander selected a structure}} 
{{begin-hl2msg|commander_selected_structure|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|type|structure type}}
{{hl2msg|short|entindex|Entity id of the selected structure}}
{{end-hl2msg}}
=== commander_flash_assembler_start ===
{{qnotice|Causes the assembler to flash}} 
{{begin-hl2msg|commander_flash_assembler_start|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_flash_assembler_stop ===
{{qnotice|Causes the assembler to stop flashing}} 
{{begin-hl2msg|commander_flash_assembler_stop|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_start_build_mode ===
{{qnotice|Local commander is in structure placement mode}} 
{{begin-hl2msg|commander_start_build_mode|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|type|structure type}}
{{end-hl2msg}}
=== commander_flash_supply_icon_start ===
{{qnotice|Start flashing the supply station build icon}} 
{{begin-hl2msg|commander_flash_supply_icon_start|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_flash_supply_icon_stop ===
{{qnotice|Stop flashing the supply station build icon}} 
{{begin-hl2msg|commander_flash_supply_icon_stop|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_start_structure_build ===
{{qnotice|Start a structure building}} 
{{begin-hl2msg|commander_start_structure_build|string}}
{{hl2msg|short|team|The team that is building the structure}}
{{hl2msg|short|type|The structure type}}
{{end-hl2msg}}
=== promoted_to_commander ===
{{qnotice|}} 
{{begin-hl2msg|promoted_to_commander|string}}
{{hl2msg|short|userid|The user that got promoted to commander}}
{{hl2msg|short|teamid|The team of the promoted commander}}
{{end-hl2msg}}
=== timeleft_10m ===
{{qnotice|10 minutes left of the round}} 
{{begin-hl2msg|timeleft_10m|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_5m ===
{{qnotice|5 minutes left of the round}} 
{{begin-hl2msg|timeleft_5m|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_1m ===
{{qnotice|1 minute left of the round}} 
{{begin-hl2msg|timeleft_1m|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_30s ===
{{qnotice|30 seconds left of the round}} 
{{begin-hl2msg|timeleft_30s|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_10s ===
{{qnotice|10 seconds left of the round}} 
{{begin-hl2msg|timeleft_10s|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_5s ===
{{qnotice|5 seconds left of the round}} 
{{begin-hl2msg|timeleft_5s|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== ach_hospital_duty_progress ===
{{qnotice|progress towards hospital duty achievement. fired client-side. commander only. same team.}} 
{{begin-hl2msg|ach_hospital_duty_progress|string}}
{{hl2msg|short|progress|}}
{{end-hl2msg}}
=== ach_high_maintenance_progress ===
{{qnotice|progress towards high maintenance achievement. fired client-side. commander only. same team.}} 
{{begin-hl2msg|ach_high_maintenance_progress|string}}
{{hl2msg|short|progress|}}
{{end-hl2msg}}
=== forward_spawn_created ===
{{qnotice|Fired once a forward spawn has been created. A forward spawn is defined by any created spawn point that causes the spawn cluster centroid to be split}} 
{{begin-hl2msg|forward_spawn_created|string}}
{{hl2msg|short|teamid|}}
{{end-hl2msg}}
=== research_complete ===
{{qnotice|Fired when a research has finished researching}} 
{{begin-hl2msg|research_complete|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|teamid|}}
{{hl2msg|short|researchid|}}
{{end-hl2msg}}
=== show_annotation ===
{{qnotice|}} 
{{begin-hl2msg|show_annotation|string}}
{{hl2msg|float|worldPosX|}}
{{hl2msg|float|worldPosY|}}
{{hl2msg|float|worldPosZ|}}
{{hl2msg|float|worldNormalX|}}
{{hl2msg|float|worldNormalY|}}
{{hl2msg|float|worldNormalZ|}}
{{hl2msg|long|id|}}
{{hl2msg|string|text|name (unlocalized)}}
{{hl2msg|float|lifetime|}}
{{hl2msg|long|visibilityBitfield|bitfield of the players that can see this}}
{{hl2msg|long|follow_entindex|if this is set, follow this entity}}
{{hl2msg|bool|show_distance|}}
{{hl2msg|string|play_sound|}}
{{hl2msg|bool|show_effect|}}
{{end-hl2msg}}
=== hide_annotation ===
{{qnotice|}} 
{{begin-hl2msg|hide_annotation|string}}
{{hl2msg|long|id|}}
{{end-hl2msg}}
=== end_training_session ===
{{qnotice|}} 
{{begin-hl2msg|end_training_session|string}}
{{hl2msg|string|course|}}
{{hl2msg|bool|successful|}}
{{end-hl2msg}}
=== nav_generate ===
{{qnotice|}} 
{{begin-hl2msg|nav_generate|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== medkit_heal ===
{{qnotice|}} 
{{begin-hl2msg|medkit_heal|string}}
{{hl2msg|1|local|}}
{{hl2msg|local|entindex|entity index of medkit}}
{{hl2msg|local|ownerid|user id of medkit owner}}
{{hl2msg|local|userid|user id of player healed}}
{{hl2msg|local|amount|amount of health restored}}
{{end-hl2msg}}
=== emp_structure ===
{{qnotice|}} 
{{begin-hl2msg|emp_structure|string}}
{{hl2msg|1|local|}}
{{hl2msg|local|entindex|entity index of structure}}
{{hl2msg|local|userid|user id of player}}
{{end-hl2msg}}
=== setup_compass_rotation ===
{{qnotice|}} 
{{begin-hl2msg|setup_compass_rotation|string}}
{{hl2msg|long|rotation|}}
{{end-hl2msg}}
=== tgate_use ===
{{qnotice|}} 
{{begin-hl2msg|tgate_use|string}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}
=== attacked_radarkit ===
{{qnotice|}} 
{{begin-hl2msg|attacked_radarkit|string}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}

Nuclear Dawn Events

2014-10-04T18:23:48Z

Peace-Maker:

:''Refer back to [[Game Events (Source)]] for more events.''

=== player_death ===
{{qnotice|}} 
{{begin-hl2msg|player_death|string}}
{{hl2msg|short|userid|user ID who died}}
{{hl2msg|short|attacker|user ID who killed}}
{{hl2msg|string|weapon|weapon name killed used}}
{{hl2msg|short|weaponid|weapon id}}
{{hl2msg|long|damagebits|bits}}
{{hl2msg|long|customkill|custom bits}}
{{hl2msg|short|priority|}}
{{end-hl2msg}}
=== player_hurt ===
{{qnotice|}} 
{{begin-hl2msg|player_hurt|string}}
{{hl2msg|1|local|Not networked}}
{{hl2msg|short|userid|user ID who was hurt}}
{{hl2msg|short|attacker|user id who attacked}}
{{hl2msg|short|health|remaining health points}}
{{hl2msg|string|weapon|weapon name attacker used, if not the world}}
{{hl2msg|short|dmg_health|damage done to health}}
{{hl2msg|byte|hitgroup|hitgroup that was damaged}}
{{hl2msg|long|type|damage type}}
{{end-hl2msg}}
=== player_changeclass ===
{{qnotice|Called when a player changes class}} 
{{begin-hl2msg|player_changeclass|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|class|}}
{{hl2msg|short|subclass|}}
{{end-hl2msg}}
=== spec_target_updated ===
{{qnotice|}} 
{{begin-hl2msg|spec_target_updated|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== achievement_earned ===
{{qnotice|}} 
{{begin-hl2msg|achievement_earned|string}}
{{hl2msg|short|player|}}
{{hl2msg|short|achievement|}}
{{end-hl2msg}}
=== player_spawned_at_tgate ===
{{qnotice|}} 
{{begin-hl2msg|player_spawned_at_tgate|string}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}
=== structure_death ===
{{qnotice|fired when we sell a structure}} 
{{begin-hl2msg|structure_death|string}}
{{hl2msg|short|type|type of structure sold}}
{{hl2msg|short|team|the team the structure belonged to}}
{{hl2msg|short|entindex|The entidx of the structure}}
{{hl2msg|short|attacker|userid of attacking player}}
{{hl2msg|string|weapon|weapon name the attacker used}}
{{end-hl2msg}}
=== structure_damage_sparse ===
{{qnotice|is only fired for every 100hp taken. no spamz here}} 
{{begin-hl2msg|structure_damage_sparse|string}}
{{hl2msg|short|entindex|entity index of structure being damaged}}
{{hl2msg|short|ownerteam|team that owns the structure - Todo: optimize this out!}}
{{hl2msg|bool|bunker|was it the bunker?}}
{{hl2msg|local|userid|user id that damaged the structure}}
{{end-hl2msg}}
=== structure_sold ===
{{qnotice|fired when we sell a structure}} 
{{begin-hl2msg|structure_sold|string}}
{{hl2msg|short|type|type of structure sold}}
{{hl2msg|short|ownerteam|the team the structure belonged to}}
{{end-hl2msg}}
=== structure_fully_auto_repaired ===
{{qnotice|fired when a damaged structure gets healed to 100% hp using auto repair}} 
{{begin-hl2msg|structure_fully_auto_repaired|string}}
{{hl2msg|short|type|type of structure repaired}}
{{hl2msg|short|entindex|entity index of repaired structure}}
{{hl2msg|short|ownerteam|team that the structure belongs to}}
{{end-hl2msg}}
=== structure_fully_man_repaired ===
{{qnotice|fired when a damaged structure gets healed to 100% hp by supports}} 
{{begin-hl2msg|structure_fully_man_repaired|string}}
{{hl2msg|short|type|type of structure repaired}}
{{hl2msg|short|entindex|entity index of repaired structure}}
{{hl2msg|short|ownerteam|team that the structure belongs to}}
{{hl2msg|local|userid|user id that repaired the sturcture}}
{{end-hl2msg}}
=== structure_built ===
{{qnotice|structure fully built. fired client-side. commander only. same team.}} 
{{begin-hl2msg|structure_built|string}}
{{hl2msg|short|entindex|structure entity index}}
{{end-hl2msg}}
=== structure_power_outage ===
{{qnotice|structure out of power. fired client-side. commander only. same team.}} 
{{begin-hl2msg|structure_power_outage|string}}
{{hl2msg|short|entindex|structure entity index}}
{{end-hl2msg}}
=== resource_start_capture ===
{{qnotice|Used to show the capture hud panel}} 
{{begin-hl2msg|resource_start_capture|string}}
{{hl2msg|short|userid|user id that is starting the capture}}
{{hl2msg|short|entindex|resource point getting capped}}
{{hl2msg|short|type|type of resource point}}
{{hl2msg|short|capteam|team that is capping}}
{{hl2msg|short|ownerteam|team that currently owns the point (check for unassigned)}}
{{end-hl2msg}}
=== resource_end_capture ===
{{qnotice|Used to hide the capture hud panel}} 
{{begin-hl2msg|resource_end_capture|string}}
{{hl2msg|short|userid|user id that is starting the capture}}
{{hl2msg|short|entindex|resource point that got captured}}
{{end-hl2msg}}
=== resource_break_capture ===
{{qnotice|}} 
{{begin-hl2msg|resource_break_capture|string}}
{{hl2msg|short|entindex|}}
{{hl2msg|float|time_remaining|}}
{{end-hl2msg}}
=== resource_extract ===
{{qnotice|Resource point has extracted some resources}} 
{{begin-hl2msg|resource_extract|string}}
{{hl2msg|short|entindex|resource point that extracted the resources}}
{{hl2msg|short|amount|resource point that extracted the resources}}
{{end-hl2msg}}
=== resource_captured ===
{{qnotice|When a resource point gets fully captured by a team}} 
{{begin-hl2msg|resource_captured|string}}
{{hl2msg|short|entindex|entity index of the captrd point}}
{{hl2msg|short|type|the resource point type that got captured}}
{{hl2msg|short|team|team that captured the point}}
{{end-hl2msg}}
=== power_requested ===
{{qnotice|An entity is requesting a power connection}} 
{{begin-hl2msg|power_requested|string}}
{{hl2msg|short|teamid|The team who's power system got updated}}
{{hl2msg|short|entid|The entity index that is requesting a power connection}}
{{end-hl2msg}}
=== power_removed ===
{{qnotice|An entity is requesting a power connection}} 
{{begin-hl2msg|power_removed|string}}
{{hl2msg|short|teamid|The team who's power system got updated}}
{{hl2msg|short|entid|The entity index that is requesting a power connection}}
{{end-hl2msg}}
=== power_updated ===
{{qnotice|When the power nexus gets updated}} 
{{begin-hl2msg|power_updated|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== enter_pregame ===
{{qnotice|}} 
{{begin-hl2msg|enter_pregame|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== enter_vehicle ===
{{qnotice|}} 
{{begin-hl2msg|enter_vehicle|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|seat|}}
{{hl2msg|short|entidx|}}
{{end-hl2msg}}
=== exit_vehicle ===
{{qnotice|}} 
{{begin-hl2msg|exit_vehicle|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|seat|}}
{{hl2msg|short|entidx|}}
{{end-hl2msg}}
=== show_freezepanel ===
{{qnotice|}} 
{{begin-hl2msg|show_freezepanel|string}}
{{hl2msg|short|killer|entindex of the killer entity}}
{{end-hl2msg}}
=== hide_freezepanel ===
{{qnotice|}} 
{{begin-hl2msg|hide_freezepanel|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== freezecam_started ===
{{qnotice|}} 
{{begin-hl2msg|freezecam_started|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== spawn_map_changed ===
{{qnotice|Called when a tgate is built, removed, or power state changes}} 
{{begin-hl2msg|spawn_map_changed|string}}
{{hl2msg|short|teamid|}}
{{end-hl2msg}}
=== overviewmap_key_released ===
{{qnotice|}} 
{{begin-hl2msg|overviewmap_key_released|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== slot_key_pressed ===
{{qnotice|}} 
{{begin-hl2msg|slot_key_pressed|string}}
{{hl2msg|short|slot|}}
{{end-hl2msg}}
=== ironsight_key_pressed ===
{{qnotice|}} 
{{begin-hl2msg|ironsight_key_pressed|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== ability_key_pressed ===
{{qnotice|}} 
{{begin-hl2msg|ability_key_pressed|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== weapon_reload ===
{{qnotice|}} 
{{begin-hl2msg|weapon_reload|string}}
{{hl2msg|short|userid|}}
{{hl2msg|bool|manual|player manually started the reload}}
{{end-hl2msg}}
=== weapon_fire_at_40 ===
{{qnotice|}} 
{{begin-hl2msg|weapon_fire_at_40|string}}
{{hl2msg|short|userid|}}
{{hl2msg|string|weapon|used weapon name}}
{{hl2msg|short|weaponid|used weapon ID}}
{{hl2msg|short|count|number of bullets}}
{{end-hl2msg}}
=== entity_visible ===
{{qnotice|}} 
{{begin-hl2msg|entity_visible|string}}
{{hl2msg|short|userid|The player who sees the entity}}
{{hl2msg|long|subject|Entindex of the entity they see}}
{{hl2msg|string|classname|Classname of the entity they see}}
{{hl2msg|string|entityname|name of the entity they see}}
{{end-hl2msg}}
=== player_left_bunker_building ===
{{qnotice|}} 
{{begin-hl2msg|player_left_bunker_building|string}}
{{hl2msg|short|userid|The player who left the bunker}}
{{hl2msg|short|entidx|The bunker they left}}
{{end-hl2msg}}
=== player_entered_bunker_building ===
{{qnotice|}} 
{{begin-hl2msg|player_entered_bunker_building|string}}
{{hl2msg|short|userid|The player who entered the bunker}}
{{hl2msg|short|entidx|The bunker they entered}}
{{end-hl2msg}}
=== player_entered_commander_mode ===
{{qnotice|}} 
{{begin-hl2msg|player_entered_commander_mode|string}}
{{hl2msg|short|userid|Player who entered commander mode}}
{{end-hl2msg}}
=== player_enter_commander_mode_failed ===
{{qnotice|}} 
{{begin-hl2msg|player_enter_commander_mode_failed|string}}
{{hl2msg|short|userid|Player who tried to enter commander mode}}
{{end-hl2msg}}
=== player_left_commander_mode ===
{{qnotice|}} 
{{begin-hl2msg|player_left_commander_mode|string}}
{{hl2msg|short|userid|Player who left commander mode}}
{{end-hl2msg}}
=== player_restocked_from_supply_struct ===
{{qnotice|}} 
{{begin-hl2msg|player_restocked_from_supply_struct|string}}
{{hl2msg|short|userid|Player who was restocked}}
{{hl2msg|short|entidx|Entity they got supply from}}
{{end-hl2msg}}
=== player_opened_armoury_menu ===
{{qnotice|}} 
{{begin-hl2msg|player_opened_armoury_menu|string}}
{{hl2msg|short|userid|Player opened kit menu from armoury}}
{{end-hl2msg}}
=== commander_move_2d ===
{{qnotice|}} 
{{begin-hl2msg|commander_move_2d|string}}
{{hl2msg|1|local|Local only}}
{{hl2msg|short|userid|Player that moved the commander camera}}
{{end-hl2msg}}
=== commander_move_z ===
{{qnotice|}} 
{{begin-hl2msg|commander_move_z|string}}
{{hl2msg|1|local|Local only}}
{{hl2msg|short|userid|Player that moved the commander camera up/down}}
{{end-hl2msg}}
=== commander_minimap_move ===
{{qnotice|}} 
{{begin-hl2msg|commander_minimap_move|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|userid|Player that moved the commander camera}}
{{end-hl2msg}}
=== player_exited_tgate ===
{{qnotice|}} 
{{begin-hl2msg|player_exited_tgate|string}}
{{hl2msg|short|userid|Player that left the gate}}
{{end-hl2msg}}
=== commander_left_valid_area ===
{{qnotice|}} 
{{begin-hl2msg|commander_left_valid_area|string}}
{{hl2msg|short|userid|The commander that left valid "airspace"}}
{{end-hl2msg}}
=== commander_entered_valid_area ===
{{qnotice|}} 
{{begin-hl2msg|commander_entered_valid_area|string}}
{{hl2msg|short|userid|The commander that entered valid "airspace"}}
{{end-hl2msg}}
=== round_win ===
{{qnotice|}} 
{{begin-hl2msg|round_win|string}}
{{hl2msg|short|team|The winning team}}
{{hl2msg|short|type|Type of win}}
{{end-hl2msg}}
=== transport_gate_created ===
{{qnotice|}} 
{{begin-hl2msg|transport_gate_created|string}}
{{hl2msg|short|teamid|Team that created the gate}}
{{hl2msg|short|entindex|Entity id of the new gate}}
{{end-hl2msg}}
=== last_tgate_destroyed ===
{{qnotice|}} 
{{begin-hl2msg|last_tgate_destroyed|string}}
{{hl2msg|short|teamid|Team who's last tgate got pwnd}}
{{end-hl2msg}}
=== player_stats_updated ===
{{qnotice|}} 
{{begin-hl2msg|player_stats_updated|string}}
{{hl2msg|bool|forceupload|}}
{{end-hl2msg}}
=== failed_to_build ===
{{qnotice|}} 
{{begin-hl2msg|failed_to_build|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|userid|the commander that tried to build something with no power}}
{{hl2msg|short|reason|(eBuildErrorReason) 0: Ok, 1: No Power, 2: No Line of sight, 3: obstruction, 4: invalid build area}}
{{end-hl2msg}}
=== commander_hint_closed ===
{{qnotice|The local commander closed a hint (used to re-evaluate tiered hints)}} 
{{begin-hl2msg|commander_hint_closed|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_selected_structure ===
{{qnotice|The local commander selected a structure}} 
{{begin-hl2msg|commander_selected_structure|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|type|structure type}}
{{hl2msg|short|entindex|Entity id of the selected structure}}
{{end-hl2msg}}
=== commander_flash_assembler_start ===
{{qnotice|Causes the assembler to flash}} 
{{begin-hl2msg|commander_flash_assembler_start|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_flash_assembler_stop ===
{{qnotice|Causes the assembler to stop flashing}} 
{{begin-hl2msg|commander_flash_assembler_stop|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_start_build_mode ===
{{qnotice|Local commander is in structure placement mode}} 
{{begin-hl2msg|commander_start_build_mode|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|type|structure type}}
{{end-hl2msg}}
=== commander_flash_supply_icon_start ===
{{qnotice|Start flashing the supply station build icon}} 
{{begin-hl2msg|commander_flash_supply_icon_start|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_flash_supply_icon_stop ===
{{qnotice|Stop flashing the supply station build icon}} 
{{begin-hl2msg|commander_flash_supply_icon_stop|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_start_structure_build ===
{{qnotice|Start a structure building}} 
{{begin-hl2msg|commander_start_structure_build|string}}
{{hl2msg|short|team|The team that is building the structure}}
{{hl2msg|short|type|The structure type}}
{{end-hl2msg}}
=== promoted_to_commander ===
{{qnotice|}} 
{{begin-hl2msg|promoted_to_commander|string}}
{{hl2msg|short|userid|The user that got promoted to commander}}
{{hl2msg|short|teamid|The team of the promoted commander}}
{{end-hl2msg}}
=== timeleft_10m ===
{{qnotice|10 minutes left of the round}} 
{{begin-hl2msg|timeleft_10m|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_5m ===
{{qnotice|5 minutes left of the round}} 
{{begin-hl2msg|timeleft_5m|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_1m ===
{{qnotice|1 minute left of the round}} 
{{begin-hl2msg|timeleft_1m|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_30s ===
{{qnotice|30 seconds left of the round}} 
{{begin-hl2msg|timeleft_30s|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_10s ===
{{qnotice|10 seconds left of the round}} 
{{begin-hl2msg|timeleft_10s|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_5s ===
{{qnotice|5 seconds left of the round}} 
{{begin-hl2msg|timeleft_5s|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== ach_hospital_duty_progress ===
{{qnotice|progress towards hospital duty achievement. fired client-side. commander only. same team.}} 
{{begin-hl2msg|ach_hospital_duty_progress|string}}
{{hl2msg|short|progress|}}
{{end-hl2msg}}
=== ach_high_maintenance_progress ===
{{qnotice|progress towards high maintenance achievement. fired client-side. commander only. same team.}} 
{{begin-hl2msg|ach_high_maintenance_progress|string}}
{{hl2msg|short|progress|}}
{{end-hl2msg}}
=== forward_spawn_created ===
{{qnotice|Fired once a forward spawn has been created. A forward spawn is defined by any created spawn point that causes the spawn cluster centroid to be split}} 
{{begin-hl2msg|forward_spawn_created|string}}
{{hl2msg|short|teamid|}}
{{end-hl2msg}}
=== research_complete ===
{{qnotice|Fired when a research has finished researching}} 
{{begin-hl2msg|research_complete|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|teamid|}}
{{hl2msg|short|researchid|}}
{{end-hl2msg}}
=== show_annotation ===
{{qnotice|}} 
{{begin-hl2msg|show_annotation|string}}
{{hl2msg|float|worldPosX|}}
{{hl2msg|float|worldPosY|}}
{{hl2msg|float|worldPosZ|}}
{{hl2msg|float|worldNormalX|}}
{{hl2msg|float|worldNormalY|}}
{{hl2msg|float|worldNormalZ|}}
{{hl2msg|long|id|}}
{{hl2msg|string|text|name (unlocalized)}}
{{hl2msg|float|lifetime|}}
{{hl2msg|long|visibilityBitfield|bitfield of the players that can see this}}
{{hl2msg|long|follow_entindex|if this is set, follow this entity}}
{{hl2msg|bool|show_distance|}}
{{hl2msg|string|play_sound|}}
{{hl2msg|bool|show_effect|}}
{{end-hl2msg}}
=== hide_annotation ===
{{qnotice|}} 
{{begin-hl2msg|hide_annotation|string}}
{{hl2msg|long|id|}}
{{end-hl2msg}}
=== end_training_session ===
{{qnotice|}} 
{{begin-hl2msg|end_training_session|string}}
{{hl2msg|string|course|}}
{{hl2msg|bool|successful|}}
{{end-hl2msg}}
=== nav_generate ===
{{qnotice|}} 
{{begin-hl2msg|nav_generate|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== medkit_heal ===
{{qnotice|}} 
{{begin-hl2msg|medkit_heal|string}}
{{hl2msg|1|local|}}
{{hl2msg|local|entindex|entity index of medkit}}
{{hl2msg|local|ownerid|user id of medkit owner}}
{{hl2msg|local|userid|user id of player healed}}
{{hl2msg|local|amount|amount of health restored}}
{{end-hl2msg}}
=== emp_structure ===
{{qnotice|}} 
{{begin-hl2msg|emp_structure|string}}
{{hl2msg|1|local|}}
{{hl2msg|local|entindex|entity index of structure}}
{{hl2msg|local|userid|user id of player}}
{{end-hl2msg}}
=== setup_compass_rotation ===
{{qnotice|}} 
{{begin-hl2msg|setup_compass_rotation|string}}
{{hl2msg|rotation|long|}}
{{end-hl2msg}}
=== tgate_use ===
{{qnotice|}} 
{{begin-hl2msg|tgate_use|string}}
{{hl2msg|userid|short|}}
{{end-hl2msg}}
=== attacked_radarkit ===
{{qnotice|}} 
{{begin-hl2msg|attacked_radarkit|string}}
{{hl2msg|userid|short|}}
{{end-hl2msg}}

SourceMod 1.6.0 Release Notes

2014-06-28T11:00:34Z

Peace-Maker: Typo

''This page is a work-in-progress as SourceMod 1.6.0 is not yet released.''

__FORCETOC__
SourceMod 1.6.0 is a major update with numerous under the hood improvements as well as some user-facing additions.

=Overview for Admins=

*'''New Game Support''' - SourceMod, including base plugins, now supports Dota 2, Source SDK 2013 mods, Insurgency, Contagion, and Blade Symphony.
*Updated gamedata for many games and mods.
*Added support to create custom ban reasons for the basebans plugin (thanks Matthias "{{user|79939|Dr. Greg House}}" Kollek).
*Many stability fixes.
*Better performance.

=Overview for Developers=

*Added an API for off-thread SQL transactions.
*Added support for string literal concatenation (with new "..." operator) (thanks {{user|41418|Peace-Maker}}).
*Adjusted the OnClientSayCommand forwards to be more developer-friendly (thanks {{user|193987|SystematicMania}}).

*Too much to name here. For overview of all sourcepawn and SM extension API changes and additions, please see [[SourceMod_1.6.0_API_Changes]]

=Compatibility Issues=

In most cases, SourceMod 1.6.0 is fully backward compatible with the 1.5.x releases. The following are the few places where this is not the case.

'''Float comparisons'''

Plugins compiled against SM 1.6.0 that use float comparisons will throw errors upon load on older SM versions. This is due to a reworking of how these are handled to provide support for NaN vaules. Plugins compiled on < 1.5.x and earlier will continue to load fine on 1.6.0.

'''OnClientSayCommand and OnClientSayCommand_Post'''

Double-quotes are now stripped from the chat message, either quotes on both sides, or single double-quote on either side.

This removes the need for any manual stripping, but may affect some logic already in place. Since these forwards were still fairly new and still receiving fixes for issues in the 1.5.0 and 1.5.1 releases, we wanted to get this change in before use was more widespread.

For more information, see [[SourceMod_1.6.0_API_Changes#Console]]

=Translations=
SourceMod 1.6 comes with the following languages translated, thanks to [http://www.sourcemod.net/translator/?go=translate&op=status community translators]:
*Brazilian Portuguese
*Chinese (Simplified)
*Czech
*Danish
*Dutch
*English
*French
*German
*Italian
*Japanese
*Korean
*Polish
*Russian
*Slovak
*Spanish
*Swedish
*Turkish
*Ukrainian

=Changelog=

===User Changes===
*Added support for Dota 2 ({{bz|5656}}, {{bz|6068}}).
*Added support for Source SDK 2013 mods ({{bz|5917}}).
*Added support for Insurgency ({{bz|5951}}).
*Added support for Contagion ({{bz|6007}}).
*Added support for Blade Symphony ({{bz|5949}}).
*Updated support for some mods that moved to SDK 2013*No More Room In Hell, Fistful of Frags, Empires, Synergy.
*Updated gamedata and other support for TF2, DoD:S, HL2:DM, CS:S, CS:GO, Left 4 Dead, and Nuclear Dawn.
*Added support for customizing ban reasons in basebans.sp ({{bz|5762}}) (Matthias "{{user|79939|House}}" Kollek).
*Added support for searching all gameinfo search paths when seeking mapcycle file ({{bz|5839}}).
*Added sm_reload_translations command ({{bz|5750}}).
*Added support for single-file gamedata custom overrides ({{bz|5386}}) (Ondrej "{{user|35591|Ravu al Hemio}}" Hošek).
*Re-enabled SteamAuthstringValidation config option by default ({{bz|5791}}, {{pr|20}}).
*Fixed plugins not reaching ext dep lists, making dependent plugin not unload on ext unload ({{bz|5851}}) ({{user|41418|Peace-Maker}}).
*Added printing of SendProp flags to netprop dumps ({{bz|6082}}).
*Removed support for obsolete plugin_settings.cfg ({{bz|5605}}).
*Fixed error log filename date sometimes being incorrect ({{bz|5761}}) (Matheus "{{user|59126|M28}}" Valadares).
*Dump handle information when a plugin is forcefully unloaded. ({{bz|5666}}).
*Fixed sm_cancelvote not resetting rtv state. ({{bz|5808}}) ({{user|41418|Peace-Maker}}).
*Fixed Mapchooser dying on single map rotation servers ({{bz|5179}}).
*Fixed various problems with unloading ClientPrefs and SourceMod ({{bz|5874}}).
*Fixed "sm version" command reporting incorrect compile time in many cases ({{bz|6078}}) ({{user|193987|SystematicMania}}).
*Clear default database driver reference if backing extension is unloaded ({{bz|5934}}) ({{user|41418|Peace-Maker}}).
*Moved funcommands material and sound definitions to gamedata for easier cross-game support ({{bz|6085}}).
*Implement a watchdog timer for scripts that take too long to execute ({{bz|5837}}).
*Use Linux game data for offsets and signatures/symbols on OS X if Mac-specific data is not available ({{bz|6056}}).

===Developer Changes===
*Added an API for off-thread SQL transactions. ({{bz|3775}}, {{pr|26}}).
*Added string literal concatenation using ellipses "..." ({{bz|4261}}, {{pr|5}}) ({{user|41418|Peace-Maker}}).
*Added support for nested datatables. ({{bz|5446}}).
*Added PbRemoveRepeatedFieldValue native ({{bz|6066}}).
*Added support for getting/setting protobuf enum values with PbGetInt, PbSetInt, and PbAddInt natives.
*Removed deprecated PbReadRepeated natives that existed briefly in 1.5.0-dev prerelease versions.
*Added RequestFrame native for one-off next-frame actions ({{bz|5965}}).
*Added CS_DMG_HEADSHOT define for CS:S and CS:GO ({{pr|7}}) ({{user|178115|Bara20}}).
*Added CS_SLOT_KNIFE define for CS:S and CS:GO ({{bz|6131}}).
*Updated TF_WEAPON enum ({{pr|37}}) ({{user|84304|FlaminSarge}}).
*Added TFHoliday_AprilFools to TFHoliday enum ({{bz|6092}}) (Ross "{{user|38996|Powerlord}}" Bemrose).
*Added new TF2_IsHolidayActive native to TF2 Ext ({{bz|6095}}) (Ross "{{user|38996|Powerlord}}" Bemrose).
*Switch TF2 extension to hook CTFGameRules::IsHolidayActive for holiday forward ({{bz|6137}}, {{pr|42}}).
*Added GetPlayerJingleFile native. ({{bz|5690}}) ({{user|84304|FlaminSarge}}).
*Added PrepSDKCall_SetAddress and Address support to PrepSDKCall_SetFromConf ({{bz|5261}}).
*Added ability to disable TopMenu Title Caching ({{bz|6034}}) ({{user|41418|Peace-Maker}}).
*Added DisplayTopMenuCategory native ({{bz|6033}}) ({{user|41418|Peace-Maker}}).
*Added support for Valve search paths to GetFileSize native ({{bz|5931}}).
*Fixed invalid entities sometimes passed to OnEntityCreated and OnEntityDestroyed ({{bz|6119}}).
*Fixed inconsistencies with OnClientDisconnected foward calls ({{bz|5988}}, {{pr|16}}).
*Changed OnClientSayCommand to now pass non-silent chat triggers onward ({{bz|5926}}) ({{user|193987|SystematicMania}}).
*Changed OnClientSayCommand forwards to strip quotes from chat ({{bz|5986}}) ({{user|193987|SystematicMania}}).
*Fixed FindStringIndex native not returning INVALID_STRING_INDEX when string not found ({{bz|6144}}, {{pr|40}}).
*Fixed GroundEntChanged hooks not being called ({{bz|6050}}) ({{user|41418|Peace-Maker}}).
*Fixed INetChannelInfo natives to no longer require clients to be ingame ({{bz|5775}}) ({{user|193987|SystematicMania}}).
*Fixed replace param being respected inconsistently in SetTrieArray ({{bz|6113}}).
*Fixed crash creating a timer when there are no handles available. ({{bz|5317}}) ({{user|41418|Peace-Maker}}).
*Fixed crash in ReconnectClient and InactivateClient natives when IServer ptr is null ({{bz|6122}}).
*Fixed StoreFromAddress and LoadFromAddress continuing with bad values, usually crashing after error ({{bz|6080}}).
*Fixed compiler bug with multidimensional array variable release ({{bz|6100}}).
*Changed float comparison operators to return false for NaN ({{bz|6107}}).
*Added support in spcomp for sp/inc files > 32767 lines ({{bz|5959}}).
*Fixed FindFlagChar returning '?' for Admin_Custom6.
*Fixed AllPluginsLoaded activities happening before SM is loaded.
*Deduplicated a number of files used by extensions by moving them to the public directory ({{bz|5341}}).
*Removed 'state' keyword from compiler ({{bz|4572}}) (Ryan "{{user|49537|VoiDeD}}" Stecker).
*Removed LogMessageEx definition from logging.inc because it never existed ({{bz|5897}}) ({{user|41418|Peace-Maker}}).
*Removed native override API ({{bz|5852}}).
*Call OnLibraryAdded for all available libraries ({{bz|5925}}, {{pr|4}}).
*Made IGameConfig::GetMemSig return value clearer ({{bz|6081}}).
*Switched StringToInt(Ex) from using strtol to strtoul internally ({{bz|5939}}).
*Added an spcomp option to print #included files ({{bz|5997}}).
*Recompiled Regex extension libpcre against v8.32, enabling utf8, unicode props, and jit ({{bz|5593}}).
*Optimized native calls if statically bound ({{bz|5842}}).

===Internal Changes===
*Now using new AlliedModders Template Library (AMTL) in many places, https://github.com/alliedmodders/amtl
*Ported buildscripts to new AMBuild2 platform, https://github.com/alliedmodders/ambuild
*Moved much logic from core to logic binary to reduce file sizes and compile times ({{bz|5606}}, {{bz|5607}}, {{bz|5680}}, {{bz|5953}}, {{pr|12}}, {{pr|13}}).
*Refactored the JIT to use a newer, simpler macro assembler. ({{bz|5827}}).
*Added sourcepawn interpreter ({{bz|5902}}).
*Added support for compiling spcomp with emscripten.
*Rewrite IThreader implementation around new synchronization primitives ({{bz|5862}}).
*Rewrite DBManager to use the new synchronization primitives ({{bz|5870}}).
*Overhauled internals of ClientPrefs extension for improved stability ({{bz|5538}}).
*Changed ShareSys to store C++ native lists more optimally ({{bz|5852}}).
*Simplified NativeEntry state ({{bz|5852}}).
*Changed NativeEntry to use Refcounted to manage ({{bz|5852}}).
*Switched Translator and GameConfigs to hash tables ({{bz|5878}}).
*Switched numerous subsystems from KTrie to AMTL NameHashSet ({{bz|5884}}).
*Refactored Trie natives to use AMTL HashMap instead of KTrie ({{bz|5892}}).
*Removed usages of memtables from many subsystems ({{bz|5899}}).
*Changed EventHook name storage to use AMTL AString ({{bz|6188}}).
*Replaced SH List usages in game extensions with AMTL variants ({{pr|23}}).
*Replaced SourceHook list usages in clientprefs with AMTL ({{pr|25}}).
*Changed floating-point operations to use SSE when available ({{bz|5841}}).
*Moved tracker related opcodes entirely to C++.
*Statically align the stack at function boundaries ({{bz|5842}}).
*Removed InfoVars, reassigned DAT from EBP to ESI to preserve C++ stacktraces in JIT code ({{bz|5844}}).
*Fixed dereferencing potential null pointer in CPlugin::GetProperty ({{bz|5725}}).
*Fixed memory corruption when parsing natives. ({{bz|5840}}).
*Fixed some memory errors ({{bz|5904}}).
*Fixed unaligned memory access in spcomp.
*Move versioning to a static library to improve trivial build speed ({{bz|5997}}).
*Added many missing handle security checks ({{bz|5595}}).
*Made GetEntityClassname get and cache m_iClassname offset from worldspawn for ents not having it in datadesc ({{bz|5654}}).
*Cache m_iEFlags offset for datamaps dump instead of getting for each ent ({{bz|5657}}).
*Fixed mismatched delete [] on thunks in JIT CompData dtor ({{bz|5639}}).
*Fixed various memory issues. ({{bz|5766}}).
*Added reference counting and use it for CGameConfig and IDatabase ({{bz|5876}}).
*Added atomic reference counting and port DBI ({{bz|5876}}).
*Replaced usages of deprecated Sourcehook Add/Remove macros ({{bz|5631}}).
*Fixed SDKHooks hook ent validation missing first datatable name ({{bz|5881}}).
*Fixed case where bots leave server without disconnect notice (hibernation) ({{pr|20}}).
*Changed FindConVar to utilize convar cache for improved performance ({{pr|27}}) (VoiDeD).
*Gave define value (of 1) to PLATFORM defs to match the same-name defs in some SDKs ({{pr|10}}).
*Wrapped ClientPrintf into IGamePlayer ({{bz|6021}}).
*Consolidated FileExists usage in logic bin ({{bz|5931}}).
*Removed hardcoded paths to tier0/vstdlib in ICommandLine lookup.
*Use updated IServerTools iface on TF2 for getting tempent list and FindEntityByClassname ({{pr|33}}).
*Added early exit in entity output detour if entity has no classname to prevent crash.
*Updated SDKTools entity output functions to use core's GetEntityClassname instead of own ({{pr|39}}).
*Consolidated SDKTools entity factory lookups.
*Changed SDKTools PlayerRunCmd to a global vtable hook to improve performance ({{bz|6051}}).
*Changed SDKHooks to use global vtable hooks to improve performance ({{bz|6070}}).
*Added client validation checks to EmitSound SoundsHooks ({{bz|5873}}).
*Added missing meta results to some pre-hooks in SDKHooks.
*Replaced magic numbers for sm_show_activity with named constants ({{pr|14}}).

Timers (SourceMod Scripting)

2014-02-10T14:23:52Z

Peace-Maker:

Timers in [[SourceMod]] are timed events that occur once or repeatedly at a given interval.

=Introduction=
Timers allow you to set an interval, a function to use as the event callback, and an optional Handle to pass through the callback. This is useful for saving data asynchronously.

All timer functions are in <tt>plugins/include/timers.inc</tt>.

=Basic Usage=
==One-Time Timers==
One-time timers are timers that only execute once. An example of a one-time timer might look like:

<pawn>public OnPluginStart()
{
CreateTimer(5.0, LoadStuff);
}

public Action:LoadStuff(Handle:timer)
{
PrintToServer("Loading stuff!");
}</pawn>

This code will print "Loading stuff!" to the server console five seconds after the map loads. The return value has no meaning for one-time timers.

==Repeatable Timers==
Repeatable timers execute infinitely many times, once every interval. Based on the return value, they either continue or cancel.

For example, say you want to display a message five times, once every three seconds:
<pawn>
someFunction()
{
CreateTimer(3.0, Timer_PrintMessageFiveTimes, _, TIMER_REPEAT);
}

public Action:Timer_PrintMessageFiveTimes(Handle:timer)
{
// Create a global variable visible only in the local scope (this function).
static numPrinted = 0;

if (numPrinted >= 5) {
numPrinted = 0;
return Plugin_Stop;
}

PrintToServer("Warning! This is a message.");
numPrinted++;

return Plugin_Continue;
}</pawn>

Note that <tt>Plugin_Stop</tt> stops the timer, and <tt>Plugin_Continue</tt> allows it to continue repeating.

=Passing Data=
==Simple Values==
As mentioned earlier, timers let you pass values on to the callback function. This value can be any type. For example, let's say we want to print a message to a player fifteen seconds after they connect. However, we want to cancel the timer if the player disconnects. Implementing this is very easy:

<pawn>
new Handle:WelcomeTimers[MAXPLAYERS+1];

public OnClientPutInServer(client)
{
WelcomeTimers[client] = CreateTimer(15.0, WelcomePlayer, client);
}

public OnClientDisconnect(client)
{
if (WelcomeTimers[client] != INVALID_HANDLE)
{
KillTimer(WelcomeTimers[client]);
WelcomeTimers[client] = INVALID_HANDLE;
}
}

public Action:WelcomePlayer(Handle:timer, any:client)
{
PrintToConsole(client, "Welcome to the server!");
WelcomeTimers[client] = INVALID_HANDLE;
}</pawn>

Another example without using handles is to use either UserID or ClientSerial (which is unique to each player):

<pawn>
public OnClientPutInServer(client)
{
CreateTimer(15.0, WelcomePlayer, GetClientSerial(client)); // You could also use GetClientUserId(client)
}

public Action:WelcomePlayer(Handle:timer, any:serial)
{
new client = GetClientFromSerial(serial); // Validate the client serial

if (client == 0) // The serial is no longer valid, the player must have disconnected
{
return Plugin_Stop;
}

PrintToConsole(client, "Welcome to the server!");
}</pawn>
If you want to close or cancel a timer when a client disconnects, then use the first example with handles.

==Handles==
If you want to pass a Handle as a value, you have the option of using <tt>TIMER_DATA_HNDL_CLOSE</tt>, which will automatically call <tt>CloseHandle()</tt> for you once the timer dies.

==Data Packs==
Data packs are packable structures that can be used to hold asynchronous data (data that must be saved and unpacked for later). They are especially useful for timers, and thus there exists a helper function, called <tt>CreateDataTimer()</tt>, which creates a timer using a data pack handle. The handle is created and closed automatically for you.

The above example could be rewritten as:
<pawn>
new Handle:WelcomeTimers[MAXPLAYERS+1];

public OnClientPutInServer(client)
{
new Handle:pack;
WelcomeTimers[client] = CreateDataTimer(15.0, WelcomePlayer, pack);
WritePackCell(pack, client);
WritePackString(pack, "Welcome to the server!");
}

public OnClientDisconnect(client)
{
if (WelcomeTimers[client] != INVALID_HANDLE)
{
KillTimer(WelcomeTimers[client]);
WelcomeTimers[client] = INVALID_HANDLE;
}
}

public Action:WelcomePlayer(Handle:timer, Handle:pack)
{
decl String:str[128];
new client;

/* Set to the beginning and unpack it */
ResetPack(pack);
client = ReadPackCell(pack);
ReadPackString(pack, str, sizeof(str));

PrintToConsole(client, "%s", str);
WelcomeTimers[client] = INVALID_HANDLE;
}</pawn>

=Notes=
==Accuracy==
The smallest possible interval is 0.1 seconds. Timers have high precision (floating point) but low accuracy, as the current time is based on the in-game tick count, not the system clock. This has two implications:
*If the server is paused (not ticking or hibernating), timers will not run.
*The server will not always tick at an exact interval.

For example, a 1.234 second interval timer starting from time <tt>t</tt> might not tick until <tt>t+1.242</tt> at a tickrate of 66 ticks per second.

==Timer Death==
All timers are guaranteed to die either by:
*<tt>CloseHandle()</tt> being called (or on plugin unload);
*<tt>KillTimer()</tt> being called;
*<tt>Plugin_Stop</tt> being returned from a repeatable timer;
*<tt>TriggerTimer()</tt> being called on a one-time timer;
*Execution of a one-time timer finishes.

When a timer dies, if <tt>TIMER_DATA_HNDL_CLOSE</tt> is set, the Handle will always be closed with the permissions that <tt>CloseHandle()</tt> uses by default. Since timers cannot be cloned, there should be no ownership issues.

==Changing Intervals==
The interval of a timer cannot be changed as of this writing. The timer must be killed and a new one created.

==AMX Mod X==
Unlike [[AMX Mod X]]'s <tt>set_task</tt> function, you cannot pass arrays using <tt>CreateTimer</tt>. To accomplish this, you should use the data pack functionality explained above.

Similarly, there are no flags for counted repeats (non-infinite loops) or timers based on the map start or end. These must be done manually.

=External Links=
*[http://www.sourcemod.net/devlog/?p=130 On Timer Design, Part 3] (SourceMod DevLog)
*[http://www.sourcemod.net/devlog/?p=119 On Timer Design, Part 2] (SourceMod DevLog)
*[http://www.sourcemod.net/devlog/?p=118 On Timer Design, Part 1] (SourceMod DevLog)

[[Category:SourceMod Scripting]]

{{LanguageSwitch}}

Timers (SourceMod Scripting)

2014-02-10T14:09:19Z

Peace-Maker:

Timers in [[SourceMod]] are timed events that occur once or repeatedly at a given interval.

=Introduction=
Timers allow you to set an interval, a function to use as the event callback, and an optional Handle to pass through the callback. This is useful for saving data asynchronously.

All timer functions are in <tt>plugins/include/timers.inc</tt>.

=Basic Usage=
==One-Time Timers==
One-time timers are timers that only execute once. An example of a one-time timer might look like:

<pawn>public OnPluginStart()
{
CreateTimer(5.0, LoadStuff)
}

public Action:LoadStuff(Handle:timer)
{
PrintToServer("Loading stuff!")
}</pawn>

This code will print "Loading stuff!" to the server console five seconds after the map loads. The return value has no meaning for one-time timers.

==Repeatable Timers==
Repeatable timers execute infinitely many times, once every interval. Based on the return value, they either continue or cancel.

For example, say you want to display a message five times, once every three seconds:
<pawn>
someFunction()
{
CreateTimer(3.0, Timer_PrintMessageFiveTimes, _, TIMER_REPEAT);
}

public Action:Timer_PrintMessageFiveTimes(Handle:timer)
{
// Create a global variable visible only in the local scope (this function).
static numPrinted = 0;

if (numPrinted >= 5) {
numPrinted = 0;
return Plugin_Stop;
}

PrintToServer("Warning! This is a message.");
numPrinted++;

return Plugin_Continue;
}</pawn>

Note that <tt>Plugin_Stop</tt> stops the timer, and <tt>Plugin_Continue</tt> allows it to continue repeating.

=Passing Data=
==Simple Values==
As mentioned earlier, timers let you pass values on to the callback function. This value can be any type. For example, let's say we want to print a message to a player fifteen seconds after they connect. However, we want to cancel the timer if the player disconnects. Implementing this is very easy:

<pawn>
new Handle:WelcomeTimers[MAXPLAYERS+1]

public OnClientPutInServer(client)
{
WelcomeTimers[client] = CreateTimer(15.0, WelcomePlayer, client)
}

public OnClientDisconnect(client)
{
if (WelcomeTimers[client] != INVALID_HANDLE)
{
KillTimer(WelcomeTimers[client])
WelcomeTimers[client] = INVALID_HANDLE
}
}

public Action:WelcomePlayer(Handle:timer, any:client)
{
PrintToConsole(client, "Welcome to the server!")
WelcomeTimers[client] = INVALID_HANDLE
}</pawn>

Another example without using handles is to use either UserID or ClientSerial (which is unique to each player):

<pawn>
public OnClientPutInServer(client)
{
CreateTimer(15.0, WelcomePlayer, GetClientSerial(client)) // You could also use GetClientUserId(client)
}

public Action:WelcomePlayer(Handle:timer, any:serial)
{
new client = GetClientFromSerial(serial) // Validate the client serial

if (client == 0) // The serial is no longer valid, the player must have disconnected
{
return Plugin_Continue
}

PrintToConsole(client, "Welcome to the server!")
}</pawn>
If you want to close or cancel a timer when a client disconnects, then use the first example with handles.

==Handles==
If you want to pass a Handle as a value, you have the option of using <tt>TIMER_DATA_HNDL_CLOSE</tt>, which will automatically call <tt>CloseHandle()</tt> for you once the timer dies.

==Data Packs==
Data packs are packable structures that can be used to hold asynchronous data (data that must be saved and unpacked for later). They are especially useful for timers, and thus there exists a helper function, called <tt>CreateDataTimer()</tt>, which creates a timer using a data pack handle. The handle is created and closed automatically for you.

The above example could be rewritten as:
<pawn>
new Handle:WelcomeTimers[MAXPLAYERS+1]

public OnClientPutInServer(client)
{
new Handle:pack
WelcomeTimers[client] = CreateDataTimer(15.0, WelcomePlayer, pack)
WritePackCell(pack, client)
WritePackString(pack, "Welcome to the server!")
}

public OnClientDisconnect(client)
{
if (WelcomeTimers[client] != INVALID_HANDLE)
{
KillTimer(WelcomeTimers[client])
WelcomeTimers[client] = INVALID_HANDLE
}
}

public Action:WelcomePlayer(Handle:timer, Handle:pack)
{
decl String:str[128]
new client

/* Set to the beginning and unpack it */
ResetPack(pack)
client = ReadPackCell(pack)
ReadPackString(pack, str, sizeof(str))

PrintToConsole(client, "%s", str)
WelcomeTimers[client] = INVALID_HANDLE
}</pawn>

=Notes=
==Accuracy==
The smallest possible interval is 0.1 seconds. Timers have high precision (floating point) but low accuracy, as the current time is based on the in-game tick count, not the system clock. This has two implications:
*If the server is paused (not ticking or hibernating), timers will not run.
*The server will not always tick at an exact interval.

For example, a 1.234 second interval timer starting from time <tt>t</tt> might not tick until <tt>t+1.242</tt> at a tickrate of 66 ticks per second.

==Timer Death==
All timers are guaranteed to die either by:
*<tt>CloseHandle()</tt> being called (or on plugin unload);
*<tt>KillTimer()</tt> being called;
*<tt>Plugin_Stop</tt> being returned from a repeatable timer;
*<tt>TriggerTimer()</tt> being called on a one-time timer;
*Execution of a one-time timer finishes.

When a timer dies, if <tt>TIMER_HNDL_CLOSE</tt> is set, the Handle will always be closed with the permissions that <tt>CloseHandle()</tt> uses by default. Since timers cannot be cloned, there should be no ownership issues.

==Changing Intervals==
The interval of a timer cannot be changed as of this writing. The timer must be killed and a new one created.

==AMX Mod X==
Unlike [[AMX Mod X]]'s <tt>set_task</tt> function, you cannot pass arrays using <tt>CreateTimer</tt>. To accomplish this, you should use the data pack functionality explained above.

Similarly, there are no flags for counted repeats (non-infinite loops) or timers based on the map start or end. These must be done manually.

=External Links=
*[http://www.sourcemod.net/devlog/?p=130 On Timer Design, Part 3] (SourceMod DevLog)
*[http://www.sourcemod.net/devlog/?p=119 On Timer Design, Part 2] (SourceMod DevLog)
*[http://www.sourcemod.net/devlog/?p=118 On Timer Design, Part 1] (SourceMod DevLog)

[[Category:SourceMod Scripting]]

{{LanguageSwitch}}

Optional Requirements (SourceMod Scripting)

2014-02-10T14:00:43Z

Peace-Maker:

Normally, if you use natives from an extension or another plugin, your plugin will not load unless those natives exist. However, it is possible to make your dependencies "optional." This article details how.

=Disabling Requirements=
==Extensions==
To disable an extension being marked as "required," remove the <tt>REQUIRE_EXTENSIONS</tt> define. For example:

<pawn>#include <sourcemod>
#undef REQUIRE_EXTENSIONS
#include <sdktools></pawn>

Note that any extensions included after the <tt>#undef</tt> will also be marked as not required. Thus, you may need to move the include down, or do something like:

<pawn>#include <sourcemod>
#undef REQUIRE_EXTENSIONS
#include <sdktools>
#define REQUIRE_EXTENSIONS</pawn>

==Plugins==
To disable an plugin being marked as "required," remove the <tt>REQUIRE_PLUGIN</tt> define. For example:

<pawn>#include <sourcemod>
#undef REQUIRE_PLUGIN
#include <ircrelay></pawn>

Note that any plugins included after the <tt>#undef</tt> will also be marked as not required. Thus, you may need to move the include down, or do something like:

<pawn>#include <sourcemod>
#undef REQUIRE_PLUGIN
#include <ircrelay>
#define REQUIRE_PLUGIN</pawn>

==Optional Natives==
To mark a native as optional, use <tt>MarkNativeAsOptional</tt>. It should be called in <tt>AskPluginLoad2</tt>. For example:

<pawn>public APLRes:AskPluginLoad2(Handle:myself, bool:late, String:error[], err_max)
{
MarkNativeAsOptional("SDKCall");
return APLRes_Success;
}</pawn>

=Checking Optional Dependencies=
If you use a plugin or extension as an optional dependency, you may need to check whether it exists. For example, let's say we're relying on a plugin with the library name of "ircrelay." The way to always know whether ircrelay is loaded (and working) is:

<pawn>new bool:ircrelay = false;

public OnAllPluginsLoaded()
{
ircrelay = LibraryExists("ircrelay");
}

public OnLibraryRemoved(const String:name[])
{
if (StrEqual(name, "ircrelay"))
{
ircrelay = false;
}
}

public OnLibraryAdded(const String:name[])
{
if (StrEqual(name, "ircrelay"))
{
ircrelay = true;
}
}</pawn>

=Creating a Dependency=
Allowing other plugins to use your plugin as a library requires making an include file with two structures (the second of which is optional). The first structure must look like this:

<pawn>public SharedPlugin:__pl_myfile =
{
name = "myfile",
file = "myfile.smx",
#if defined REQUIRE_PLUGIN
required = 1,
#else
required = 0,
#endif
};</pawn>

The basic format is:
*The variable name MUST start with <tt>__pl_</tt> and must end with a unique string.
*The "name" portion is treated as the library name and must be unique.
*The filename must match the filename of the plugin implementing the library.
*The requirement portion should remain unchanged in order to maintain standards.

Additionally, you should expose a function which marks all of your natives as optional. You can do this by:
<pawn>#if !defined REQUIRE_PLUGIN
public __pl_myfile_SetNTVOptional()
{
MarkNativeAsOptional("native1");
MarkNativeAsOptional("native2");
MarkNativeAsOptional("native3");
}
#endif</pawn>

This function will be secretly called before the plugin loads (if and only if the requirement is optional), thus allowing seamless optional usage by third party developers. Note that the <tt>__pl_</tt> and <tt>_SetNTVOptional</tt> portions must be present, and that everything in between must match the ending of <tt>__pl_</tt> for the <tt>SharedPlugin</tt> structure.

You also must register the library name with SourceMod -- again this should be the unique string. This should be done inside the <code>AskPluginLoad2</code> function.

<pawn>
public APLRes:AskPluginLoad2(Handle:myself, bool:late, String:error[], err_max)
{
//... code here ...
RegPluginLibrary("myfile");

return APLRes_Success;
}
</pawn>

= Full Example =
;''Bounty: bounty.sp''
<pawn>
#include <sourcemod>
#undef REQUIRE_PLUGIN
#include <ircrelay>
</pawn>
;''Bounty: bounty.config.sp''
<pawn>
new bool:plugin_IrcRelay = LibraryExists("ircrelay");
if ((BountyIRC) && (plugin_IrcRelay))
{
RegisterIrcCommand("!bounty", "x", Irc_ViewBounty);
IrcMessage(CHAN_MASTER, "IRC Bounty Running!");
} else {
if ((BountyIRC) && (!plugin_IrcRelay))
{
BountyConsole_Debug("%t", "Bounty IRC Relay failed");
}
}
</pawn>
;''IRC Relay: ircrelay.sp''
<pawn>
public APLRes:AskPluginLoad2(Handle:myself, bool:late, String:error[], err_max)
{
//... code here ...
RegPluginLibrary("ircrelay");

return APLRes_Success;
}
</pawn>
;''IRC Relay: ircrelay.inc''
<pawn>
public SharedPlugin:__pl_ircrelay =
{
name = "ircrelay",
file = "ircrelay.smx",
#if defined REQUIRE_PLUGIN
required = 1,
#else
required = 0,
#endif
};

#if !defined REQUIRE_PLUGIN
public __pl_ircrelay_SetNTVOptional()
{
MarkNativeAsOptional("IrcMessage");
MarkNativeAsOptional("RegisterIrcCommand");
MarkNativeAsOptional("IrcGetCmdArgc");
MarkNativeAsOptional("IrcGetCmdArgv");
}
#endif
</pawn>
The <code>name</code> value is what will be checked when you run <code>LibraryExists</code>. This allows the bounty script to fully work, even if the IRC relay plugin is not installed and/or running correctly on your server.

[[Category:SourceMod Scripting]]

Admin Menu (SourceMod Scripting)

2014-02-10T13:48:14Z

Peace-Maker:

The admin menu is a menu available to all in-game administrators. It is a simple, one-level, category-based menu with heavy focus on consistency. The menu is simply a <tt>TopMenu</tt>, from the TopMenus extension, and is provided by <tt>adminmenu.sp</tt>.

The menu itself has no items unless external plugins provide them. Thus, it is possible (and recommended) for third party developers to extend the menu by attaching their own functionality to it. This requires a bit of patience, but this article documents most of the steps necessary.

=Menu Organization=
The menu is organized into ''categories'' and ''items''. Categories are top-level selections on the menu. Items are selectable entries inside categories. There are two important rules:
*There is no nesting. Categories cannot have sub-categories.
*Only categories can exist at the top level (i.e. items must have a parent category).

All entries on the menu, be they categories or items, are called ''top menu objects'', and each must have a unique name. For simplicity, the default admin menu entries use their respective command names as unique names, however this style is not required or enforced.

Unique names are used to identify items for sorting. For more information, see [[Admin Menu Configuration (SourceMod)|Admin Menu Configuration]].

=Interfacing to the Admin Menu=
The admin menu plugin can be loaded or unloaded at any time, and accounting for this in your code is important. Generally, you must account for the following cases:
*The admin menu is unloaded while you are interfaced to it.
*The admin menu is loaded while your plugin is already loaded.
*The admin menu is loaded before your plugin is loaded.

You do not need to remove menu items; they are removed automatically when your plugin is unloaded, and temporarily removed while your plugin is paused.

Example code is below:
<pawn>
#include <sourcemod>

/* Make the admin menu plugin optional */
#undef REQUIRE_PLUGIN
#include <adminmenu>

/* Keep track of the top menu */
new Handle:hAdminMenu = INVALID_HANDLE

public OnPluginStart()
{
/* See if the menu plugin is already ready */
new Handle:topmenu;
if (LibraryExists("adminmenu") && ((topmenu = GetAdminTopMenu()) != INVALID_HANDLE))
{
/* If so, manually fire the callback */
OnAdminMenuReady(topmenu);
}
}

public OnLibraryRemoved(const String:name[])
{
if (StrEqual(name, "adminmenu"))
{
hAdminMenu = INVALID_HANDLE;
}
}

public OnAdminMenuReady(Handle:topmenu)
{
/* Try to add the category first, if we want to add one.
Leave this out, if you don't add a new category. */
if(obj_dmcommands == INVALID_TOPMENUOBJECT)
{
OnAdminMenuCreated(topmenu);
}

/* Block us from being called twice */
if (topmenu == hAdminMenu)
{
return;
}

hAdminMenu = topmenu;

/* :TODO: Add everything to the menu! */
}</pawn>

=Top Menu Objects=
Top Menu Objects are entries, either categories or items, on the admin menu (or any top menu). Each has the following properties:
*<tt>ID</tt> (OUTPUT): The ID of the object in memory.
*<tt>Name</tt> (INPUT): The unique name of the object.
*<tt>Type</tt> (INPUT): Either a category or an item.
*<tt>Handler</tt> (INPUT): The callback function.
*<tt>Parent</tt> (INPUT): Empty for categories, or a category object ID for an item.
*<tt>Override</tt> (INPUT): The name of the override associated with the command. For more information, see [[Overriding Command Access (SourceMod)|Overriding Command Access]]. Overrides don't need to be a command name.
*<tt>Flags</tt> (INPUT): Default admin flags that should be associated with the object if the override is not set.

The callback determines how the object is drawn on the menu. If no flags are specified, the item is usable by any admin. If an admin does not have access to an object (including an entire category), it will not be displayed.

=Adding Categories=
Adding categories is sometimes beneficial for larger plugins with many commands. A category object receives two TopMenuAction callbacks:
*<tt>TopMenuAction_DisplayOption</tt> - The category is being displayed.
*<tt>TopMenuAction_DisplayTitle</tt> - The category is being displayed as a title.

For example, let's create a category called "CS:S DM Commands".

<pawn>
new TopMenuObject:obj_dmcommands;

public OnAdminMenuCreated(Handle:topmenu)
{
/* Block us from being called twice */
if (topmenu == hAdminMenu && obj_dmcommands != INVALID_TOPMENUOBJECT)
{
return;
}

obj_dmcommands = AddToTopMenu(topmenu,
"CS:S DM Commands",
TopMenuObject_Category,
CategoryHandler,
INVALID_TOPMENUOBJECT);
}

public CategoryHandler(Handle:topmenu,
TopMenuAction:action,
TopMenuObject:object_id,
param,
String:buffer[],
maxlength)
{
if (action == TopMenuAction_DisplayTitle)
{
Format(buffer, maxlength, "CS:S DM Commands:");
}
else if (action == TopMenuAction_DisplayOption)
{
Format(buffer, maxlength, "CS:S DM Commands");
}
}</pawn>

Note that a callback can handle more than one category. If that is the desired functionality, you can use the <tt>TopMenuObject</tt> value to see which object is being drawn.

=Adding Items=
Items are different from categories in that their selection can be detected. They must have a parent category. The code below shows an example of finding an existing category and adding an item to it.

<pawn>
AttachAdminMenu()
{
/* If the category is third party, it will have its own unique name. */
new TopMenuObject:player_commands = FindTopMenuCategory(hAdminMenu, ADMINMENU_PLAYERCOMMANDS);

if (player_commands == INVALID_TOPMENUOBJECT)
{
/* Error! */
return;
}

AddToTopMenu(hAdminMenu,
"sm_poke",
TopMenuObject_Item,
AdminMenu_Poke,
player_commands,
"sm_poke",
ADMFLAG_SLAY);
}

public AdminMenu_Poke(Handle:topmenu,
TopMenuAction:action,
TopMenuObject:object_id,
param,
String:buffer[],
maxlength)
{
if (action == TopMenuAction_DisplayOption)
{
Format(buffer, maxlength, "Poke");
}
else if (action == TopMenuAction_SelectOption)
{
/* Do something! client who selected item is in param */
}
}</pawn>

Note that a callback can handle more than one item. If that is the desired functionality, you can use the <tt>TopMenuObject</tt> value to see which object is being drawn.

=Returning to the Menu=
Sometimes it is desirable to re-display the admin menu to the client. This can be achievied via <tt>RedisplayAdminMenu</tt> in <tt>adminmenu.inc</tt>.

[[Category:SourceMod Scripting]]

Admin Menu (SourceMod Scripting)

2014-02-10T13:47:34Z

Peace-Maker: Fixup example code

The admin menu is a menu available to all in-game administrators. It is a simple, one-level, category-based menu with heavy focus on consistency. The menu is simply a <tt>TopMenu</tt>, from the TopMenus extension, and is provided by <tt>adminmenu.sp</tt>.

The menu itself has no items unless external plugins provide them. Thus, it is possible (and recommended) for third party developers to extend the menu by attaching their own functionality to it. This requires a bit of patience, but this article documents most of the steps necessary.

=Menu Organization=
The menu is organized into ''categories'' and ''items''. Categories are top-level selections on the menu. Items are selectable entries inside categories. There are two important rules:
*There is no nesting. Categories cannot have sub-categories.
*Only categories can exist at the top level (i.e. items must have a parent category).

All entries on the menu, be they categories or items, are called ''top menu objects'', and each must have a unique name. For simplicity, the default admin menu entries use their respective command names as unique names, however this style is not required or enforced.

Unique names are used to identify items for sorting. For more information, see [[Admin Menu Configuration (SourceMod)|Admin Menu Configuration]].

=Interfacing to the Admin Menu=
The admin menu plugin can be loaded or unloaded at any time, and accounting for this in your code is important. Generally, you must account for the following cases:
*The admin menu is unloaded while you are interfaced to it.
*The admin menu is loaded while your plugin is already loaded.
*The admin menu is loaded before your plugin is loaded.

You do not need to remove menu items; they are removed automatically when your plugin is unloaded, and temporarily removed while your plugin is paused.

Example code is below:
<pawn>
#include <sourcemod>

/* Make the admin menu plugin optional */
#undef REQUIRE_PLUGIN
#include <adminmenu>

/* Keep track of the top menu */
new Handle:hAdminMenu = INVALID_HANDLE

public OnPluginStart()
{
/* See if the menu plugin is already ready */
new Handle:topmenu;
if (LibraryExists("adminmenu") && ((topmenu = GetAdminTopMenu()) != INVALID_HANDLE))
{
/* If so, manually fire the callback */
OnAdminMenuReady(topmenu);
}
}

public OnLibraryRemoved(const String:name[])
{
if (StrEqual(name, "adminmenu"))
{
hAdminMenu = INVALID_HANDLE;
}
}

public OnAdminMenuReady(Handle:topmenu)
{
/* Try to add the category first, if we want to add one.
Leave this out, if you don't add a new category. */
if(obj_dmcommands == INVALID_TOPMENUOBJECT)
{
OnAdminMenuCreated(topmenu);
}

/* Block us from being called twice */
if (topmenu == hAdminMenu)
{
return;
}

hAdminMenu = topmenu;

/* :TODO: Add everything to the menu! */
}</pawn>

=Top Menu Objects=
Top Menu Objects are entries, either categories or items, on the admin menu (or any top menu). Each has the following properties:
*<tt>ID</tt> (OUTPUT): The ID of the object in memory.
*<tt>Name</tt> (INPUT): The unique name of the object.
*<tt>Type</tt> (INPUT): Either a category or an item.
*<tt>Handler</tt> (INPUT): The callback function.
*<tt>Parent</tt> (INPUT): Empty for categories, or a category object ID for an item.
*<tt>Override</tt> (INPUT): The name of the override associated with the command. For more information, see [[Overriding Command Access (SourceMod)|Overriding Command Access]]. Overrides don't need to be a command name.
*<tt>Flags</tt> (INPUT): Default admin flags that should be associated with the object if the override is not set.

The callback determines how the object is drawn on the menu. If no flags are specified, the item is usable by any admin. If an admin does not have access to an object (including an entire category), it will not be displayed.

=Adding Categories=
Adding categories is sometimes beneficial for larger plugins with many commands. A category object receives two TopMenuAction callbacks:
*<tt>TopMenuAction_DisplayOption</tt> - The category is being displayed.
*<tt>TopMenuAction_DisplayTitle</tt> - The category is being displayed as a title.

For example, let's create a category called "CS:S DM Commands".

<pawn>
new TopMenuObject:obj_dmcommands;

public OnAdminMenuCreated(Handle:topmenu)
{
/* Block us from being called twice */
if (topmenu == hAdminMenu && obj_dmcommands != INVALID_TOPMENUOBJECT)
{
return;
}

obj_dmcommands = AddToTopMenu(hAdminMenu,
"CS:S DM Commands",
TopMenuObject_Category,
CategoryHandler,
INVALID_TOPMENUOBJECT);
}

public CategoryHandler(Handle:topmenu,
TopMenuAction:action,
TopMenuObject:object_id,
param,
String:buffer[],
maxlength)
{
if (action == TopMenuAction_DisplayTitle)
{
Format(buffer, maxlength, "CS:S DM Commands:");
}
else if (action == TopMenuAction_DisplayOption)
{
Format(buffer, maxlength, "CS:S DM Commands");
}
}</pawn>

Note that a callback can handle more than one category. If that is the desired functionality, you can use the <tt>TopMenuObject</tt> value to see which object is being drawn.

=Adding Items=
Items are different from categories in that their selection can be detected. They must have a parent category. The code below shows an example of finding an existing category and adding an item to it.

<pawn>
AttachAdminMenu()
{
/* If the category is third party, it will have its own unique name. */
new TopMenuObject:player_commands = FindTopMenuCategory(hAdminMenu, ADMINMENU_PLAYERCOMMANDS);

if (player_commands == INVALID_TOPMENUOBJECT)
{
/* Error! */
return;
}

AddToTopMenu(hAdminMenu,
"sm_poke",
TopMenuObject_Item,
AdminMenu_Poke,
player_commands,
"sm_poke",
ADMFLAG_SLAY);
}

public AdminMenu_Poke(Handle:topmenu,
TopMenuAction:action,
TopMenuObject:object_id,
param,
String:buffer[],
maxlength)
{
if (action == TopMenuAction_DisplayOption)
{
Format(buffer, maxlength, "Poke");
}
else if (action == TopMenuAction_SelectOption)
{
/* Do something! client who selected item is in param */
}
}</pawn>

Note that a callback can handle more than one item. If that is the desired functionality, you can use the <tt>TopMenuObject</tt> value to see which object is being drawn.

=Returning to the Menu=
Sometimes it is desirable to re-display the admin menu to the client. This can be achievied via <tt>RedisplayAdminMenu</tt> in <tt>adminmenu.inc</tt>.

[[Category:SourceMod Scripting]]

Vice keys

2012-10-13T21:47:23Z

Peace-Maker:

VICE keys are used to encrypt the game's weapon config files in an effort to make them more difficult to tamper with. It's not really a great protection, as usually the key is just hardcoded into the server binaries. Some games, such as Golden Eye Source, try to make it more difficult to retrieve these, but even then it's trivial.

These keys can be used to decrypt the CTX files that many games provide.

{|
!width="300"| Game
!width="100"| Key
|-
| Counter-Strike: Source / Global Offensive
| d7NSuLq2
|-
| CSPromod
| H1aRQ0n1
|-
| Day of Defeat: Source
| Wl0u5B3F
|-
| Dystopia (1.2?)
| pH3apO8w
|-
| Dystopia 1.3 RC2
| G8stUh3F
|-
| Golden Eye Source
| Gr3naDes
|-
| Half-Life 2: Deathmatch
| x9Ke0BY7
|-
| Insurgency
| DrA5e3EB
|-
| Left 4 Dead 2 (VScript .nuc)
| SDhfi878
|-
| Nuclear Dawn
| TA+*veh9
|-
| TF2 (items.ctx)
| A5fSXbf7
|-
| TF2 (everything else)
| E2NcUkG2
|-
| ZPS
| 5R0ni0pZ
|}

Vice keys

2012-10-13T21:46:35Z

Peace-Maker:

VICE keys are used to encrypt the game's weapon config files in an effort to make them more difficult to tamper with. It's not really a great protection, as usually the key is just hardcoded into the server binaries. Some games, such as Golden Eye Source, try to make it more difficult to retrieve these, but even then it's trivial.

These keys can be used to decrypt the CTX files that many games provide.

{|
!width="300"| Game
!width="100"| Key
|-
| Counter-Strike: Source / Global Offensive
| d7NSuLq2
|-
| CSPromod
| H1aRQ0n1
|-
| Day of Defeat: Source
| Wl0u5B3F
|-
| Dystopia (1.2?)
| pH3apO8w
|-
| Dystopia 1.3 RC2
| G8stUh3F
|-
| Golden Eye Source
| Gr3naDes
|-
| Half-Life 2: Deathmatch
| x9Ke0BY7
|-
| Insurgency
| DrA5e3EB
|-
| Left 4 Dead 2 (VScript .nuc)
| SDhfi878
|-
| TF2 (items.ctx)
| A5fSXbf7
|-
| TF2 (everything else)
| E2NcUkG2
|-
| ZPS
| 5R0ni0pZ
|-
| Nuclear Dawn
| TA+*veh9
|}

Adding Groups (SourceMod)

2012-09-20T22:42:46Z

Peace-Maker:

This article explains how to add and configure groups through <tt>configs/admin_groups.cfg</tt>. This file is parsed and loaded via <tt>admin-flatfile.smx</tt>.

=Introduction=
Groups are a convenient method of applying similar properties and permissions to multiple administrators. For example, let's say you wish for 15 administrators to all have the same permissions and immunity. In this case, you'd set up a group for these admins, after which changing the permissions for all member admins can be done via one location.

=File Format=
Groups are specified as blocks within a master "Group" block. Each group must have a unique name. If the name is not unique, the permissions will simply be extended/overwritten from the permissions of the existing group. That is to say, if a group exists in both the config file and an external source (say, SQL), then the permissions will end up being combined/overwritten in the order of parsing. You can create and / or modify <tt>admin_groups.cfg</tt> files with [http://forums.alliedmods.net/showthread.php?t=81160 KVManager].

The group blocks appear in this format:
<pre>
"Groups"
{
"Group Name"
{
"[option1]" "[value1]"
"[option2]" "[value2]"
/* ... */
"Overrides"
{
"[override1]" "[allow|deny]"
"[override2]" "[allow|deny]"
/* ... */
}
}
}
</pre>

All options are optional (that is, they do not need to be explicitly defined). Similarly, the "Overrides" section is completely optional and may be omitted. The full options list contains:
*<tt>flags</tt>: Flag string that users of the group will inherit.
*<tt>immunity</tt>: If a numerical value, specifies the immunity value users will inherit if higher than their current immunity value. If preceded by an '@' symbol, then it specifies a group that the user will always be immune from.

The "Overrides" section allows specific commands or groups of commands to be completely allowed or denied to members of the group. This is a very powerful section. For example, you can opt to not give members the "map" flag, but allow them access to <tt>sm_map</tt>. Conversely, you could opt to give members the "map" flag, but deny them access to <tt>sm_map</tt>.

Command groups are explained further in the [[Overriding Command Access (SourceMod)]] article.

Combined example of a group with overrides:
<pre>
"Groups"
{
"Basic Admin"
{
"flags" "abc" //reservation, generic admin, kick
"immunity" "1" //low immunity value

"Overrides"
{
"sm_map" "allow" //Let them use sm_map even without the flag
"@CSDM" "deny" //deny any commands from the CSDM group
}
}
}</pre>

=Inheritance=
Groups cannot be nested; that is to say, one group cannot inherit permissions from another group. However, an administrator can inherit any number of groups. The permissions will be <tt>additive</tt>, meaning that they will be assumed if and only if they result in more permissions being granted.

For example, if a user has flags <tt>bcd</tt> and a group assigns flags <tt>ae</tt>, inheritance would result in that user having the flags <tt>abcde</tt>. Similarly, a group's immunity value will only be inherited if it is larger than the user's current immunity value.

The only case this changes is with group-specific overrides. If a command is specifically allowed to group A and denied in group B, and a user inherits both groups A and B, whether or not the user can use the command will depend on the order of inheritance. If A is inherited first, the command will be allowed. If B is inherited first, the command will be denied.

Lastly, it is worth noting that once a user inherits permissions from a group, changes to the group will not affect the active permissions. This is an optimization. In order for changes to groups to affect that user, their administrative permissions must be entirely reset (either by a disconnect, or via <tt>sm_reloadadmins</tt>, which effectively reloads all permissions anyway).

=See Also=
*[[Overriding Command Access (SourceMod)]]

[[Category:SourceMod Documentation]]

Adding Groups (SourceMod)

2012-09-06T20:04:51Z

Peace-Maker:

This article explains how to add and configure groups through <tt>configs/admin_groups.cfg</tt>. This file is parsed and loaded via <tt>admin-flatfile.smx</tt>.

=Introduction=
Groups are a convenient method of applying similar properties and permissions to multiple administrators. For example, let's say you wish for 15 administrators to all have the same permissions and immunity. In this case, you'd set up a group for these admins, after which changing the permissions for all member admins can be done via one location.

=File Format=
Groups are specified as blocks within a master "Group" block. Each group must have a unique name. If the name is not unique, the permissions will simply be extended/overwritten from the permissions of the existing group. That is to say, if a group exists in both the config file and an external source (say, SQL), then the permissions will end up being combined/overwritten in the order of parsing. You can create and / or modify <tt>admin_groups.cfg</tt> files with [http://forums.alliedmods.net/showthread.php?t=81160 KVManager].

The group blocks appear in this format:
<pre>
Groups
{
"Group Name"
{
"[option1]" "[value1]"
"[option2]" "[value2]"
/* ... */
Overrides
{
"[override1]" "[allow|deny]"
"[override2]" "[allow|deny]"
/* ... */
}
}
}
</pre>

All options are optional (that is, they do not need to be explicitly defined). Similarly, the "Overrides" section is completely optional and may be omitted. The full options list contains:
*<tt>flags</tt>: Flag string that users of the group will inherit.
*<tt>immunity</tt>: If a numerical value, specifies the immunity value users will inherit if higher than their current immunity value. If preceded by an '@' symbol, then it specifies a group that the user will always be immune from.

The "Overrides" section allows specific commands or groups of commands to be completely allowed or denied to members of the group. This is a very powerful section. For example, you can opt to not give members the "map" flag, but allow them access to <tt>sm_map</tt>. Conversely, you could opt to give members the "map" flag, but deny them access to <tt>sm_map</tt>.

Command groups are explained further in the [[Overriding Command Access (SourceMod)]] article.

Combined example of a group with overrides:
<pre>
Groups
{
"Basic Admin"
{
"flags" "abc" //reservation, generic admin, kick
"immunity" "1" //low immunity value

Overrides
{
"sm_map" "allow" //Let them use sm_map even without the flag
"@CSDM" "deny" //deny any commands from the CSDM group
}
}
}</pre>

=Inheritance=
Groups cannot be nested; that is to say, one group cannot inherit permissions from another group. However, an administrator can inherit any number of groups. The permissions will be <tt>additive</tt>, meaning that they will be assumed if and only if they result in more permissions being granted.

For example, if a user has flags <tt>bcd</tt> and a group assigns flags <tt>ae</tt>, inheritance would result in that user having the flags <tt>abcde</tt>. Similarly, a group's immunity value will only be inherited if it is larger than the user's current immunity value.

The only case this changes is with group-specific overrides. If a command is specifically allowed to group A and denied in group B, and a user inherits both groups A and B, whether or not the user can use the command will depend on the order of inheritance. If A is inherited first, the command will be allowed. If B is inherited first, the command will be denied.

Lastly, it is worth noting that once a user inherits permissions from a group, changes to the group will not affect the active permissions. This is an optimization. In order for changes to groups to affect that user, their administrative permissions must be entirely reset (either by a disconnect, or via <tt>sm_reloadadmins</tt>, which effectively reloads all permissions anyway).

=See Also=
*[[Overriding Command Access (SourceMod)]]

[[Category:SourceMod Documentation]]

Timers (SourceMod Scripting)

2012-07-18T16:38:54Z

Peace-Maker: Reset the static var, if you want to rerun the timer!

Timers in [[SourceMod]] are timed events that occur once or repeatedly at a given interval.

=Introduction=
Timers allow you to set an interval, a function to use as the event callback, and an optional Handle to pass through the callback. This is useful for saving data asynchronously.

All timer functions are in <tt>plugins/include/timers.inc</tt>.

=Basic Usage=
==One-Time Timers==
One-time timers are timers that only execute once. An example of a one-time timer might look like:

<pawn>public OnPluginStart()
{
CreateTimer(5.0, LoadStuff)
}

public Action:LoadStuff(Handle:timer)
{
PrintToServer("Loading stuff!")
}</pawn>

This code will print "Loading stuff!" to the server console five seconds after the map loads. The return value has no meaning for one-time timers.

==Repeatable Timers==
Repeatable timers execute infinitely many times, once every interval. Based on the return value, they either continue or cancel.

For example, say you want to display a message five times, once every three seconds:
<pawn>
someFunction()
{
CreateTimer(3.0, Timer_PrintMessageFiveTimes, _, TIMER_REPEAT);
}

public Action:Timer_PrintMessageFiveTimes(Handle:timer)
{
// Create a global variable visible only in the local scope (this function).
static numPrinted = 0;

if (numPrinted >= 5) {
numPrinted = 0;
return Plugin_Stop;
}

PrintToServer("Warning! This is a message.");
numPrinted++;

return Plugin_Continue;
}</pawn>

Note that <tt>Plugin_Stop</tt> stops the timer, and <tt>Plugin_Continue</tt> allows it to continue repeating.

=Passing Data=
==Simple Values==
As mentioned earlier, timers let you pass values on to the callback function. This value can be any type. For example, let's say we want to print a message to a player fifteen seconds after they connect. However, we want to cancel the timer if the player disconnects. Implementing this is very easy:

<pawn>
new Handle:WelcomeTimers[MAXPLAYERS+1]

public OnClientPutInServer(client)
{
WelcomeTimers[client] = CreateTimer(15.0, WelcomePlayer, client)
}

public OnClientDisconnect(client)
{
if (WelcomeTimers[client] != INVALID_HANDLE)
{
KillTimer(WelcomeTimers[client])
WelcomeTimers[client] = INVALID_HANDLE
}
}

public Action:WelcomePlayer(Handle:timer, any:client)
{
PrintToConsole(client, "Welcome to the server!")
WelcomeTimers[client] = INVALID_HANDLE
}</pawn>

==Handles==
If you want to pass a Handle as a value, you have the option of using <tt>TIMER_HNDL_CLOSE</tt>, which will automatically call <tt>CloseHandle()</tt> for you once the timer dies.

==Data Packs==
Data packs are packable structures that can be used to hold asynchronous data (data that must be saved and unpacked for later). They are especially useful for timers, and thus there exists a helper function, called <tt>CreateDataTimer()</tt>, which creates a timer using a data pack handle. The handle is created and closed automatically for you.

The above example could be rewritten as:
<pawn>
new Handle:WelcomeTimers[MAXPLAYERS+1]

public OnClientPutInServer(client)
{
new Handle:pack
WelcomeTimers[client] = CreateDataTimer(15.0, WelcomePlayer, pack)
WritePackCell(pack, client)
WritePackString(pack, "Welcome to the server!")
}

public OnClientDisconnect(client)
{
if (WelcomeTimers[client] != INVALID_HANDLE)
{
KillTimer(WelcomeTimers[client])
WelcomeTimers[client] = INVALID_HANDLE
}
}

public Action:WelcomePlayer(Handle:timer, Handle:pack)
{
decl String:str[128]
new client

/* Set to the beginning and unpack it */
ResetPack(pack)
client = ReadPackCell(pack)
ReadPackString(pack, str, sizeof(str))

PrintToConsole(client, "%s", str)
WelcomeTimers[client] = INVALID_HANDLE
}</pawn>

=Notes=
==Accuracy==
The smallest possible interval is 0.1 seconds. Timers have high precision (floating point) but low accuracy, as the current time is based on the in-game tick count, not the system clock. This has two implications:
*If the server is paused (not ticking), timers will not run.
*The server will not always tick at an exact interval.

For example, a 1.234 second interval timer starting from time <tt>t</tt> might not tick until <tt>t+1.242</tt> at a tickrate of 66 ticks per second.

==Timer Death==
All timers are guaranteed to die either by:
*<tt>CloseHandle()</tt> being called (or on plugin unload);
*<tt>KillTimer()</tt> being called;
*<tt>Plugin_Stop</tt> being returned from a repeatable timer;
*<tt>TriggerTimer()</tt> being called on a one-time timer;
*Execution of a one-time timer finishes.

When a timer dies, if <tt>TIMER_HNDL_CLOSE</tt> is set, the Handle will always be closed with the permissions that <tt>CloseHandle()</tt> uses by default. Since timers cannot be cloned, there should be no ownership issues.

==Changing Intervals==
The interval of a timer cannot be changed as of this writing. The timer must be killed and a new one created.

==AMX Mod X==
Unlike [[AMX Mod X]]'s <tt>set_task</tt> function, you cannot pass arrays using <tt>CreateTimer</tt>. To accomplish this, you should use the data pack functionality explained above.

Similarly, there are no flags for counted repeats (non-infinite loops) or timers based on the map start or end. These must be done manually.

=External Links=
*[http://www.sourcemod.net/devlog/?p=130 On Timer Design, Part 3] (SourceMod DevLog)
*[http://www.sourcemod.net/devlog/?p=119 On Timer Design, Part 2] (SourceMod DevLog)
*[http://www.sourcemod.net/devlog/?p=118 On Timer Design, Part 1] (SourceMod DevLog)

[[Category:SourceMod Scripting]]

{{LanguageSwitch}}

Nuclear Dawn Events

2012-02-03T11:11:40Z

Peace-Maker:

:''Refer back to [[Game Events (Source)]] for more events.''

=== player_death ===
{{qnotice|}} 
{{begin-hl2msg|player_death|string}}
{{hl2msg|short|userid|user ID who died}}
{{hl2msg|short|attacker|user ID who killed}}
{{hl2msg|string|weapon|weapon name killed used}}
{{hl2msg|short|weaponid|weapon id}}
{{hl2msg|long|damagebits|bits}}
{{hl2msg|long|customkill|custom bits}}
{{hl2msg|short|priority|}}
{{end-hl2msg}}
=== player_hurt ===
{{qnotice|}} 
{{begin-hl2msg|player_hurt|string}}
{{hl2msg|1|local|Not networked}}
{{hl2msg|short|userid|user ID who was hurt}}
{{hl2msg|short|attacker|user id who attacked}}
{{hl2msg|short|health|remaining health points}}
{{hl2msg|string|weapon|weapon name attacker used, if not the world}}
{{hl2msg|short|dmg_health|damage done to health}}
{{hl2msg|byte|hitgroup|hitgroup that was damaged}}
{{hl2msg|long|type|damage type}}
{{end-hl2msg}}
=== player_changeclass ===
{{qnotice|Called when a player changes class}} 
{{begin-hl2msg|player_changeclass|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|class|}}
{{hl2msg|short|subclass|}}
{{end-hl2msg}}
=== spec_target_updated ===
{{qnotice|}} 
{{begin-hl2msg|spec_target_updated|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== achievement_earned ===
{{qnotice|}} 
{{begin-hl2msg|achievement_earned|string}}
{{hl2msg|short|player|}}
{{hl2msg|short|achievement|}}
{{end-hl2msg}}
=== player_spawned_at_tgate ===
{{qnotice|}} 
{{begin-hl2msg|player_spawned_at_tgate|string}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}
=== structure_death ===
{{qnotice|fired when we sell a structure}} 
{{begin-hl2msg|structure_death|string}}
{{hl2msg|short|type|type of structure sold}}
{{hl2msg|short|team|the team the structure belonged to}}
{{hl2msg|short|entindex|The entidx of the structure}}
{{hl2msg|short|attacker|userid of attacking player}}
{{hl2msg|string|weapon|weapon name the attacker used}}
{{end-hl2msg}}
=== structure_damage_sparse ===
{{qnotice|is only fired for every 100hp taken. no spamz here}} 
{{begin-hl2msg|structure_damage_sparse|string}}
{{hl2msg|short|entindex|entity index of structure being damaged}}
{{hl2msg|short|ownerteam|team that owns the structure - Todo: optimize this out!}}
{{hl2msg|bool|bunker|was it the bunker?}}
{{hl2msg|local|userid|user id that damaged the structure}}
{{end-hl2msg}}
=== structure_sold ===
{{qnotice|fired when we sell a structure}} 
{{begin-hl2msg|structure_sold|string}}
{{hl2msg|short|type|type of structure sold}}
{{hl2msg|short|ownerteam|the team the structure belonged to}}
{{end-hl2msg}}
=== structure_fully_auto_repaired ===
{{qnotice|fired when a damaged structure gets healed to 100% hp using auto repair}} 
{{begin-hl2msg|structure_fully_auto_repaired|string}}
{{hl2msg|short|type|type of structure repaired}}
{{hl2msg|short|entindex|entity index of repaired structure}}
{{hl2msg|short|ownerteam|team that the structure belongs to}}
{{end-hl2msg}}
=== structure_fully_man_repaired ===
{{qnotice|fired when a damaged structure gets healed to 100% hp by supports}} 
{{begin-hl2msg|structure_fully_man_repaired|string}}
{{hl2msg|short|type|type of structure repaired}}
{{hl2msg|short|entindex|entity index of repaired structure}}
{{hl2msg|short|ownerteam|team that the structure belongs to}}
{{hl2msg|local|userid|user id that repaired the sturcture}}
{{end-hl2msg}}
=== structure_built ===
{{qnotice|structure fully built. fired client-side. commander only. same team.}} 
{{begin-hl2msg|structure_built|string}}
{{hl2msg|short|entindex|structure entity index}}
{{end-hl2msg}}
=== structure_power_outage ===
{{qnotice|structure out of power. fired client-side. commander only. same team.}} 
{{begin-hl2msg|structure_power_outage|string}}
{{hl2msg|short|entindex|structure entity index}}
{{end-hl2msg}}
=== resource_start_capture ===
{{qnotice|Used to show the capture hud panel}} 
{{begin-hl2msg|resource_start_capture|string}}
{{hl2msg|short|userid|user id that is starting the capture}}
{{hl2msg|short|entindex|resource point getting capped}}
{{hl2msg|short|type|type of resource point}}
{{hl2msg|short|capteam|team that is capping}}
{{hl2msg|short|ownerteam|team that currently owns the point (check for unassigned)}}
{{end-hl2msg}}
=== resource_end_capture ===
{{qnotice|Used to hide the capture hud panel}} 
{{begin-hl2msg|resource_end_capture|string}}
{{hl2msg|short|userid|user id that is starting the capture}}
{{hl2msg|short|entindex|resource point that got captured}}
{{end-hl2msg}}
=== resource_break_capture ===
{{qnotice|}} 
{{begin-hl2msg|resource_break_capture|string}}
{{hl2msg|short|entindex|}}
{{hl2msg|float|time_remaining|}}
{{end-hl2msg}}
=== resource_extract ===
{{qnotice|Resource point has extracted some resources}} 
{{begin-hl2msg|resource_extract|string}}
{{hl2msg|short|entindex|resource point that extracted the resources}}
{{hl2msg|short|amount|resource point that extracted the resources}}
{{end-hl2msg}}
=== resource_captured ===
{{qnotice|When a resource point gets fully captured by a team}} 
{{begin-hl2msg|resource_captured|string}}
{{hl2msg|short|entindex|entity index of the captrd point}}
{{hl2msg|short|type|the resource point type that got captured}}
{{hl2msg|short|team|team that captured the point}}
{{end-hl2msg}}
=== power_requested ===
{{qnotice|An entity is requesting a power connection}} 
{{begin-hl2msg|power_requested|string}}
{{hl2msg|short|teamid|The team who's power system got updated}}
{{hl2msg|short|entid|The entity index that is requesting a power connection}}
{{end-hl2msg}}
=== power_removed ===
{{qnotice|An entity is requesting a power connection}} 
{{begin-hl2msg|power_removed|string}}
{{hl2msg|short|teamid|The team who's power system got updated}}
{{hl2msg|short|entid|The entity index that is requesting a power connection}}
{{end-hl2msg}}
=== power_updated ===
{{qnotice|When the power nexus gets updated}} 
{{begin-hl2msg|power_updated|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== enter_pregame ===
{{qnotice|}} 
{{begin-hl2msg|enter_pregame|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== blueprint_update ===
{{qnotice|}} 
{{begin-hl2msg|blueprint_update|string}}
{{hl2msg|short|teamid|The team who's power system got updated}}
{{hl2msg|short|blueprint|The blueprint that is updated}}
{{hl2msg|short|state|1 = earned, 0 = not earned..}}
{{end-hl2msg}}
=== enter_vehicle ===
{{qnotice|}} 
{{begin-hl2msg|enter_vehicle|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|seat|}}
{{hl2msg|short|entidx|}}
{{end-hl2msg}}
=== exit_vehicle ===
{{qnotice|}} 
{{begin-hl2msg|exit_vehicle|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|seat|}}
{{hl2msg|short|entidx|}}
{{end-hl2msg}}
=== show_freezepanel ===
{{qnotice|}} 
{{begin-hl2msg|show_freezepanel|string}}
{{hl2msg|short|killer|entindex of the killer entity}}
{{end-hl2msg}}
=== hide_freezepanel ===
{{qnotice|}} 
{{begin-hl2msg|hide_freezepanel|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== freezecam_started ===
{{qnotice|}} 
{{begin-hl2msg|freezecam_started|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== spawn_map_changed ===
{{qnotice|Called when a tgate is built, removed, or power state changes}} 
{{begin-hl2msg|spawn_map_changed|string}}
{{hl2msg|short|teamid|}}
{{end-hl2msg}}
=== overviewmap_key_released ===
{{qnotice|}} 
{{begin-hl2msg|overviewmap_key_released|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== slot_key_pressed ===
{{qnotice|}} 
{{begin-hl2msg|slot_key_pressed|string}}
{{hl2msg|short|slot|}}
{{end-hl2msg}}
=== ironsight_key_pressed ===
{{qnotice|}} 
{{begin-hl2msg|ironsight_key_pressed|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== ability_key_pressed ===
{{qnotice|}} 
{{begin-hl2msg|ability_key_pressed|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== weapon_reload ===
{{qnotice|}} 
{{begin-hl2msg|weapon_reload|string}}
{{hl2msg|short|userid|}}
{{hl2msg|bool|manual|player manually started the reload}}
{{end-hl2msg}}
=== weapon_fire_at_40 ===
{{qnotice|}} 
{{begin-hl2msg|weapon_fire_at_40|string}}
{{hl2msg|short|userid|}}
{{hl2msg|string|weapon|used weapon name}}
{{hl2msg|short|weaponid|used weapon ID}}
{{hl2msg|short|count|number of bullets}}
{{end-hl2msg}}
=== entity_visible ===
{{qnotice|}} 
{{begin-hl2msg|entity_visible|string}}
{{hl2msg|short|userid|The player who sees the entity}}
{{hl2msg|long|subject|Entindex of the entity they see}}
{{hl2msg|string|classname|Classname of the entity they see}}
{{hl2msg|string|entityname|name of the entity they see}}
{{end-hl2msg}}
=== player_left_bunker_building ===
{{qnotice|}} 
{{begin-hl2msg|player_left_bunker_building|string}}
{{hl2msg|short|userid|The player who left the bunker}}
{{hl2msg|short|entidx|The bunker they left}}
{{end-hl2msg}}
=== player_entered_bunker_building ===
{{qnotice|}} 
{{begin-hl2msg|player_entered_bunker_building|string}}
{{hl2msg|short|userid|The player who entered the bunker}}
{{hl2msg|short|entidx|The bunker they entered}}
{{end-hl2msg}}
=== player_entered_commander_mode ===
{{qnotice|}} 
{{begin-hl2msg|player_entered_commander_mode|string}}
{{hl2msg|short|userid|Player who entered commander mode}}
{{end-hl2msg}}
=== player_enter_commander_mode_failed ===
{{qnotice|}} 
{{begin-hl2msg|player_enter_commander_mode_failed|string}}
{{hl2msg|short|userid|Player who tried to enter commander mode}}
{{end-hl2msg}}
=== player_left_commander_mode ===
{{qnotice|}} 
{{begin-hl2msg|player_left_commander_mode|string}}
{{hl2msg|short|userid|Player who left commander mode}}
{{end-hl2msg}}
=== player_restocked_from_supply_struct ===
{{qnotice|}} 
{{begin-hl2msg|player_restocked_from_supply_struct|string}}
{{hl2msg|short|userid|Player who was restocked}}
{{hl2msg|short|entidx|Entity they got supply from}}
{{end-hl2msg}}
=== player_opened_armoury_menu ===
{{qnotice|}} 
{{begin-hl2msg|player_opened_armoury_menu|string}}
{{hl2msg|short|userid|Player opened kit menu from armoury}}
{{end-hl2msg}}
=== commander_move_2d ===
{{qnotice|}} 
{{begin-hl2msg|commander_move_2d|string}}
{{hl2msg|1|local|Local only}}
{{hl2msg|short|userid|Player that moved the commander camera}}
{{end-hl2msg}}
=== commander_move_z ===
{{qnotice|}} 
{{begin-hl2msg|commander_move_z|string}}
{{hl2msg|1|local|Local only}}
{{hl2msg|short|userid|Player that moved the commander camera up/down}}
{{end-hl2msg}}
=== commander_minimap_move ===
{{qnotice|}} 
{{begin-hl2msg|commander_minimap_move|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|userid|Player that moved the commander camera}}
{{end-hl2msg}}
=== player_exited_tgate ===
{{qnotice|}} 
{{begin-hl2msg|player_exited_tgate|string}}
{{hl2msg|short|userid|Player that left the gate}}
{{end-hl2msg}}
=== commander_left_valid_area ===
{{qnotice|}} 
{{begin-hl2msg|commander_left_valid_area|string}}
{{hl2msg|short|userid|The commander that left valid "airspace"}}
{{end-hl2msg}}
=== commander_entered_valid_area ===
{{qnotice|}} 
{{begin-hl2msg|commander_entered_valid_area|string}}
{{hl2msg|short|userid|The commander that entered valid "airspace"}}
{{end-hl2msg}}
=== round_win ===
{{qnotice|}} 
{{begin-hl2msg|round_win|string}}
{{hl2msg|short|team|The winning team}}
{{hl2msg|short|type|Type of win}}
{{end-hl2msg}}
=== transport_gate_created ===
{{qnotice|}} 
{{begin-hl2msg|transport_gate_created|string}}
{{hl2msg|short|teamid|Team that created the gate}}
{{hl2msg|short|entindex|Entity id of the new gate}}
{{end-hl2msg}}
=== last_tgate_destroyed ===
{{qnotice|}} 
{{begin-hl2msg|last_tgate_destroyed|string}}
{{hl2msg|short|teamid|Team who's last tgate got pwnd}}
{{end-hl2msg}}
=== player_stats_updated ===
{{qnotice|}} 
{{begin-hl2msg|player_stats_updated|string}}
{{hl2msg|bool|forceupload|}}
{{end-hl2msg}}
=== failed_to_build ===
{{qnotice|}} 
{{begin-hl2msg|failed_to_build|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|userid|the commander that tried to build something with no power}}
{{hl2msg|short|reason|(eBuildErrorReason) 0: Ok, 1: No Power, 2: No Line of sight, 3: obstruction, 4: invalid build area}}
{{end-hl2msg}}
=== commander_hint_closed ===
{{qnotice|The local commander closed a hint (used to re-evaluate tiered hints)}} 
{{begin-hl2msg|commander_hint_closed|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_selected_structure ===
{{qnotice|The local commander selected a structure}} 
{{begin-hl2msg|commander_selected_structure|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|type|structure type}}
{{hl2msg|short|entindex|Entity id of the selected structure}}
{{end-hl2msg}}
=== commander_flash_assembler_start ===
{{qnotice|Causes the assembler to flash}} 
{{begin-hl2msg|commander_flash_assembler_start|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_flash_assembler_stop ===
{{qnotice|Causes the assembler to stop flashing}} 
{{begin-hl2msg|commander_flash_assembler_stop|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_start_build_mode ===
{{qnotice|Local commander is in structure placement mode}} 
{{begin-hl2msg|commander_start_build_mode|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|type|structure type}}
{{end-hl2msg}}
=== commander_flash_supply_icon_start ===
{{qnotice|Start flashing the supply station build icon}} 
{{begin-hl2msg|commander_flash_supply_icon_start|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_flash_supply_icon_stop ===
{{qnotice|Stop flashing the supply station build icon}} 
{{begin-hl2msg|commander_flash_supply_icon_stop|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_start_structure_build ===
{{qnotice|Start a structure building}} 
{{begin-hl2msg|commander_start_structure_build|string}}
{{hl2msg|short|team|The team that is building the structure}}
{{hl2msg|short|type|The structure type}}
{{end-hl2msg}}
=== promoted_to_commander ===
{{qnotice|}} 
{{begin-hl2msg|promoted_to_commander|string}}
{{hl2msg|short|userid|The user that got promoted to commander}}
{{hl2msg|short|teamid|The team of the promoted commander}}
{{end-hl2msg}}
=== timeleft_10m ===
{{qnotice|10 minutes left of the round}} 
{{begin-hl2msg|timeleft_10m|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_5m ===
{{qnotice|5 minutes left of the round}} 
{{begin-hl2msg|timeleft_5m|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_1m ===
{{qnotice|1 minute left of the round}} 
{{begin-hl2msg|timeleft_1m|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_30s ===
{{qnotice|30 seconds left of the round}} 
{{begin-hl2msg|timeleft_30s|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_10s ===
{{qnotice|10 seconds left of the round}} 
{{begin-hl2msg|timeleft_10s|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_5s ===
{{qnotice|5 seconds left of the round}} 
{{begin-hl2msg|timeleft_5s|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== ach_hospital_duty_progress ===
{{qnotice|progress towards hospital duty achievement. fired client-side. commander only. same team.}} 
{{begin-hl2msg|ach_hospital_duty_progress|string}}
{{hl2msg|short|progress|}}
{{end-hl2msg}}
=== ach_high_maintenance_progress ===
{{qnotice|progress towards high maintenance achievement. fired client-side. commander only. same team.}} 
{{begin-hl2msg|ach_high_maintenance_progress|string}}
{{hl2msg|short|progress|}}
{{end-hl2msg}}
=== forward_spawn_created ===
{{qnotice|Fired once a forward spawn has been created. A forward spawn is defined by any created spawn point that causes the spawn cluster centroid to be split}} 
{{begin-hl2msg|forward_spawn_created|string}}
{{hl2msg|short|teamid|}}
{{end-hl2msg}}
=== research_comlete ===
{{qnotice|Fired when a research has finished researching}} 
{{begin-hl2msg|research_comlete|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|teamid|}}
{{hl2msg|short|researchid|}}
{{end-hl2msg}}
=== show_annotation ===
{{qnotice|}} 
{{begin-hl2msg|show_annotation|string}}
{{hl2msg|float|worldPosX|}}
{{hl2msg|float|worldPosY|}}
{{hl2msg|float|worldPosZ|}}
{{hl2msg|float|worldNormalX|}}
{{hl2msg|float|worldNormalY|}}
{{hl2msg|float|worldNormalZ|}}
{{hl2msg|long|id|}}
{{hl2msg|string|text|name (unlocalized)}}
{{hl2msg|float|lifetime|}}
{{hl2msg|long|visibilityBitfield|bitfield of the players that can see this}}
{{hl2msg|long|follow_entindex|if this is set, follow this entity}}
{{hl2msg|bool|show_distance|}}
{{hl2msg|string|play_sound|}}
{{hl2msg|bool|show_effect|}}
{{end-hl2msg}}
=== hide_annotation ===
{{qnotice|}} 
{{begin-hl2msg|hide_annotation|string}}
{{hl2msg|long|id|}}
{{end-hl2msg}}
=== end_training_session ===
{{qnotice|}} 
{{begin-hl2msg|end_training_session|string}}
{{hl2msg|string|course|}}
{{hl2msg|bool|successful|}}
{{end-hl2msg}}
=== nav_generate ===
{{qnotice|}} 
{{begin-hl2msg|nav_generate|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== medkit_heal ===
{{qnotice|}} 
{{begin-hl2msg|medkit_heal|string}}
{{hl2msg|1|local|}}
{{hl2msg|local|entindex|entity index of medkit}}
{{hl2msg|local|ownerid|user id of medkit owner}}
{{hl2msg|local|userid|user id of player healed}}
{{hl2msg|local|amount|amount of health restored}}
{{end-hl2msg}}
=== emp_structure ===
{{qnotice|}} 
{{begin-hl2msg|emp_structure|string}}
{{hl2msg|1|local|}}
{{hl2msg|local|entindex|entity index of structure}}
{{hl2msg|local|userid|user id of player}}
{{end-hl2msg}}

Counter-Strike: Source Events

2012-01-07T10:50:46Z

Peace-Maker:

:''Refer back to [[Game Events (Source)]] for more events.''

All cstrike mod events can be found in cstrike\resource\modevents.res

=== player_death ===
{{qnotice|When a client dies}}
{{begin-hl2msg|player_death|string}}
{{hl2msg|short|userid|user ID who died}}
{{hl2msg|short|attacker|user ID who killed}}
{{hl2msg|string|weapon|weapon name killer used }}
{{hl2msg|bool|headshot|singals a headshot}}
{{hl2msg|short|dominated|did killer dominate victim with this kill}}
{{hl2msg|short|revenge|did killer get revenge on victim with this kill}}
{{end-hl2msg}}

=== player_hurt ===
{{qnotice|When a client is damaged}}
{{begin-hl2msg|player_hurt|string}}
{{hl2msg|short|userid|user ID who was hurt}}
{{hl2msg|short|attacker|user ID who attacked}}
{{hl2msg|byte|health|remaining health points}}
{{hl2msg|byte|armor|remaining armor points}}
{{hl2msg|string|weapon|weapon name attacker used, if not the world}}
{{hl2msg|byte|dmg_health|damage done to health}}
{{hl2msg|byte|dmg_armor|damage done to armor}}
{{hl2msg|byte|hitgroup|hitgroup that was damaged}}
{{end-hl2msg}}

=== bomb_beginplant ===
{{qnotice|When the bomb is starting to get planted}}
{{begin-hl2msg|bomb_beginplant|string}}
{{hl2msg|short|userid|player who is planting the bomb}}
{{hl2msg|short|site|bombsite index}}
{{end-hl2msg}}

=== bomb_abortplant ===
{{qnotice|When the bomb planter stops planting the bomb}}
{{begin-hl2msg|bomb_abortplant|string}}
{{hl2msg|short|userid|player who is planting the bomb}}
{{hl2msg|short|site|bombsite index}}
{{end-hl2msg}}

=== bomb_planted ===
{{qnotice|When the bomb has been planted}}
{{begin-hl2msg|bomb_planted|string}}
{{hl2msg|short|userid|player who planted the bomb}}
{{hl2msg|short|site|bombsite index}}
{{hl2msg|short|posx|position x}}
{{hl2msg|short|posy|position y}}
{{end-hl2msg}}

=== bomb_defused ===
{{qnotice|When the bomb has been defused}}
{{begin-hl2msg|bomb_defused|string}}
{{hl2msg|short|userid|player who defused the bomb}}
{{hl2msg|short|site|bombsite index}}
{{end-hl2msg}}

=== bomb_exploded ===
{{qnotice|When the bomb explodes}}
{{begin-hl2msg|bomb_exploded|string}}
{{hl2msg|short|userid|player who planted the bomb}}
{{hl2msg|short|site|bombsite index}}
{{end-hl2msg}}

=== bomb_dropped ===
{{qnotice|When the bomb is dropped by a client}}
{{begin-hl2msg|bomb_dropped|string}}
{{hl2msg|short|userid|player who dropped the bomb}}
{{end-hl2msg}}

=== bomb_pickup ===
{{qnotice|When the bomb is picked up by a client}}
{{begin-hl2msg|bomb_pickup|string}}
{{hl2msg|short|userid|player who picked up the bomb}}
{{end-hl2msg}}

=== bomb_begindefuse ===
{{qnotice|When the bomb is started to be defused}}
{{begin-hl2msg|bomb_begindefuse|string}}
{{hl2msg|short|userid|player who is defusing}}
{{hl2msg|bool|haskit|}}
{{end-hl2msg}}

=== bomb_abortdefuse ===
{{qnotice|When the bomb defusal is stopped}}
{{begin-hl2msg|bomb_abortdefuse|string}}
{{hl2msg|short|userid|player who was defusing}}
{{end-hl2msg}}

=== hostage_follows ===
{{qnotice|When the hostage begins following a client}}
{{begin-hl2msg|hostage_follows|string}}
{{hl2msg|short|userid|player who touched the hostage}}
{{hl2msg|short|hostage|hostage entity index}}
{{end-hl2msg}}

=== hostage_hurt ===
{{qnotice|When a hostage is damaged}}
{{begin-hl2msg|hostage_hurt|string}}
{{hl2msg|short|userid|player who hurt the hostage}}
{{hl2msg|short|hostage|hostage entity index}}
{{end-hl2msg}}

=== hostage_killed ===
{{qnotice|When a hostage is killed}}
{{begin-hl2msg|hostage_killed|string}}
{{hl2msg|short|userid|player who killed the hostage}}
{{hl2msg|short|hostage|hostage entity index}}
{{end-hl2msg}}

=== hostage_rescued ===
{{qnotice|When a hostage is rescued}}
{{begin-hl2msg|hostage_rescued|string}}
{{hl2msg|short|userid|player who rescued the hostage}}
{{hl2msg|short|hostage|hostage entity index}}
{{hl2msg|short|site|rescue site index}}
{{end-hl2msg}}

=== hostage_stops_following ===
{{qnotice|When a hostage stops following a client}}
{{begin-hl2msg|hostage_stops_following|string}}
{{hl2msg|short|userid|player who rescued the hostage}}
{{hl2msg|short|hostage|hostage entity index}}
{{end-hl2msg}}

=== hostage_rescued_all ===
{{qnotice|When all the hostages are rescued}}
{{begin-hl2msg|hostage_rescued_all|string}}
{{hl2msg|''none''|''none''|}}
{{end-hl2msg}}

=== hostage_call_for_help ===
{{qnotice|When the hostage calls for help}}
{{begin-hl2msg|hostage_call_for_help|string}}
{{hl2msg|short|hostage|hostage entity index}}
{{end-hl2msg}}

=== vip_escaped ===
{{qnotice|When the VIP escapes}}
{{begin-hl2msg|vip_escaped|string}}
{{hl2msg|short|userid|player who was the VIP}}
{{end-hl2msg}}

=== vip_killed ===
{{qnotice|When the VIP is killed}}
{{begin-hl2msg|vip_killed|string}}
{{hl2msg|short|userid|player who was the VIP}}
{{hl2msg|short|attacker|user ID who killed the VIP}}
{{end-hl2msg}}

=== player_radio ===
{{qnotice|When the player uses radio commands}}
{{begin-hl2msg|player_radio|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|slot|}}
{{end-hl2msg}}

=== bomb_beep ===
{{qnotice|Every time the bomb beep sound happens}}
{{begin-hl2msg|bomb_beep|string}}
{{hl2msg|long|entindex|c4 entity}}
{{end-hl2msg}}

=== weapon_fire ===
{{qnotice|Every time a client fires their weapon}}
{{begin-hl2msg|weapon_fire|string}}
{{hl2msg|short|userid|}}
{{hl2msg|string|weapon|weapon name used}}
{{end-hl2msg}}

=== weapon_fire_on_empty ===
{{qnotice|Every time a client fires their weapon and it's empty}}
{{begin-hl2msg|weapon_fire_on_empty|string}}
{{hl2msg|short|userid|}}
{{hl2msg|string|weapon|weapon name used}}
{{end-hl2msg}}

=== weapon_reload ===
{{qnotice|Every time a client reloads their weapon}}
{{begin-hl2msg|weapon_reload|string}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}

=== weapon_zoom ===
{{qnotice|Every time a client zooms a scoped weapon}}
{{begin-hl2msg|weapon_zoom|string}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}

=== item_pickup ===
{{qnotice|Every time an item is picked up (generally weapons)}}
{{begin-hl2msg|item_pickup|string}}
{{hl2msg|short|userid|}}
{{hl2msg|string|item|either a weapon such as 'tmp' or 'hegrenade', or an item such as 'nvgs'}}
{{end-hl2msg}}

=== grenade_bounce ===
{{qnotice|Every time a grenade bounces}}
{{begin-hl2msg|grenade_bounce|string}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}

=== hegrenade_detonate ===
{{qnotice|Every time a hegrenade explodes}}
{{begin-hl2msg|hegrenade_detonate|string}}
{{hl2msg|short|userid|}}
{{hl2msg|float|x|}}
{{hl2msg|float|y|}}
{{hl2msg|float|z|}}
{{end-hl2msg}}

=== flashbang_detonate ===
{{qnotice|Every time a flashbang detonates}}
{{begin-hl2msg|flashbang_detonate|string}}
{{hl2msg|short|userid|}}
{{hl2msg|float|x|}}
{{hl2msg|float|y|}}
{{hl2msg|float|z|}}
{{end-hl2msg}}

=== smokegrenade_detonate ===
{{qnotice|Every time a smokegrenade detonates}}
{{begin-hl2msg|smokegrenade_detonate|string}}
{{hl2msg|short|userid|}}
{{hl2msg|float|x|}}
{{hl2msg|float|y|}}
{{hl2msg|float|z|}}
{{end-hl2msg}}

=== bullet_impact ===
{{qnotice|Every time a bullet hits something}}
{{begin-hl2msg|bullet_impact}}
{{hl2msg|short|userid|}}
{{hl2msg|float|x|}}
{{hl2msg|float|y|}}
{{hl2msg|float|z|}}
{{end-hl2msg}}

=== player_footstep ===
{{qnotice|Every time a player takes a step}}
{{begin-hl2msg|player_footstep|string}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}

=== player_jump ===
{{qnotice|Every time a player jumps}}
{{begin-hl2msg|player_jump|string}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}

=== player_blind ===
{{qnotice|Every time a player is blinded by a flashbang}}
{{begin-hl2msg|player_blind|string}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}

=== player_falldamage ===
{{qnotice|Every time a player takes damage due to a fall}}
{{begin-hl2msg|player_falldamage|string}}
{{hl2msg|short|userid|}}
{{hl2msg|float|damage|}}
{{end-hl2msg}}

=== door_moving ===
{{qnotice|Every time a door is put in motion (opened)}}
{{begin-hl2msg|door_moving|string}}
{{hl2msg|long|entindex|}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}

=== round_freeze_end ===
{{qnotice|When the round's mp_freezetime is up}}
{{begin-hl2msg|round_freeze_end|string}}
{{hl2msg|''none''|''none''|}}
{{end-hl2msg}}

=== nav_blocked ===
{{qnotice|''Guess: Called when an area is blocked by the nav of a map''}}
{{begin-hl2msg|nav_blocked|string}}
{{hl2msg|long|area|}}
{{hl2msg|bool|blocked|}}
{{end-hl2msg}}

=== nav_generate ===
{{qnotice|Called when a nav file does not exist for a map and bots are added}}
{{begin-hl2msg|nav_generate|string}}
{{hl2msg|''none''|''none''|}}
{{end-hl2msg}}

=== player_stats_updated ===
{{qnotice|''Guess: Called when the player stats (achievments) are sent to valve''}}
{{begin-hl2msg|player_stats_updated|string}}
{{hl2msg|bool|forceupload|}}
{{end-hl2msg}}

=== spec_target_updated ===
{{qnotice|-}}
{{begin-hl2msg|spec_target_updated|string}}
{{hl2msg|''none''|''none''|}}
{{end-hl2msg}}

=== cs_win_panel_round ===
{{qnotice|Called at the end of a round}}
{{begin-hl2msg|cs_win_panel_round|string}}
{{hl2msg|bool|show_timer_defend|}}
{{hl2msg|bool|show_timer_attack|}}
{{hl2msg|short|timer_time|}}
{{hl2msg|byte|final_event|defined in cs_gamerules.h}}
{{hl2msg|string|funfact_token|}}
{{hl2msg|short|funfact_player|}}
{{hl2msg|long|funfact_data1|}}
{{hl2msg|long|funfact_data2|}}
{{hl2msg|long|funfact_data3|}}
{{end-hl2msg}}

=== cs_win_panel_match ===
{{qnotice|Called at the end of the map}}
{{begin-hl2msg|cs_win_panel_match|string}}
{{hl2msg|short|t_score|}}
{{hl2msg|short|ct_score|}}
{{hl2msg|float|t_kd|}}
{{hl2msg|float|ct_kd|}}
{{hl2msg|short|t_objectives_done|}}
{{hl2msg|short|ct_objectives_done|}}
{{hl2msg|long|t_money_earned|}}
{{hl2msg|long|ct_money_earned|}}
{{end-hl2msg}}

=== show_freezepanel ===
{{qnotice|-}}
{{begin-hl2msg|show_freezepanel|string}}
{{hl2msg|short|killer|entindex of the killer entity}}
{{end-hl2msg}}

=== hide_freezepanel ===
{{qnotice|-}}
{{begin-hl2msg|hide_freezepanel|string}}
{{hl2msg|''none''|''none''|}}
{{end-hl2msg}}

=== freezecam_started ===
{{qnotice|-}}
{{begin-hl2msg|freezecam_started|string}}
{{hl2msg|''none''|''none''|}}
{{end-hl2msg}}

=== player_avenged_teammate ===
{{qnotice|-}}
{{begin-hl2msg|player_avenged_teammate|string}}
{{hl2msg|short|avenger_id|}}
{{hl2msg|short|avenged_player_id|}}
{{end-hl2msg}}

=== achievement_earned ===
{{qnotice|-}}
{{begin-hl2msg|achievement_earned|string}}
{{hl2msg|byte|player|entindex of the player}}
{{hl2msg|short|achievement|achievement ID}}
{{end-hl2msg}}

=== achievement_earned_local ===
{{qnotice|-}}
{{begin-hl2msg|achievement_earned_local|string}}
{{hl2msg|short|achievement|achievement ID}}
{{end-hl2msg}}

=== match_end_conditions ===
{{qnotice|-}}
{{begin-hl2msg|match_end_conditions|string}}
{{hl2msg|long|frags|}}
{{hl2msg|long|max_rounds|}}
{{hl2msg|long|win_rounds|}}
{{hl2msg|long|time|}}
{{end-hl2msg}}

=== round_mvp ===
{{qnotice|-}}
{{begin-hl2msg|round_mvp|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|reason|}}
{{end-hl2msg}}

=== player_decal ===
{{qnotice|-}}
{{begin-hl2msg|player_decal|string}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}

=== teamplay_round_start ===
{{qnotice|-}}
{{begin-hl2msg|teamplay_round_start|string}}
{{hl2msg|bool|full_reset|}}
{{end-hl2msg}}

=== christmas_gift_grab ===
{{qnotice|-}}
{{begin-hl2msg|christmas_gift_grab|string}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}

Vice keys

2011-09-02T18:07:23Z

Peace-Maker:

VICE keys are used to encrypt the game's weapon config files in an effort to make them more difficult to tamper with. It's not really a great protection, as usually the key is just hardcoded into the server binaries. Some games, such as Golden Eye Source, try to make it more difficult to retrieve these, but even then it's trivial.

These keys can be used to decrypt the CTX files that many games provide.

{|
!width="300"| Game
!width="100"| Key
|-
| Counter-Strike: Source
| d7NSuLq2
|-
| CSPromod
| H1aRQ0n1
|-
| Day of Defeat: Source
| Wl0u5B3F
|-
| Dystopia (1.2?)
| pH3apO8w
|-
| Dystopia 1.3 RC2
| G8stUh3F
|-
| Golden Eye Source
| Gr3naDes
|-
| Half-Life 2: Deathmatch
| x9Ke0BY7
|-
| Insurgency
| DrA5e3EB
|-
| Left 4 Dead 2 (VScript .nuc)
| SDhfi878
|-
| TF2 (items.ctx)
| A5fSXbf7
|-
| TF2 (everything else)
| E2NcUkG2
|-
| ZPS
| 5R0ni0pZ
|-
| Nuclear Dawn
| TA+*veh9
|}

Nuclear Dawn Events

2011-08-26T02:21:40Z

Peace-Maker:

:''Refer back to [[Game Events (Source)]] for more events.''

=== player_death ===
{{qnotice|}} 
{{begin-hl2msg|player_death|string}}
{{hl2msg|short|userid|user ID who died}}
{{hl2msg|short|attacker|user ID who killed}}
{{hl2msg|string|weapon|weapon name killed used}}
{{hl2msg|short|weaponid|weapon id}}
{{hl2msg|long|damagebits|bits}}
{{hl2msg|long|customkill|custom bits}}
{{hl2msg|short|priority|}}
{{end-hl2msg}}
=== player_changeclass ===
{{qnotice|Called when a player changes class}} 
{{begin-hl2msg|player_changeclass|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|class|}}
{{hl2msg|short|subclass|}}
{{end-hl2msg}}
=== spec_target_updated ===
{{qnotice|}} 
{{begin-hl2msg|spec_target_updated|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== achievement_earned ===
{{qnotice|}} 
{{begin-hl2msg|achievement_earned|string}}
{{hl2msg|short|player|}}
{{hl2msg|short|achievement|}}
{{end-hl2msg}}
=== player_spawned_at_tgate ===
{{qnotice|}} 
{{begin-hl2msg|player_spawned_at_tgate|string}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}
=== structure_death ===
{{qnotice|fired when we sell a structure}} 
{{begin-hl2msg|structure_death|string}}
{{hl2msg|short|type|type of structure sold}}
{{hl2msg|short|team|the team the structure belonged to}}
{{hl2msg|short|attacker|userid of attacking player}}
{{hl2msg|string|weapon|weapon name the attacker used}}
{{end-hl2msg}}
=== structure_damage_sparse ===
{{qnotice|is only fired for every 100hp taken. no spamz here}} 
{{begin-hl2msg|structure_damage_sparse|string}}
{{hl2msg|short|entindex|entity index of structure being damaged}}
{{hl2msg|short|ownerteam|team that owns the structure - Todo: optimize this out!}}
{{hl2msg|bool|bunker|was it the bunker?}}
{{end-hl2msg}}
=== structure_sold ===
{{qnotice|fired when we sell a structure}} 
{{begin-hl2msg|structure_sold|string}}
{{hl2msg|short|type|type of structure sold}}
{{hl2msg|short|ownerteam|the team the structure belonged to}}
{{end-hl2msg}}
=== structure_fully_auto_repaired ===
{{qnotice|fired when a damaged structure gets healed to 100% hp using auto repair}} 
{{begin-hl2msg|structure_fully_auto_repaired|string}}
{{hl2msg|short|type|type of structure repaired}}
{{hl2msg|short|entindex|entity index of repaired structure}}
{{hl2msg|short|ownerteam|team that the structure belongs to}}
{{end-hl2msg}}
=== structure_fully_man_repaired ===
{{qnotice|fired when a damaged structure gets healed to 100% hp by supports}} 
{{begin-hl2msg|structure_fully_man_repaired|string}}
{{hl2msg|short|type|type of structure repaired}}
{{hl2msg|short|entindex|entity index of repaired structure}}
{{hl2msg|short|ownerteam|team that the structure belongs to}}
{{end-hl2msg}}
=== structure_built ===
{{qnotice|structure fully built. fired client-side. commander only. same team.}} 
{{begin-hl2msg|structure_built|string}}
{{hl2msg|short|entindex|structure entity index}}
{{end-hl2msg}}
=== structure_power_outage ===
{{qnotice|structure out of power. fired client-side. commander only. same team.}} 
{{begin-hl2msg|structure_power_outage|string}}
{{hl2msg|short|entindex|structure entity index}}
{{end-hl2msg}}
=== resource_start_capture ===
{{qnotice|Used to show the capture hud panel}} 
{{begin-hl2msg|resource_start_capture|string}}
{{hl2msg|short|userid|user id that is starting the capture}}
{{hl2msg|short|entindex|resource point getting capped}}
{{hl2msg|short|type|type of resource point}}
{{hl2msg|short|capteam|team that is capping}}
{{hl2msg|short|ownerteam|team that currently owns the point (check for unassigned)}}
{{end-hl2msg}}
=== resource_end_capture ===
{{qnotice|Used to hide the capture hud panel}} 
{{begin-hl2msg|resource_end_capture|string}}
{{hl2msg|short|userid|user id that is starting the capture}}
{{hl2msg|short|entindex|resource point that got captured}}
{{end-hl2msg}}
=== resource_break_capture ===
{{qnotice|}} 
{{begin-hl2msg|resource_break_capture|string}}
{{hl2msg|short|entindex|}}
{{hl2msg|float|time_remaining|}}
{{end-hl2msg}}
=== resource_extract ===
{{qnotice|Resource point has extracted some resources}} 
{{begin-hl2msg|resource_extract|string}}
{{hl2msg|short|entindex|resource point that extracted the resources}}
{{hl2msg|short|amount|resource point that extracted the resources}}
{{end-hl2msg}}
=== resource_captured ===
{{qnotice|When a resource point gets fully captured by a team}} 
{{begin-hl2msg|resource_captured|string}}
{{hl2msg|short|entindex|entity index of the captrd point}}
{{hl2msg|short|type|the resource point type that got captured}}
{{hl2msg|short|team|team that captured the point}}
{{end-hl2msg}}
=== power_requested ===
{{qnotice|An entity is requesting a power connection}} 
{{begin-hl2msg|power_requested|string}}
{{hl2msg|short|teamid|The team who's power system got updated}}
{{hl2msg|short|entid|The entity index that is requesting a power connection}}
{{end-hl2msg}}
=== power_removed ===
{{qnotice|An entity is requesting a power connection}} 
{{begin-hl2msg|power_removed|string}}
{{hl2msg|short|teamid|The team who's power system got updated}}
{{hl2msg|short|entid|The entity index that is requesting a power connection}}
{{end-hl2msg}}
=== power_updated ===
{{qnotice|When the power nexus gets updated}} 
{{begin-hl2msg|power_updated|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== enter_pregame ===
{{qnotice|}} 
{{begin-hl2msg|enter_pregame|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== blueprint_update ===
{{qnotice|}} 
{{begin-hl2msg|blueprint_update|string}}
{{hl2msg|short|teamid|The team who's power system got updated}}
{{hl2msg|short|blueprint|The blueprint that is updated}}
{{hl2msg|short|state|1 = earned, 0 = not earned..}}
{{end-hl2msg}}
=== enter_vehicle ===
{{qnotice|}} 
{{begin-hl2msg|enter_vehicle|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|seat|}}
{{hl2msg|short|entidx|}}
{{end-hl2msg}}
=== exit_vehicle ===
{{qnotice|}} 
{{begin-hl2msg|exit_vehicle|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|seat|}}
{{hl2msg|short|entidx|}}
{{end-hl2msg}}
=== show_freezepanel ===
{{qnotice|}} 
{{begin-hl2msg|show_freezepanel|string}}
{{hl2msg|short|killer|entindex of the killer entity}}
{{end-hl2msg}}
=== hide_freezepanel ===
{{qnotice|}} 
{{begin-hl2msg|hide_freezepanel|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== freezecam_started ===
{{qnotice|}} 
{{begin-hl2msg|freezecam_started|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== spawn_map_changed ===
{{qnotice|Called when a tgate is built, removed, or power state changes}} 
{{begin-hl2msg|spawn_map_changed|string}}
{{hl2msg|short|teamid|}}
{{end-hl2msg}}
=== weapon_reload ===
{{qnotice|}} 
{{begin-hl2msg|weapon_reload|string}}
{{hl2msg|short|userid|}}
{{hl2msg|bool|manual|player manually started the reload}}
{{end-hl2msg}}
=== weapon_fire_at_40 ===
{{qnotice|}} 
{{begin-hl2msg|weapon_fire_at_40|string}}
{{hl2msg|short|userid|}}
{{hl2msg|string|weapon|used weapon name}}
{{hl2msg|short|weaponid|used weapon ID}}
{{hl2msg|short|count|number of bullets}}
{{end-hl2msg}}
=== entity_visible ===
{{qnotice|}} 
{{begin-hl2msg|entity_visible|string}}
{{hl2msg|short|userid|The player who sees the entity}}
{{hl2msg|long|subject|Entindex of the entity they see}}
{{hl2msg|string|classname|Classname of the entity they see}}
{{hl2msg|string|entityname|name of the entity they see}}
{{end-hl2msg}}
=== player_left_bunker_building ===
{{qnotice|}} 
{{begin-hl2msg|player_left_bunker_building|string}}
{{hl2msg|short|userid|The player who left the bunker}}
{{hl2msg|short|entidx|The bunker they left}}
{{end-hl2msg}}
=== player_entered_bunker_building ===
{{qnotice|}} 
{{begin-hl2msg|player_entered_bunker_building|string}}
{{hl2msg|short|userid|The player who entered the bunker}}
{{hl2msg|short|entidx|The bunker they entered}}
{{end-hl2msg}}
=== player_entered_commander_mode ===
{{qnotice|}} 
{{begin-hl2msg|player_entered_commander_mode|string}}
{{hl2msg|short|userid|Player who entered commander mode}}
{{end-hl2msg}}
=== player_enter_commander_mode_failed ===
{{qnotice|}} 
{{begin-hl2msg|player_enter_commander_mode_failed|string}}
{{hl2msg|short|userid|Player who tried to enter commander mode}}
{{end-hl2msg}}
=== player_left_commander_mode ===
{{qnotice|}} 
{{begin-hl2msg|player_left_commander_mode|string}}
{{hl2msg|short|userid|Player who left commander mode}}
{{end-hl2msg}}
=== player_restocked_from_supply_struct ===
{{qnotice|}} 
{{begin-hl2msg|player_restocked_from_supply_struct|string}}
{{hl2msg|short|userid|Player who was restocked}}
{{hl2msg|short|entidx|Entity they got supply from}}
{{end-hl2msg}}
=== player_opened_armoury_menu ===
{{qnotice|}} 
{{begin-hl2msg|player_opened_armoury_menu|string}}
{{hl2msg|short|userid|Player opened kit menu from armoury}}
{{end-hl2msg}}
=== commander_move_2d ===
{{qnotice|}} 
{{begin-hl2msg|commander_move_2d|string}}
{{hl2msg|1|local|Local only}}
{{hl2msg|short|userid|Player that moved the commander camera}}
{{end-hl2msg}}
=== commander_move_z ===
{{qnotice|}} 
{{begin-hl2msg|commander_move_z|string}}
{{hl2msg|1|local|Local only}}
{{hl2msg|short|userid|Player that moved the commander camera up/down}}
{{end-hl2msg}}
=== commander_minimap_move ===
{{qnotice|}} 
{{begin-hl2msg|commander_minimap_move|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|userid|Player that moved the commander camera}}
{{end-hl2msg}}
=== player_entered_tgate ===
{{qnotice|}} 
{{begin-hl2msg|player_entered_tgate|string}}
{{hl2msg|short|userid|Player that spawned}}
{{hl2msg|short|entidx|Gate they spawned at}}
{{end-hl2msg}}
=== player_exited_tgate ===
{{qnotice|}} 
{{begin-hl2msg|player_exited_tgate|string}}
{{hl2msg|short|userid|Player that left the gate}}
{{hl2msg|short|entidx|Gate they left}}
{{end-hl2msg}}
=== commander_left_valid_area ===
{{qnotice|}} 
{{begin-hl2msg|commander_left_valid_area|string}}
{{hl2msg|short|userid|The commander that left valid "airspace"}}
{{end-hl2msg}}
=== commander_entered_valid_area ===
{{qnotice|}} 
{{begin-hl2msg|commander_entered_valid_area|string}}
{{hl2msg|short|userid|The commander that entered valid "airspace"}}
{{end-hl2msg}}
=== round_win ===
{{qnotice|}} 
{{begin-hl2msg|round_win|string}}
{{hl2msg|short|team|The winning team}}
{{hl2msg|short|type|Type of win}}
{{end-hl2msg}}
=== transport_gate_created ===
{{qnotice|}} 
{{begin-hl2msg|transport_gate_created|string}}
{{hl2msg|short|teamid|Team that created the gate}}
{{hl2msg|short|entindex|Entity id of the new gate}}
{{end-hl2msg}}
=== last_tgate_destroyed ===
{{qnotice|}} 
{{begin-hl2msg|last_tgate_destroyed|string}}
{{hl2msg|short|teamid|Team who's last tgate got pwnd}}
{{end-hl2msg}}
=== player_stats_updated ===
{{qnotice|}} 
{{begin-hl2msg|player_stats_updated|string}}
{{hl2msg|bool|forceupload|}}
{{end-hl2msg}}
=== failed_to_build ===
{{qnotice|}} 
{{begin-hl2msg|failed_to_build|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|userid|the commander that tried to build something with no power}}
{{hl2msg|short|reason|(eBuildErrorReason) 0: Ok, 1: No Power, 2: No Line of sight, 3: obstruction, 4: invalid build area}}
{{end-hl2msg}}
=== commander_hint_closed ===
{{qnotice|The local commander closed a hint (used to re-evaluate tiered hints)}} 
{{begin-hl2msg|commander_hint_closed|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_selected_structure ===
{{qnotice|The local commander selected a structure}} 
{{begin-hl2msg|commander_selected_structure|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|type|structure type}}
{{hl2msg|short|entindex|Entity id of the selected structure}}
{{end-hl2msg}}
=== commander_flash_assembler_start ===
{{qnotice|Causes the assembler to flash}} 
{{begin-hl2msg|commander_flash_assembler_start|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_flash_assembler_stop ===
{{qnotice|Causes the assembler to stop flashing}} 
{{begin-hl2msg|commander_flash_assembler_stop|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_start_build_mode ===
{{qnotice|Local commander is in structure placement mode}} 
{{begin-hl2msg|commander_start_build_mode|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|type|structure type}}
{{end-hl2msg}}
=== commander_flash_supply_icon_start ===
{{qnotice|Start flashing the supply station build icon}} 
{{begin-hl2msg|commander_flash_supply_icon_start|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_flash_supply_icon_stop ===
{{qnotice|Stop flashing the supply station build icon}} 
{{begin-hl2msg|commander_flash_supply_icon_stop|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_start_structure_build ===
{{qnotice|Start a structure building}} 
{{begin-hl2msg|commander_start_structure_build|string}}
{{hl2msg|short|team|The team that is building the structure}}
{{hl2msg|short|type|The structure type}}
{{end-hl2msg}}
=== promoted_to_commander ===
{{qnotice|}} 
{{begin-hl2msg|promoted_to_commander|string}}
{{hl2msg|short|userid|The user that got promoted to commander}}
{{hl2msg|short|teamid|The team of the promoted commander}}
{{end-hl2msg}}
=== timeleft_10m ===
{{qnotice|10 minutes left of the round}} 
{{begin-hl2msg|timeleft_10m|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_5m ===
{{qnotice|5 minutes left of the round}} 
{{begin-hl2msg|timeleft_5m|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_1m ===
{{qnotice|1 minute left of the round}} 
{{begin-hl2msg|timeleft_1m|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_30s ===
{{qnotice|30 seconds left of the round}} 
{{begin-hl2msg|timeleft_30s|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_10s ===
{{qnotice|10 seconds left of the round}} 
{{begin-hl2msg|timeleft_10s|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_5s ===
{{qnotice|5 seconds left of the round}} 
{{begin-hl2msg|timeleft_5s|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== ach_hospital_duty_progress ===
{{qnotice|progress towards hospital duty achievement. fired client-side. commander only. same team.}} 
{{begin-hl2msg|ach_hospital_duty_progress|string}}
{{hl2msg|short|progress|}}
{{end-hl2msg}}
=== ach_high_maintenance_progress ===
{{qnotice|progress towards high maintenance achievement. fired client-side. commander only. same team.}} 
{{begin-hl2msg|ach_high_maintenance_progress|string}}
{{hl2msg|short|progress|}}
{{end-hl2msg}}

Nuclear Dawn Events

2011-08-26T02:12:49Z

Peace-Maker: Created page with '=== player_death === {{qnotice|}} {{begin-hl2msg|player_death|string}} {{hl2msg|short|userid|user ID who died}} {{hl2msg|short|attacker|user ID who killed}} {{hl2msg|string|w...'

=== player_death ===
{{qnotice|}} 
{{begin-hl2msg|player_death|string}}
{{hl2msg|short|userid|user ID who died}}
{{hl2msg|short|attacker|user ID who killed}}
{{hl2msg|string|weapon|weapon name killed used}}
{{hl2msg|short|weaponid|weapon id}}
{{hl2msg|long|damagebits|bits}}
{{hl2msg|long|customkill|custom bits}}
{{hl2msg|short|priority|}}
{{end-hl2msg}}
=== player_changeclass ===
{{qnotice|Called when a player changes class}} 
{{begin-hl2msg|player_changeclass|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|class|}}
{{hl2msg|short|subclass|}}
{{end-hl2msg}}
=== spec_target_updated ===
{{qnotice|}} 
{{begin-hl2msg|spec_target_updated|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== achievement_earned ===
{{qnotice|}} 
{{begin-hl2msg|achievement_earned|string}}
{{hl2msg|short|player|}}
{{hl2msg|short|achievement|}}
{{end-hl2msg}}
=== player_spawned_at_tgate ===
{{qnotice|}} 
{{begin-hl2msg|player_spawned_at_tgate|string}}
{{hl2msg|short|userid|}}
{{end-hl2msg}}
=== structure_death ===
{{qnotice|fired when we sell a structure}} 
{{begin-hl2msg|structure_death|string}}
{{hl2msg|short|type|type of structure sold}}
{{hl2msg|short|team|the team the structure belonged to}}
{{hl2msg|short|attacker|userid of attacking player}}
{{hl2msg|string|weapon|weapon name the attacker used}}
{{end-hl2msg}}
=== structure_damage_sparse ===
{{qnotice|is only fired for every 100hp taken. no spamz here}} 
{{begin-hl2msg|structure_damage_sparse|string}}
{{hl2msg|short|entindex|entity index of structure being damaged}}
{{hl2msg|short|ownerteam|team that owns the structure - Todo: optimize this out!}}
{{hl2msg|bool|bunker|was it the bunker?}}
{{end-hl2msg}}
=== structure_sold ===
{{qnotice|fired when we sell a structure}} 
{{begin-hl2msg|structure_sold|string}}
{{hl2msg|short|type|type of structure sold}}
{{hl2msg|short|ownerteam|the team the structure belonged to}}
{{end-hl2msg}}
=== structure_fully_auto_repaired ===
{{qnotice|fired when a damaged structure gets healed to 100% hp using auto repair}} 
{{begin-hl2msg|structure_fully_auto_repaired|string}}
{{hl2msg|short|type|type of structure repaired}}
{{hl2msg|short|entindex|entity index of repaired structure}}
{{hl2msg|short|ownerteam|team that the structure belongs to}}
{{end-hl2msg}}
=== structure_fully_man_repaired ===
{{qnotice|fired when a damaged structure gets healed to 100% hp by supports}} 
{{begin-hl2msg|structure_fully_man_repaired|string}}
{{hl2msg|short|type|type of structure repaired}}
{{hl2msg|short|entindex|entity index of repaired structure}}
{{hl2msg|short|ownerteam|team that the structure belongs to}}
{{end-hl2msg}}
=== structure_built ===
{{qnotice|structure fully built. fired client-side. commander only. same team.}} 
{{begin-hl2msg|structure_built|string}}
{{hl2msg|short|entindex|structure entity index}}
{{end-hl2msg}}
=== structure_power_outage ===
{{qnotice|structure out of power. fired client-side. commander only. same team.}} 
{{begin-hl2msg|structure_power_outage|string}}
{{hl2msg|short|entindex|structure entity index}}
{{end-hl2msg}}
=== resource_start_capture ===
{{qnotice|Used to show the capture hud panel}} 
{{begin-hl2msg|resource_start_capture|string}}
{{hl2msg|short|userid|user id that is starting the capture}}
{{hl2msg|short|entindex|resource point getting capped}}
{{hl2msg|short|type|type of resource point}}
{{hl2msg|short|capteam|team that is capping}}
{{hl2msg|short|ownerteam|team that currently owns the point (check for unassigned)}}
{{end-hl2msg}}
=== resource_end_capture ===
{{qnotice|Used to hide the capture hud panel}} 
{{begin-hl2msg|resource_end_capture|string}}
{{hl2msg|short|userid|user id that is starting the capture}}
{{hl2msg|short|entindex|resource point that got captured}}
{{end-hl2msg}}
=== resource_break_capture ===
{{qnotice|}} 
{{begin-hl2msg|resource_break_capture|string}}
{{hl2msg|short|entindex|}}
{{hl2msg|float|time_remaining|}}
{{end-hl2msg}}
=== resource_extract ===
{{qnotice|Resource point has extracted some resources}} 
{{begin-hl2msg|resource_extract|string}}
{{hl2msg|short|entindex|resource point that extracted the resources}}
{{hl2msg|short|amount|resource point that extracted the resources}}
{{end-hl2msg}}
=== resource_captured ===
{{qnotice|When a resource point gets fully captured by a team}} 
{{begin-hl2msg|resource_captured|string}}
{{hl2msg|short|entindex|entity index of the captrd point}}
{{hl2msg|short|type|the resource point type that got captured}}
{{hl2msg|short|team|team that captured the point}}
{{end-hl2msg}}
=== power_requested ===
{{qnotice|An entity is requesting a power connection}} 
{{begin-hl2msg|power_requested|string}}
{{hl2msg|short|teamid|The team who's power system got updated}}
{{hl2msg|short|entid|The entity index that is requesting a power connection}}
{{end-hl2msg}}
=== power_removed ===
{{qnotice|An entity is requesting a power connection}} 
{{begin-hl2msg|power_removed|string}}
{{hl2msg|short|teamid|The team who's power system got updated}}
{{hl2msg|short|entid|The entity index that is requesting a power connection}}
{{end-hl2msg}}
=== power_updated ===
{{qnotice|When the power nexus gets updated}} 
{{begin-hl2msg|power_updated|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== enter_pregame ===
{{qnotice|}} 
{{begin-hl2msg|enter_pregame|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== blueprint_update ===
{{qnotice|}} 
{{begin-hl2msg|blueprint_update|string}}
{{hl2msg|short|teamid|The team who's power system got updated}}
{{hl2msg|short|blueprint|The blueprint that is updated}}
{{hl2msg|short|state|1 = earned, 0 = not earned..}}
{{end-hl2msg}}
=== enter_vehicle ===
{{qnotice|}} 
{{begin-hl2msg|enter_vehicle|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|seat|}}
{{hl2msg|short|entidx|}}
{{end-hl2msg}}
=== exit_vehicle ===
{{qnotice|}} 
{{begin-hl2msg|exit_vehicle|string}}
{{hl2msg|short|userid|}}
{{hl2msg|short|seat|}}
{{hl2msg|short|entidx|}}
{{end-hl2msg}}
=== show_freezepanel ===
{{qnotice|}} 
{{begin-hl2msg|show_freezepanel|string}}
{{hl2msg|short|killer|entindex of the killer entity}}
{{end-hl2msg}}
=== hide_freezepanel ===
{{qnotice|}} 
{{begin-hl2msg|hide_freezepanel|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== freezecam_started ===
{{qnotice|}} 
{{begin-hl2msg|freezecam_started|string}}
{{hl2msg|None|None|}}
{{end-hl2msg}}
=== spawn_map_changed ===
{{qnotice|Called when a tgate is built, removed, or power state changes}} 
{{begin-hl2msg|spawn_map_changed|string}}
{{hl2msg|short|teamid|}}
{{end-hl2msg}}
=== weapon_reload ===
{{qnotice|}} 
{{begin-hl2msg|weapon_reload|string}}
{{hl2msg|short|userid|}}
{{hl2msg|bool|manual|player manually started the reload}}
{{end-hl2msg}}
=== weapon_fire_at_40 ===
{{qnotice|}} 
{{begin-hl2msg|weapon_fire_at_40|string}}
{{hl2msg|short|userid|}}
{{hl2msg|string|weapon|used weapon name}}
{{hl2msg|short|weaponid|used weapon ID}}
{{hl2msg|short|count|number of bullets}}
{{end-hl2msg}}
=== entity_visible ===
{{qnotice|}} 
{{begin-hl2msg|entity_visible|string}}
{{hl2msg|short|userid|The player who sees the entity}}
{{hl2msg|long|subject|Entindex of the entity they see}}
{{hl2msg|string|classname|Classname of the entity they see}}
{{hl2msg|string|entityname|name of the entity they see}}
{{end-hl2msg}}
=== player_left_bunker_building ===
{{qnotice|}} 
{{begin-hl2msg|player_left_bunker_building|string}}
{{hl2msg|short|userid|The player who left the bunker}}
{{hl2msg|short|entidx|The bunker they left}}
{{end-hl2msg}}
=== player_entered_bunker_building ===
{{qnotice|}} 
{{begin-hl2msg|player_entered_bunker_building|string}}
{{hl2msg|short|userid|The player who entered the bunker}}
{{hl2msg|short|entidx|The bunker they entered}}
{{end-hl2msg}}
=== player_entered_commander_mode ===
{{qnotice|}} 
{{begin-hl2msg|player_entered_commander_mode|string}}
{{hl2msg|short|userid|Player who entered commander mode}}
{{end-hl2msg}}
=== player_enter_commander_mode_failed ===
{{qnotice|}} 
{{begin-hl2msg|player_enter_commander_mode_failed|string}}
{{hl2msg|short|userid|Player who tried to enter commander mode}}
{{end-hl2msg}}
=== player_left_commander_mode ===
{{qnotice|}} 
{{begin-hl2msg|player_left_commander_mode|string}}
{{hl2msg|short|userid|Player who left commander mode}}
{{end-hl2msg}}
=== player_restocked_from_supply_struct ===
{{qnotice|}} 
{{begin-hl2msg|player_restocked_from_supply_struct|string}}
{{hl2msg|short|userid|Player who was restocked}}
{{hl2msg|short|entidx|Entity they got supply from}}
{{end-hl2msg}}
=== player_opened_armoury_menu ===
{{qnotice|}} 
{{begin-hl2msg|player_opened_armoury_menu|string}}
{{hl2msg|short|userid|Player opened kit menu from armoury}}
{{end-hl2msg}}
=== commander_move_2d ===
{{qnotice|}} 
{{begin-hl2msg|commander_move_2d|string}}
{{hl2msg|1|local|Local only}}
{{hl2msg|short|userid|Player that moved the commander camera}}
{{end-hl2msg}}
=== commander_move_z ===
{{qnotice|}} 
{{begin-hl2msg|commander_move_z|string}}
{{hl2msg|1|local|Local only}}
{{hl2msg|short|userid|Player that moved the commander camera up/down}}
{{end-hl2msg}}
=== commander_minimap_move ===
{{qnotice|}} 
{{begin-hl2msg|commander_minimap_move|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|userid|Player that moved the commander camera}}
{{end-hl2msg}}
=== player_entered_tgate ===
{{qnotice|}} 
{{begin-hl2msg|player_entered_tgate|string}}
{{hl2msg|short|userid|Player that spawned}}
{{hl2msg|short|entidx|Gate they spawned at}}
{{end-hl2msg}}
=== player_exited_tgate ===
{{qnotice|}} 
{{begin-hl2msg|player_exited_tgate|string}}
{{hl2msg|short|userid|Player that left the gate}}
{{hl2msg|short|entidx|Gate they left}}
{{end-hl2msg}}
=== commander_left_valid_area ===
{{qnotice|}} 
{{begin-hl2msg|commander_left_valid_area|string}}
{{hl2msg|short|userid|The commander that left valid "airspace"}}
{{end-hl2msg}}
=== commander_entered_valid_area ===
{{qnotice|}} 
{{begin-hl2msg|commander_entered_valid_area|string}}
{{hl2msg|short|userid|The commander that entered valid "airspace"}}
{{end-hl2msg}}
=== round_win ===
{{qnotice|}} 
{{begin-hl2msg|round_win|string}}
{{hl2msg|short|team|The winning team}}
{{hl2msg|short|type|Type of win}}
{{end-hl2msg}}
=== transport_gate_created ===
{{qnotice|}} 
{{begin-hl2msg|transport_gate_created|string}}
{{hl2msg|short|teamid|Team that created the gate}}
{{hl2msg|short|entindex|Entity id of the new gate}}
{{end-hl2msg}}
=== last_tgate_destroyed ===
{{qnotice|}} 
{{begin-hl2msg|last_tgate_destroyed|string}}
{{hl2msg|short|teamid|Team who's last tgate got pwnd}}
{{end-hl2msg}}
=== player_stats_updated ===
{{qnotice|}} 
{{begin-hl2msg|player_stats_updated|string}}
{{hl2msg|bool|forceupload|}}
{{end-hl2msg}}
=== failed_to_build ===
{{qnotice|}} 
{{begin-hl2msg|failed_to_build|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|userid|the commander that tried to build something with no power}}
{{hl2msg|short|reason|(eBuildErrorReason) 0: Ok, 1: No Power, 2: No Line of sight, 3: obstruction, 4: invalid build area}}
{{end-hl2msg}}
=== commander_hint_closed ===
{{qnotice|The local commander closed a hint (used to re-evaluate tiered hints)}} 
{{begin-hl2msg|commander_hint_closed|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_selected_structure ===
{{qnotice|The local commander selected a structure}} 
{{begin-hl2msg|commander_selected_structure|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|type|structure type}}
{{hl2msg|short|entindex|Entity id of the selected structure}}
{{end-hl2msg}}
=== commander_flash_assembler_start ===
{{qnotice|Causes the assembler to flash}} 
{{begin-hl2msg|commander_flash_assembler_start|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_flash_assembler_stop ===
{{qnotice|Causes the assembler to stop flashing}} 
{{begin-hl2msg|commander_flash_assembler_stop|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_start_build_mode ===
{{qnotice|Local commander is in structure placement mode}} 
{{begin-hl2msg|commander_start_build_mode|string}}
{{hl2msg|1|local|}}
{{hl2msg|short|type|structure type}}
{{end-hl2msg}}
=== commander_flash_supply_icon_start ===
{{qnotice|Start flashing the supply station build icon}} 
{{begin-hl2msg|commander_flash_supply_icon_start|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_flash_supply_icon_stop ===
{{qnotice|Stop flashing the supply station build icon}} 
{{begin-hl2msg|commander_flash_supply_icon_stop|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== commander_start_structure_build ===
{{qnotice|Start a structure building}} 
{{begin-hl2msg|commander_start_structure_build|string}}
{{hl2msg|short|team|The team that is building the structure}}
{{hl2msg|short|type|The structure type}}
{{end-hl2msg}}
=== promoted_to_commander ===
{{qnotice|}} 
{{begin-hl2msg|promoted_to_commander|string}}
{{hl2msg|short|userid|The user that got promoted to commander}}
{{hl2msg|short|teamid|The team of the promoted commander}}
{{end-hl2msg}}
=== timeleft_10m ===
{{qnotice|10 minutes left of the round}} 
{{begin-hl2msg|timeleft_10m|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_5m ===
{{qnotice|5 minutes left of the round}} 
{{begin-hl2msg|timeleft_5m|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_1m ===
{{qnotice|1 minute left of the round}} 
{{begin-hl2msg|timeleft_1m|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_30s ===
{{qnotice|30 seconds left of the round}} 
{{begin-hl2msg|timeleft_30s|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_10s ===
{{qnotice|10 seconds left of the round}} 
{{begin-hl2msg|timeleft_10s|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== timeleft_5s ===
{{qnotice|5 seconds left of the round}} 
{{begin-hl2msg|timeleft_5s|string}}
{{hl2msg|1|local|}}
{{end-hl2msg}}
=== ach_hospital_duty_progress ===
{{qnotice|progress towards hospital duty achievement. fired client-side. commander only. same team.}} 
{{begin-hl2msg|ach_hospital_duty_progress|string}}
{{hl2msg|short|progress|}}
{{end-hl2msg}}
=== ach_high_maintenance_progress ===
{{qnotice|progress towards high maintenance achievement. fired client-side. commander only. same team.}} 
{{begin-hl2msg|ach_high_maintenance_progress|string}}
{{hl2msg|short|progress|}}
{{end-hl2msg}}

Game Events (Source)

2011-08-26T02:12:44Z

Peace-Maker:

These are all the games that the Source engine covers (that we could find).
* [[Generic Source Events]]
* [[Generic Source Server Events]]
* [[Counter-Strike: Source Events]]
* [[Day of Defeat: Source Events]]
* [[Half-Life 2: Deathmatch Events]]
* [[Half-Life 2: Capture the Flag Events]]
* [[Dystopia Events]]
* [[Pirates, Vikings, Knights II Events]]
* [[SourceForts Events]]
* [[Hidden: Source Events]]
* [[Perfect Dark: Source Events]]
* [[Iron Grip: Source Events]]
* [[Insurgency: Source Events]]
* [[Zombie Panic! Source Events]]
* [[Garry's Mod Events]]
* [[Team Fortress 2 Events]]
* [[Left 4 Dead Events]]
* [[Left 4 Dead 2 Events]]
* [[Neotokyo Events]]
* [[Alien Swarm Events]]
* [[Nuclear Dawn Events]]

== Credits ==
[[User:Shane|Shane]] - Writing some of the events pages and organization and general wikiknowhow 
[[User:FlyingMongoose|FlyingMongoose]] - Writing a lot of the events pages 
[[User:sslice|sslice]] - For creating a wikitizer application for these events 

[[Category:Metamod:Source Development]]
[[Category:SourceMod Development]]
[[Category:SourceMod Scripting]]

Building SourceMod

2011-07-12T00:24:43Z

Peace-Maker: /* Getting the Files */

Compiling SourceMod is not difficult, but requires a number of prerequisites. This article details the requirements and steps to being able to build working SourceMod binaries. These directions may change any time and may be updated as SourceMod's build process improves.

'''Note:''' You cannot use MingW to build working SourceMod Windows binaries. It is not ABI compatible with Visual C++ which is what Valve uses for the Source engine. You can only use GCC to build Linux binaries.

=Requirements=

==Windows==
*Microsoft Visual C++ 2008 (Express or higher) is supported and used for official builds.
*Microsoft Visual C++ 2005 (Express or higher) is unsupported.
*Microsoft Visual C++ 2003 7.1 or higher may not build out-of-box, but can build compatible binaries.
*Microsoft Visual C++ 2003 7.0 or lower '''cannot''' be used.

If you are installing Visual C++ 2005 Express, it may not come with Microsoft's Platform SDK installed. If this is the case, you must manually install the Platform SDK. You can find directions on how to do this and test your setup [http://www.microsoft.com/express/2005/platformsdk/default.aspx here]. Visual C++ 2008 "streamlines" the Platform SDK installation according to Microsoft.

==Linux==
For Linux, SourceMod requires the GNU C/C++ Compiler (from GCC):
*Version 4.1 is used for official binaries and is guaranteed to build.
*Versions 3.4 through 4.2 are guaranteed to be binary (ABI) compatible, although SourceMod may not necessarily build out-of-box against them.
*Any GCC version below 3.4 '''cannot''' be used.

==CPU==
SourceMod is strictly a 32-bit x86 (IA32) product. You should not try to force a compiler to build 64-bit binaries of SourceMod.

Your CPU and its compiler must support SSE in order to build SourceMod. To build without needing or having a dependency against SSE, please see the [[Compiling SourceMod#Removing SSE|Removing SSE]] section near the bottom.

Approximate compiling times for SourceMod's Core are roughly:
*Windows, Core 2 Quad E6600: 30 seconds (using /MP)
*Windows, Core 2 Duo E6600: 75 seconds
*Windows, Centrino 1.8GHz: 5 minutes
*Linux, Core 2 Duo E6600: <= 1 minute
*Linux, P3 Dual 500MHz: >= 7 minutes

=Setup=
This section describes how to set up your computer for compiling.

==Getting the Files==
This section describes which files you must obtain and how to obtain them. Do not worry about where to place them yet -- that will be discussed on a per-platform basis. You can download the files anywhere you'd like.

The recommended method of getting the required files is via [http://mercurial.selenic.com/ Mercurial]. We have our own [[Mercurial_Tutorial]] if you prefer that method. Although you do not need both HL2SDK versions (unless you wish to build binaries against both), you do need both Metamod:Source versions. Extensions don't necessarily require Metamod:Source (or even the Source Engine) but its template library is used extensively in SourceMod.

*SourceMod. For full download options, see the [http://www.sourcemod.net/downloads.php SourceMod Downloads] page. Obviously, you must download the source code and not a binary package.
*HL2SDK Original. As of this writing (Sep 2008) this engine is used for most Source games, except for TF2, GMod10, and DoD:S. Repository: [http://hg.alliedmods.net/hl2sdks/hl2sdk hl2sdk]
*HL2SDK OrangeBox. As of this writing (Sep 2008) this engine is used TF2, GMod10, and DoD:S. Repository: [http://hg.alliedmods.net/hl2sdks/hl2sdk-ob hl2sdk-ob]
*HL2SDK Left4Dead. This engine is used for L4D. Repository: [http://hg.alliedmods.net/hl2sdks/hl2sdk-l4d hl2sdk-l4d]
*Metamod:Source Source Code. Visit [http://www.metamodsource.net/?go=downloads Metamod:Source downloads]. Right now SourceMod builds against Metamod:Source 1.7.

'''Note''' that when we refer to "Metamod:Source" in this article, we are referring to its source code tree, not a binary package.

If you intend to compile the MySQL extension, you must also download MySQL 5.0. You can use any version. For simplicity, here are the versions we use:
*Linux: We use the 5.0.45 binary from the "[http://dev.mysql.com/downloads/mysql/5.0.html#linux Linux (non RPM packages)]" for "Linux (x86)." You can also use [http://dev.mysql.com/get/Downloads/MySQL-5.0/mysql-5.0.45-linux-i686-glibc23.tar.gz/from/pick this direct link] (may not be valid in the future).
*Windows: Due to a MySQL build change we use 5.0.24a which is an older download. The file name was "mysql-5.0.24a-win32.zip," if you can't find it you can use this [http://www.bailopan.net/mysql-5.0.24a-win32.zip direct link] (may not be valid in the future).

You can remove all folders from the distribution except for the "lib" and "include" folders which comprise the MySQL SDK.

==Linux==
As of this writing, SourceMod's Makefiles are hardcoded to use a binary called "gcc-4.1" You can override this, for example:
<pre>make CPP=gcc</pre>

Otherwise, you can also just create a symlink:
<pre>sudo ln -s /usr/bin/gcc /usr/bin/gcc-4.1</pre>

Note that you must use <tt>gcc</tt> and not <tt>g++</tt>.

SourceMod's Makefiles have strict directory organizational rules. You must have a top-level folder. For this document, we'll assume it is called <tt>sourcemod</tt>, though it can be named anything. The layout of <tt>sourcemod</tt> must be:
*<tt>sourcemod</tt>/
**<tt>hl2sdk</tt> - symlink or folder containing the HL2SDK
**<tt>hl2sdk-ob</tt> - symlink or folder containing the HL2SDK for Orange Box/TF
**<tt>mmsource-1.7</tt> - symlink or folder containing any Metamod:Source version 1.7 or higher.
**<tt>sourcemod-central</tt> - folder containing SourceMod's source code tree. This can be named anything, as long as it's a valid SourceMod tree (like [http://hg.alliedmods.net/sourcemod-central sourcemod-central]). You can also use [http://hg.alliedmods.net/sourcemod-1.1 sourcemod-1.1].
**<tt>mysql-5.0</tt> - symlink or folder containing a MySQL 5.0 distribution

If you are using a 64-bit version of Linux, you may need to install extra packages to be able to compile SourceMod. On Debian-based distros, these are typically:
<pre>
#prerequisites
#apt-get install g++-4.1 gcc-4.1 make subversion
#apt-get install libz libz-dev
#only needed if you want to use the build tool
#apt-get install mono mono-devel
#32-bit support
apt-get install ia32-libs
apt-get install lib32z1 lib32z1-dev
apt-get install libc6-dev-i386 libc6-i386
</pre>

==Windows==
On Windows we don't require a particular directory layout. Instead, environment variables are used. The directions below apply to Windows XP, and are assumed to be similar for other versions of Windows.
*Open the Control Panel (for example, via Start -> Settings).
*Open the System control. If you don't see it, you may need to switch to "Classic view" (either via the left-hand pane or by going to Tools -> Folder Options).
*Click the Advanced tab.
*Click the Environment Variables button.

You can add your environment variables to either your User settings or your System settings. Create a new variable for each item in the list below. The item names are in <tt>fixed-width font</tt> and their value descriptions follow.
*<tt>MMSOURCE17</tt> - Path to Metamod:Source 1.7+
*<tt>MMSOURCE18</tt> - Path to Metamod:Source 1.8+
*<tt>HL2SDK</tt> - Path to HL2SDK Ep1/Original
*<tt>HL2SDKOB</tt> - Path to HL2SDK Ep2/OrangeBox for mods
*<tt>HL2SDKOBVALVE</tt> - Path to HL2SDK Ep2/OrangeBox for Valve games (TF2 and DoD:S)
*<tt>HL2SDKL4D</tt> - Path to HL2SDK L4D1
*<tt>HL2SDKL4D2</tt> - Path to HL2SDK L4D2

=Building=
SourceMod has two types of binaries: those with an engine/MM:S dependence, and those without ("normal" binaries). Normal binaries have two modes:
*<tt>Release</tt> - Optimized binary for release.
*<tt>Debug</tt> - Unoptimized binary with debugging checks.

Engine/MM:S dependent binaries have three build modes, each paired with either Release or Debug, meaning there are six build options total. They are:
*<tt>Original</tt> - Building against MM:S 1.4 API with HL2SDK
*<tt>Episode2</tt> - Building against MM:S 1.6 API with HL2SDK-OB or higher

==Linux==
For both Normal and Engine/MM:S dependent binaries, the object files and the final binary are placed in a folder called <tt>Release</tt> or <tt>Debug</tt> (in the same level as the Makefile) depending on which building mechanism you chose.

'''Note:''' Our Makefiles are not set up to detect changes in header files. If you change a header file, you must clean your build.

===Normal Binaries===
For normal binaries, you can build simply with:

<pre>make</pre>

You can clean stale object files with:
<pre>make clean</pre>

Or build debug builds with:
<pre>make DEBUG=true</pre>

===Dependent Binaries===
Binaries that have an Engine or MM:S dependency require one extra parameter, <tt>ENGINE</tt>. It must be either <tt>orangebox</tt> or <tt>original</tt>. For example, to build a TF-compatible binary in debug mode:

<pre>make ENGINE=orangebox DEBUG=true</pre>

Dependent binaries are dropped into one of the following folders:
*Debug.original
*Debug.orangebox
*Release.original
*Release.orangebox

==Windows==
Windows project files end with <tt>.vcproj</tt> and are found in an <tt>msvc8</tt> folder that resides inside each binary's main source folder. For example, Core is located in <tt>core/msvc8/sourcemod_mm.vcproj</tt>.

Once the file is opened, you can select which build to use by going to Build -> Configuration Manager. Normal binaries have simply "Debug" and "Release." Dependent binaries have the following builds:
*Debug - Old Metamod
*Debug - Episode 2
*Release - Old Metamod
*Release - Episode 2

'''Note''' that dependent binaries will have plain "Debug" and "Release" builds. These should not be used as they are not configured.

Once you have selected a configuration, you can compile by going to Build -> Build Solution. The binaries and object files will be written to a folder inside <tt>msvc8</tt> named after the full configuration name. For example, using "Debug - Old Metamod" with the "sdktools" extension will result in the binary: <tt>extensions/sdktools/msvc8/Debug - Old Metamod/sdktools.ext.dll</tt>

'''Note:''' Visual Studio detects changes to header files intelligently. It is usually not necessary to rebuild a solution.

=Binary Organization=
Although SourceMod has a somewhat unified building mechanism, each of the binaries has a different purpose. They can be separated into the following classes:

*Core-Related: Binaries which are required or loaded intrinsically by Core.
*Extensions: Binaries which are loaded via the extension mechanism.
*External: Binaries which are standalone or unrelated to SourceMod's live operation (for example, the compiler).

This article is only concerned with the first two types.

==Core-Related Binaries==
Binaries related to Core are spread throughout the source code tree. They are always placed in <tt>sourcemod/bin</tt> for packaging. The projects files related to Core are:

*<tt>loader</tt> - This is a very small wrapper binary responsible for detecting the MM:S version and game engine, and deciding which SourceMod version to load. The output binary is <tt>sourcemod_mm_i486.so</tt> or <tt>sourcemod_mm.dll</tt>.
*<tt>core</tt> - This is Core itself, and is a dependent binary. It has three outputs:
**Original: <tt>sourcemod.1.ep1.so</tt>/<tt>sourcemod.1.ep1.dll</tt>
**Episode 1: <tt>sourcemod.1.ep1.so</tt>/<tt>sourcemod.2.ep1.dll</tt> (unsupported, not packaged)
**Episode 2: <tt>sourcemod.1.ep1.so</tt>/<tt>sourcemod.2.ep2.dll</tt>
*<tt>sourcepawn/jit/x86</tt> - This is the SourcePawn JIT for generating IA32/x86 instructions from <tt>.smx</tt> files. Currently the source code for this is not made available. It is built as <tt>sourcepawn.jit.x86.so</tt>/<tt>sourcepawn.jit.x86.dll</tt>.

It is technically not necessary to use the loader. It is provided as a convenience so users do not have to perform extra steps while installing SourceMod. However, it is highly recommend that you do use it in order to maintain similarity with the default SourceMod package.

==Extensions==
Extensions are found in the <tt>extensions</tt> folder of the source tree. SDKTools, Cstrike, and the upcoming TF extension are engine/MM:S dependent (and the rest are generally not).

Extensions always are named <tt>name.ext.so</tt> or <tt>name.ext.dll</tt> where <tt>name</tt> is a unique identifier. This is true even of dependent binaries.

When loading extensions, SourceMod looks in two separate folders. First, it checks the ''dependent extension folder'', which is <tt>extensions/auto.x.y</tt> where <tt>x</tt> is the MM:S version (1 for 1.4, 2 for 1.6) and <tt>y</tt> is the Engine version (1 for Original/Ep1, 2 for Ep2/OrangeBox). If no matching extension is found there, it looks in <tt>extensions</tt>.

For example, the SDKTools binary on Counter-Strike would be loaded from <tt>extensions/auto.1.ep1</tt>, but the GeoIP binary (which is not dependent) would be loaded from <tt>extensions</tt>.

=Removing SSE=
SourceMod binaries are built against SSE by default. SSE is an important set of optimizations, that, according to Valve's hardware survey, are supported on 99.6% percent of respondents' computers. If you are in this 0.4% which does not have SSE support, you should consider buying a newer processor. Only early Pentium 3-grade processors did not have SSE support (for example, the very early Durons), and it is likely your Source server will not perform adequately to support more than few players.

Nonetheless, SourceMod's binaries can all be recompiled to remove its SSE dependence.

==Linux==
Edit the Makefile of the binary you are trying to compile. Remove all instances of these flags. They can simply be erased, there is no need to replace them with anything.
*<tt>-msse</tt>
*<tt>-mfpmath=sse</tt>

Make sure to clean the build after changing the Makefile.

==Windows==
Load the project file into Visual Studio. Go to Project -> Properties. Expand "Configuration Properties," and then "C/C++" under it. Select "Code Generation." Change the setting "Enable Enhanced Instruction Set" to "Not Set."

'''Note:''' You must change this setting '''for each build configuration''' that you wish to use.

[[Category:SourceMod Documentation]]
[[Category:SourceMod Development]]

Counter-Strike: Source Events

2011-07-05T01:15:50Z

Peace-Maker:

:''Refer back to [[Game Events (Source)]] for more events.''

All cstrike mod events can be found in cstrike\resource\modevents.res

=== player_death ===
{{qnotice|When a client dies}}
{{begin-hl2msg|player_death|string}}
{{hl2msg|short|userid|user ID who died}}
{{hl2msg|short|attacker|user ID who killed}}
{{hl2msg|string|weapon|weapon name killer used }}
{{hl2msg|bool|headshot|singals a headshot}}
{{end-hl2msg}}

=== player_hurt ===
{{qnotice|When a client is damaged}}
{{begin-hl2msg|player_hurt|string}}
{{hl2msg|short|userid|user ID who was hurt}}
{{hl2msg|short|attacker|user ID who attacked}}
{{hl2msg|byte|health|remaining health points}}
{{hl2msg|byte|armor|remaining armor points}}
{{hl2msg|string|weapon|weapon name attacker used, if not the world}}
{{hl2msg|byte|dmg_health|damage done to health}}
{{hl2msg|byte|dmg_armor|damage done to armor}}
{{hl2msg|byte|hitgroup|hitgroup that was damaged}}
{{end-hl2msg}}

=== bomb_beginplant ===
{{qnotice|When the bomb is starting to get planted}}
{{begin-hl2msg|bomb_beginplant|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|site}}
{{end-hl2msg}}

=== bomb_abortplant ===
{{qnotice|When the bomb planter stops planting the bomb}}
{{begin-hl2msg|bomb_abortplant|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|site}}
{{end-hl2msg}}

=== bomb_planted ===
{{qnotice|When the bomb has been planted}}
{{begin-hl2msg|bomb_planted|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|site}}
{{hl2msg|short|posx}}
{{hl2msg|short|posy}}
{{end-hl2msg}}

=== bomb_defused ===
{{qnotice|When the bomb has been defused}}
{{begin-hl2msg|bomb_defused|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|site}}
{{end-hl2msg}}

=== bomb_exploded ===
{{qnotice|When the bomb explodes}}
{{begin-hl2msg|bomb_exploded|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|site}}
{{end-hl2msg}}

=== bomb_dropped ===
{{qnotice|When the bomb is dropped by a client}}
{{begin-hl2msg|bomb_dropped|string}}
{{hl2msg|short|userid}}
{{end-hl2msg}}

=== bomb_pickup ===
{{qnotice|When the bomb is picked up by a client}}
{{begin-hl2msg|bomb_pickup|string}}
{{hl2msg|short|userid}}
{{end-hl2msg}}

=== bomb_begindefuse ===
{{qnotice|When the bomb is started to be defused}}
{{begin-hl2msg|bomb_begindefuse|string}}
{{hl2msg|short|userid}}
{{hl2msg|bool|haskit}}
{{end-hl2msg}}

=== bomb_abortdefuse ===
{{qnotice|When the bomb defusal is stopped}}
{{begin-hl2msg|bomb_abortdefuse|string}}
{{hl2msg|short|userid}}
{{end-hl2msg}}

=== hostage_follows ===
{{qnotice|When the hostage begins following a client}}
{{begin-hl2msg|hostage_follows|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|hostage}}
{{end-hl2msg}}

=== hostage_hurt ===
{{qnotice|When a hostage is damaged}}
{{begin-hl2msg|hostage_hurt|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|hostage}}
{{end-hl2msg}}

=== hostage_killed ===
{{qnotice|When a hostage is killed}}
{{begin-hl2msg|hostage_killed|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|hostage}}
{{end-hl2msg}}

=== hostage_rescued ===
{{qnotice|When a hostage is rescued}}
{{begin-hl2msg|hostage_rescued|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|hostage}}
{{hl2msg|short|site}}
{{end-hl2msg}}

=== hostage_stops_following ===
{{qnotice|When a hostage stops following a client}}
{{begin-hl2msg|hostage_stops_following|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|hostage}}
{{end-hl2msg}}

=== hostage_rescued_all ===
{{qnotice|When all the hostages are rescued}}
{{begin-hl2msg|hostage_rescued_all|string}}
{{hl2msg|''none''|''none''}}
{{end-hl2msg}}

=== hostage_call_for_help ===
{{qnotice|When the hostage calls for help}}
{{begin-hl2msg|hostage_call_for_help|string}}
{{hl2msg|short|hostage}}
{{end-hl2msg}}

=== vip_escaped ===
{{qnotice|When the VIP escapes}}
{{begin-hl2msg|vip_escaped|string}}
{{hl2msg|short|userid}}
{{end-hl2msg}}

=== vip_killed ===
{{qnotice|When the VIP is killed}}
{{begin-hl2msg|vip_killed|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|attacker}}
{{end-hl2msg}}

=== player_radio ===
{{qnotice|When the player uses radio commands}}
{{begin-hl2msg|player_radio|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|slot}}
{{end-hl2msg}}

=== bomb_beep ===
{{qnotice|Every time the bomb beep sound happens}}
{{begin-hl2msg|bomb_beep|string}}
{{hl2msg|long|entindex|c4 entity}}
{{end-hl2msg}}

=== weapon_fire ===
{{qnotice|Every time a client fires their weapon}}
{{begin-hl2msg|weapon_fire|string}}
{{hl2msg|short|userid}}
{{hl2msg|string|weapon|weapon name used}}
{{end-hl2msg}}

=== weapon_fire_on_empty ===
{{qnotice|Every time a client fires their weapon and it's empty}}
{{begin-hl2msg|weapon_fire_on_empty|string}}
{{hl2msg|short|userid}}
{{hl2msg|string|weapon|weapon name used}}
{{end-hl2msg}}

=== weapon_reload ===
{{qnotice|Every time a client reloads their weapon}}
{{begin-hl2msg|weapon_reload|string}}
{{hl2msg|short|userid}}
{{end-hl2msg}}

=== weapon_zoom ===
{{qnotice|Every time a client zooms a scoped weapon}}
{{begin-hl2msg|weapon_zoom|string}}
{{hl2msg|short|userid}}
{{end-hl2msg}}

=== item_pickup ===
{{qnotice|Every time an item is picked up (generally weapons)}}
{{begin-hl2msg|item_pickup|string}}
{{hl2msg|short|userid}}
{{hl2msg|string|item|either a weapon such as 'tmp' or 'hegrenade', or an item such as 'nvgs'}}
{{end-hl2msg}}

=== grenade_bounce ===
{{qnotice|Every time a grenade bounces}}
{{begin-hl2msg|grenade_bounce|string}}
{{hl2msg|short|userid}}
{{end-hl2msg}}

=== hegrenade_detonate ===
{{qnotice|Every time a hegrenade explodes}}
{{begin-hl2msg|hegrenade_detonate|string}}
{{hl2msg|short|userid}}
{{hl2msg|float|x}}
{{hl2msg|float|y}}
{{hl2msg|float|z}}
{{end-hl2msg}}

=== flashbang_detonate ===
{{qnotice|Every time a flashbang detonates}}
{{begin-hl2msg|flashbang_detonate|string}}
{{hl2msg|short|userid}}
{{hl2msg|float|x}}
{{hl2msg|float|y}}
{{hl2msg|float|z}}
{{end-hl2msg}}

=== smokegrenade_detonate ===
{{qnotice|Every time a smokegrenade detonates}}
{{begin-hl2msg|smokegrenade_detonate|string}}
{{hl2msg|short|userid}}
{{hl2msg|float|x}}
{{hl2msg|float|y}}
{{hl2msg|float|z}}
{{end-hl2msg}}

=== bullet_impact ===
{{qnotice|Every time a bullet hits something}}
{{begin-hl2msg|bullet_impact}}
{{hl2msg|short|userid}}
{{hl2msg|float|x}}
{{hl2msg|float|y}}
{{hl2msg|float|z}}
{{end-hl2msg}}

=== player_footstep ===
{{qnotice|Every time a player takes a step}}
{{begin-hl2msg|player_footstep|string}}
{{hl2msg|short|userid}}
{{end-hl2msg}}

=== player_jump ===
{{qnotice|Every time a player jumps}}
{{begin-hl2msg|player_jump|string}}
{{hl2msg|short|userid}}
{{end-hl2msg}}

=== player_blind ===
{{qnotice|Every time a player is blinded by a flashbang}}
{{begin-hl2msg|player_blind|string}}
{{hl2msg|short|userid}}
{{end-hl2msg}}

=== player_falldamage ===
{{qnotice|Every time a player takes damage due to a fall}}
{{begin-hl2msg|player_falldamage|string}}
{{hl2msg|short|userid}}
{{hl2msg|float|damage}}
{{end-hl2msg}}

=== door_moving ===
{{qnotice|Every time a door is put in motion (opened)}}
{{begin-hl2msg|door_moving|string}}
{{hl2msg|long|entindex}}
{{hl2msg|short|userid}}
{{end-hl2msg}}

=== round_freeze_end ===
{{qnotice|When the round's mp_freezetime is up}}
{{begin-hl2msg|round_freeze_end|string}}
{{hl2msg|none|none}}
{{end-hl2msg}}

=== nav_blocked ===
{{qnotice|''Guess: Called when an area is blocked by the nav of a map''}}
{{begin-hl2msg|nav_blocked|string}}
{{hl2msg|long|area}}
{{hl2msg|bool|blocked}}
{{end-hl2msg}}

=== nav_generate ===
{{qnotice|Called when a nav file does not exist for a map and bots are added}}
{{begin-hl2msg|nav_generate|string}}
{{hl2msg|none|none}}
{{end-hl2msg}}

=== player_stats_updated ===
{{qnotice|''Guess: Called when the player stats (achievments) are sent to valve''}}
{{begin-hl2msg|player_stats_updated|string}}
{{hl2msg|bool|forceupload}}
{{end-hl2msg}}

=== spec_target_updated ===
{{qnotice|-}}
{{begin-hl2msg|spec_target_updated|string}}
{{hl2msg|none|none}}
{{end-hl2msg}}

=== cs_win_panel_round ===
{{qnotice|Called at the end of a round}}
{{begin-hl2msg|cs_win_panel_round|string}}
{{hl2msg|bool|show_timer_defend}}
{{hl2msg|bool|show_timer_attack}}
{{hl2msg|short|timer_time}}
{{hl2msg|byte|final_event|defined in cs_gamerules.h}}
{{hl2msg|string|funfact_token}}
{{hl2msg|short|funfact_player}}
{{hl2msg|long|funfact_data1}}
{{hl2msg|long|funfact_data2}}
{{hl2msg|long|funfact_data3}}
{{end-hl2msg}}

=== cs_win_panel_match ===
{{qnotice|Called at the end of the map}}
{{begin-hl2msg|cs_win_panel_match|string}}
{{hl2msg|short|t_score}}
{{hl2msg|short|ct_score}}
{{hl2msg|float|t_kd}}
{{hl2msg|float|ct_kd}}
{{hl2msg|short|t_objectives_done}}
{{hl2msg|short|ct_objectives_done}}
{{hl2msg|long|t_money_earned}}
{{hl2msg|long|ct_money_earned}}
{{end-hl2msg}}

=== show_freezepanel ===
{{qnotice|-}}
{{begin-hl2msg|show_freezepanel|string}}
{{hl2msg|short|killer|entindex of the killer entity}}
{{end-hl2msg}}

=== hide_freezepanel ===
{{qnotice|-}}
{{begin-hl2msg|hide_freezepanel|string}}
{{hl2msg|none|none}}
{{end-hl2msg}}

=== freezecam_started ===
{{qnotice|-}}
{{begin-hl2msg|freezecam_started|string}}
{{hl2msg|none|none}}
{{end-hl2msg}}

=== player_avenged_teammate ===
{{qnotice|-}}
{{begin-hl2msg|player_avenged_teammate|string}}
{{hl2msg|short|avenger_id}}
{{hl2msg|short|avenged_player_id}}
{{end-hl2msg}}

=== achievement_earned ===
{{qnotice|-}}
{{begin-hl2msg|achievement_earned|string}}
{{hl2msg|byte|player|entindex of the player}}
{{hl2msg|short|achievement|achievement ID}}
{{end-hl2msg}}

=== achievement_earned_local ===
{{qnotice|-}}
{{begin-hl2msg|achievement_earned_local|string}}
{{hl2msg|short|achievement|achievement ID}}
{{end-hl2msg}}

=== match_end_conditions ===
{{qnotice|-}}
{{begin-hl2msg|match_end_conditions|string}}
{{hl2msg|long|frags}}
{{hl2msg|long|max_rounds}}
{{hl2msg|long|win_rounds}}
{{hl2msg|long|time}}
{{end-hl2msg}}

=== round_mvp ===
{{qnotice|-}}
{{begin-hl2msg|round_mvp|string}}
{{hl2msg|short|userid}}
{{hl2msg|short|reason}}
{{end-hl2msg}}

=== player_decal ===
{{qnotice|-}}
{{begin-hl2msg|player_decal|string}}
{{hl2msg|short|userid}}
{{end-hl2msg}}

=== teamplay_round_start ===
{{qnotice|-}}
{{begin-hl2msg|teamplay_round_start|string}}
{{hl2msg|bool|full_reset}}
{{end-hl2msg}}