Observing weapon hits

Example code for observing a weapon hit

Summary

Created: Oct 08 2025 by mana vortex Last documented update: Oct 08 2025 by mana vortex

This page shows a code sample for reacting to hits on NPCs.

OnWeaponHit

REDScript

// evt: https://nativedb.red4ext.com/gameHitEvent

@wrapMethod(NPCPuppet)
protected cb func OnHit(evt: ref<gameHitEvent>) -> Bool {
  wrappedMethod(evt);

  // check that the player was the one who hit this npc
  // https://nativedb.red4ext.com/AttackData
  let instigator: ref<GameObject> = evt.attackData.instigator;

  if IsDefined(instigator) && instigator.IsPlayer() {
    let record: ref<WeaponItem_Record> = evt.attackData.weapon.m_weaponRecord; // https://nativedb.red4ext.com/gamedataWeaponItem_Record
    let id = record.GetID();

    FTLog(s"weapon id: \(TDBID.ToStringDEBUG(id))");

    if Equals(id, t"Items.your_string_here") {
      FTLog(s"yay");
    }
  }
}

Lua

init.lua

local function OnWeaponHit(this, evt) -- https://nativedb.red4ext.com/gameHitEvent
  
  -- check that the player was the one who hit this npc
  -- https://nativedb.red4ext.com/AttackData
  if not IsDefined(evt.attackData.instigator) or not evt.attackData.instigator:IsPlayer() then return end
  
  local record = evt.attackData.weapon.weaponRecord -- https://nativedb.red4ext.com/gamedataWeaponItem_Record
    
  local id = record:GetID().value -- make sure to stringify the TweakDBID so we can print and search

  print("weapon id: " .. id);

  if string.find(id, "Items.your_string_here") then
    print("yay")
  end    
end

registerForEvent("onInit", function()  
  ObserveAfter('NPCPuppet', 'OnHit', OnWeaponHit)
end)  

IsCritical

REDScript

public func IsCritical(event: ref<gameHitEvent>) -> Bool {
  return IsDefined(event) && event.attackData.HasFlag(hitFlag.CriticalHit); 
}

Lua

local function IsCritical(evt)
  return evt.attackData:HasFlag(hitFlag.CriticalHit)
end

IsKill

REDScript

public func IsKill(event: ref<gameHitEvent>) -> Bool {
  return IsDefined(event) && event.attackData.HasFlag(hitFlag.Kill); 
}

Lua

local function IsKill(evt)
  return evt.attackData:HasFlag(hitFlag.Kill)
end