Merge pull request #102 from LiliaFramework/codex/add-should-instakill-hook

Add ShouldInstantKill hook

Author: bleonheart

instakill/docs/hooks.md

@@ -1,3 +1,29 @@
+### `ShouldInstantKill`
+
+**Purpose**
+`Called before processing a headshot to determine if instant kill should occur.`
+
+**Parameters**
+
+* `player` (`Player`): `Victim receiving the hit.`
+* `damageInfo` (`CTakeDamageInfo`): `Damage information object.`
+
+**Realm**
+`Server`
+
+**Returns**
+`boolean` — `return false to ignore the instant kill.`
+
+**Example**
+
+```lua
+hook.Add("ShouldInstantKill", "ProtectNPCs", function(ply, dmginfo)
+    if ply:IsNPC() then return false end
+end)
+```
+
+---
+
 ### `PlayerPreInstantKill`
 
 **Purpose**

instakill/libraries/server.lua

@@ -1,5 +1,7 @@
-function MODULE:ScalePlayerDamage(client, hitgroup, dmgInfo)
+function MODULE:ScalePlayerDamage(client, hitgroup, dmgInfo)
     if lia.config.get("instakilling") and hitgroup == HITGROUP_HEAD then
+        if hook.Run("ShouldInstantKill", client, dmgInfo) == false then return end
+
         hook.Run("PlayerPreInstantKill", client, dmgInfo)
         dmgInfo:SetDamage(client:GetMaxHealth() * 5)
         hook.Run("PlayerInstantKilled", client, dmgInfo)