Difference between revisions of "SDKHooks"

From AlliedModders Wiki
Jump to: navigation, search
m (→‎Introduction)
 
(44 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
==Introduction==
 
==Introduction==
 
SDKHooks was previously an external extension to Sourcemod. It was rolled in [https://wiki.alliedmods.net/Sourcemod_1.5.0_API_Changes#SDKHooks Sourcemod 1.5] and it does not need to be manually installed anymore.
 
SDKHooks was previously an external extension to Sourcemod. It was rolled in [https://wiki.alliedmods.net/Sourcemod_1.5.0_API_Changes#SDKHooks Sourcemod 1.5] and it does not need to be manually installed anymore.
 +
SDKHooks blocks hooking the same hook twice.
  
−
==Under CSS==
+
==Hooks==
−
===Non-regular cases for SDKHook_OnTakeDamage===
+
Some information on various hooks below:
 +
===SDKHook_Blocked===
 +
===SDKHook_BlockedPost===
 +
===SDKHook_CanBeAutobalanced===
 +
===SDKHook_EndTouch===
 +
===SDKHook_EndTouchPost===
 +
===SDKHook_FireBulletsPost===
 +
Not all games use FireBullets so this hook will not trigger in such games.
 +
===SDKHook_GetMaxHealth===
 +
  (ep2v and later)
 +
===SDKHook_GroundEntChangedPost===
 +
===SDKHook_OnTakeDamage===
 +
inflictor (3rd argument) is the entity that inflicts the damage. If a player directly damages another, inflictor should be equal to the attacking player id. An example of an indirect damage would be a grenade.
 +
 
 +
====Under CSS====
 +
'''Non-regular cases for SDKHook_OnTakeDamage'''
 
In the scenario where a player throw a grenade to another player then quickly disconnect, the attacker (2nd argument) will become the inflictor (3rd argument).  
 
In the scenario where a player throw a grenade to another player then quickly disconnect, the attacker (2nd argument) will become the inflictor (3rd argument).  
  
−
In the scenario where a player fall; the attacker, which is also the inflictor, will be 0.
+
In the scenario where a player fall; the attacker, which is also the inflictor, will be 0 (the world).
  
−
In the scenario where a terrorist plant the bomb, when the bomb explodes, the attacker (2nd argument) will be the same as the inflictor (3rd argument) which will have the Classname "planted_c4".
+
In the scenario where a terrorist plants the bomb, when the bomb explodes, the attacker (2nd argument) will be the same as the inflictor (3rd argument) which will have the Classname "planted_c4".
  
−
===Some damage types===
+
'''Some damage types'''
−
A normal HEGrenade and the C4 inflicts damage of type DMG_BLAST.
+
A normal HEGrenade and the C4 inflict damage of type DMG_BLAST.
  
 
A fall inflicts damage of type DMG_FALL.
 
A fall inflicts damage of type DMG_FALL.
  
−
A normal gun bullet will inflicts damage of type (DMG_BULLET | DMG_NEVERGIB) (non-headshot) or (DMG_BULLET | DMG_NEVERGIB | (1 << 30) ) when its a (headshot).
+
A grenade impact (for instance a flash hitting a teammate) will inflict damage of type DMG_CLUB.
 +
 
 +
A normal gun bullet and the knife will inflict damage of type (DMG_BULLET | DMG_NEVERGIB) (non-headshot) or (DMG_BULLET | DMG_NEVERGIB | (1 << 30) ) (headshot).
 +
 
 +
A single attack can trigger many SDKHook_OnTakeDamage; when a gun throws pullets for instance (shotgun and glock in burst-mode notably).
 +
 
 +
 
 +
(Regarding SM/Admin damaged; maybe place this is another section if someone can be sure that this would occur on all mods)
 +
 
 +
sm_slap does not trigger SDKHook_OnTakeDamage.
 +
 
 +
sm_burn will trigger two different callback : an entity with the classname "entityflame" will deal once 0 damage of type DMG_BURN and once 1 damage of type (DMG_BURN | DMG_DIRECT) every tick.
 +
 
 +
'''Regarding SDKHook_OnTakeDamage and SDKHook_OnTakeDamageAlive'''
 +
 
 +
SDKHook_OnTakeDamage/Post is triggered when hitting a teammate with mp_friendlyfire 0 (except in TF2), but not SDKHook_OnTakeDamageAlive.
 +
 
 +
====Under TF2====
 +
Under TF2, the SDKHook_OnTakeDamage hook isn't 100% accurate, it's damage parameter is the weapon's base damage. the DMG_CRIT flag is for both crits and minicrits. Weapon spread and minicrit/crit damage is calculated after this call (in SDKHook_OnTakeDamageAlive/Post).
 +
 
 +
'''Some damage types'''
 +
Shotgun = DMG_BUCKSHOT | DMG_SLOWBURN
 +
 
 +
Rocket Launcher = DMG_SLOWBURN | DMG_RADIATION | DMG_BLAST
 +
 
 +
If a crit, |= DMG_CRIT
 +
 
 +
===SDKHook_OnTakeDamagePost===
 +
===SDKHook_OnTakeDamageAlive===
 +
This hook works in a similar way to SDKHook_OnTakeDamage but it gives the [https://bugs.alliedmods.net/show_bug.cgi?id=6249#c7 actual, calculated damage amount done to the player. The pre-hook will fire after an OnTakeDamage pre-hook, and the post-hook will fire before an OnTakeDamage post-hook. The health is subtracted in between pre and post unless the hook is blocked.] {{pr|149}}
  
−
A grenade impact (for instance a flash hitting a teammate) will inflicst damage of type DMG_CLUB.
+
[https://forums.alliedmods.net/showthread.php?p=2309798#post2309798 OnTakeDamageAlive is also only called for players.]
 +
===SDKHook_OnTakeDamageAlivePost===
 +
===SDKHook_PreThink===
 +
Called before OnGameFrame(), but only for the hooked entity.
 +
===SDKHook_PreThinkPost===
 +
===SDKHook_PostThink===
 +
===SDKHook_PostThinkPost===
 +
===SDKHook_Reload===
 +
===SDKHook_ReloadPost===
 +
===SDKHook_SetTransmit===
 +
===SDKHook_ShouldCollide===
 +
===SDKHook_Spawn===
 +
Triggers when the hooked entity is about to spawn. Entity creation and spawn are not the same thing. Some entity properties are not available until the entity spawns.
 +
===SDKHook_SpawnPost===
 +
Triggers when the hooked entity was spawned.
 +
===SDKHook_StartTouch===
 +
Triggers when the hooked entity is about to be touched by another entity. Not all entities can trigger/fire touch events. Adjusting collision groups for the entity can fix that.
 +
===SDKHook_StartTouchPost===
 +
===SDKHook_Think===
 +
===SDKHook_ThinkPost===
 +
===SDKHook_Touch===
 +
===SDKHook_TouchPost===
 +
===SDKHook_TraceAttack===
 +
===SDKHook_TraceAttackPost===
 +
===SDKHook_Use===
 +
===SDKHook_UsePost===
 +
===SDKHook_VPhysicsUpdate===
 +
Triggers when the hooked entity is about to update.
 +
===SDKHook_VPhysicsUpdatePost===
 +
===SDKHook_WeaponCanSwitchTo===
 +
===SDKHook_WeaponCanSwitchToPost===
 +
===SDKHook_WeaponCanUse===
 +
===SDKHook_WeaponCanUsePost===
 +
===SDKHook_WeaponDrop===
 +
Triggers when the hooked weapon is about to be dropped.
 +
====Under TF2====
 +
When a weapon is dropped in tf2, a new entity is created called tf_dropped_weapon and this new entity is not the same entity as the one that player had equipped nor do they share entity IDs. They share the m_iAccountID property however, which contains the steam ID of the owner of the weapon that dropped it. You cannot prevent weapon drop through this hook in TF2.
 +
===SDKHook_WeaponDropPost===
 +
Triggers when the hooked weapon was dropped.
 +
===SDKHook_WeaponEquip===
 +
Triggers when the hooked weapon is about to be equipped.
 +
===SDKHook_WeaponEquipPost===
 +
Triggers when the hooked weapon was equipped.
 +
===SDKHook_WeaponSwitch===
 +
Triggers when the hooked weapon is about to be switched for another one.
 +
===SDKHook_WeaponSwitchPost===
 +
Triggers when the hooked weapon was switched for another one.
 +
[[Category:SourceMod Scripting]]

Latest revision as of 11:24, 7 September 2025

Introduction

SDKHooks was previously an external extension to Sourcemod. It was rolled in Sourcemod 1.5 and it does not need to be manually installed anymore. SDKHooks blocks hooking the same hook twice.

Hooks

Some information on various hooks below:

SDKHook_Blocked

SDKHook_BlockedPost

SDKHook_CanBeAutobalanced

SDKHook_EndTouch

SDKHook_EndTouchPost

SDKHook_FireBulletsPost

Not all games use FireBullets so this hook will not trigger in such games.

SDKHook_GetMaxHealth

 (ep2v and later)

SDKHook_GroundEntChangedPost

SDKHook_OnTakeDamage

inflictor (3rd argument) is the entity that inflicts the damage. If a player directly damages another, inflictor should be equal to the attacking player id. An example of an indirect damage would be a grenade.

Under CSS

Non-regular cases for SDKHook_OnTakeDamage In the scenario where a player throw a grenade to another player then quickly disconnect, the attacker (2nd argument) will become the inflictor (3rd argument).

In the scenario where a player fall; the attacker, which is also the inflictor, will be 0 (the world).

In the scenario where a terrorist plants the bomb, when the bomb explodes, the attacker (2nd argument) will be the same as the inflictor (3rd argument) which will have the Classname "planted_c4".

Some damage types A normal HEGrenade and the C4 inflict damage of type DMG_BLAST.

A fall inflicts damage of type DMG_FALL.

A grenade impact (for instance a flash hitting a teammate) will inflict damage of type DMG_CLUB.

A normal gun bullet and the knife will inflict damage of type (DMG_BULLET | DMG_NEVERGIB) (non-headshot) or (DMG_BULLET | DMG_NEVERGIB | (1 << 30) ) (headshot).

A single attack can trigger many SDKHook_OnTakeDamage; when a gun throws pullets for instance (shotgun and glock in burst-mode notably).


(Regarding SM/Admin damaged; maybe place this is another section if someone can be sure that this would occur on all mods)

sm_slap does not trigger SDKHook_OnTakeDamage.

sm_burn will trigger two different callback : an entity with the classname "entityflame" will deal once 0 damage of type DMG_BURN and once 1 damage of type (DMG_BURN | DMG_DIRECT) every tick.

Regarding SDKHook_OnTakeDamage and SDKHook_OnTakeDamageAlive

SDKHook_OnTakeDamage/Post is triggered when hitting a teammate with mp_friendlyfire 0 (except in TF2), but not SDKHook_OnTakeDamageAlive.

Under TF2

Under TF2, the SDKHook_OnTakeDamage hook isn't 100% accurate, it's damage parameter is the weapon's base damage. the DMG_CRIT flag is for both crits and minicrits. Weapon spread and minicrit/crit damage is calculated after this call (in SDKHook_OnTakeDamageAlive/Post).

Some damage types Shotgun = DMG_BUCKSHOT | DMG_SLOWBURN

Rocket Launcher = DMG_SLOWBURN | DMG_RADIATION | DMG_BLAST

If a crit, |= DMG_CRIT

SDKHook_OnTakeDamagePost

SDKHook_OnTakeDamageAlive

This hook works in a similar way to SDKHook_OnTakeDamage but it gives the actual, calculated damage amount done to the player. The pre-hook will fire after an OnTakeDamage pre-hook, and the post-hook will fire before an OnTakeDamage post-hook. The health is subtracted in between pre and post unless the hook is blocked. PR 149

OnTakeDamageAlive is also only called for players.

SDKHook_OnTakeDamageAlivePost

SDKHook_PreThink

Called before OnGameFrame(), but only for the hooked entity.

SDKHook_PreThinkPost

SDKHook_PostThink

SDKHook_PostThinkPost

SDKHook_Reload

SDKHook_ReloadPost

SDKHook_SetTransmit

SDKHook_ShouldCollide

SDKHook_Spawn

Triggers when the hooked entity is about to spawn. Entity creation and spawn are not the same thing. Some entity properties are not available until the entity spawns.

SDKHook_SpawnPost

Triggers when the hooked entity was spawned.

SDKHook_StartTouch

Triggers when the hooked entity is about to be touched by another entity. Not all entities can trigger/fire touch events. Adjusting collision groups for the entity can fix that.

SDKHook_StartTouchPost

SDKHook_Think

SDKHook_ThinkPost

SDKHook_Touch

SDKHook_TouchPost

SDKHook_TraceAttack

SDKHook_TraceAttackPost

SDKHook_Use

SDKHook_UsePost

SDKHook_VPhysicsUpdate

Triggers when the hooked entity is about to update.

SDKHook_VPhysicsUpdatePost

SDKHook_WeaponCanSwitchTo

SDKHook_WeaponCanSwitchToPost

SDKHook_WeaponCanUse

SDKHook_WeaponCanUsePost

SDKHook_WeaponDrop

Triggers when the hooked weapon is about to be dropped.

Under TF2

When a weapon is dropped in tf2, a new entity is created called tf_dropped_weapon and this new entity is not the same entity as the one that player had equipped nor do they share entity IDs. They share the m_iAccountID property however, which contains the steam ID of the owner of the weapon that dropped it. You cannot prevent weapon drop through this hook in TF2.

SDKHook_WeaponDropPost

Triggers when the hooked weapon was dropped.

SDKHook_WeaponEquip

Triggers when the hooked weapon is about to be equipped.

SDKHook_WeaponEquipPost

Triggers when the hooked weapon was equipped.

SDKHook_WeaponSwitch

Triggers when the hooked weapon is about to be switched for another one.

SDKHook_WeaponSwitchPost

Triggers when the hooked weapon was switched for another one.

Retrieved from "https://wiki.alliedmods.net/index.php?title=SDKHooks&oldid=11847"