QCherry: Update Lua event reference

2026-08-14T22:31:43Z

Update Lua event reference

New page

= onPlayerHit =
Triggered after the server validates that one player hit another player.

== Availability ==
This event is available in '''server-side''' scripts.

== Callback signature ==
<syntaxhighlight lang="lua">
onPlayerHit(attackerId, targetId, damage, damageType, actionId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Description
|-
| <code>attackerId</code> || <code>int</code> || The attacking player ID.
|-
| <code>targetId</code> || <code>int</code> || The hit player ID.
|-
| <code>damage</code> || <code>number</code> || Validated damage applied by the server.
|-
| <code>damageType</code> || <code>string</code> || Damage source such as melee, spell, bow, crossbow, or a script-defined type.
|-
| <code>actionId</code> || <code>int or nil</code> || The replicated action ID when the originating flow provides one.
|}

== Examples ==
Handle the event:
<syntaxhighlight lang="lua" line>
addEventHandler("onPlayerHit", root, function(attackerId, targetId, damage, damageType, actionId)
outputDebugString(getPlayerName(attackerId) .. " hit " .. getPlayerName(targetId) .. " for " .. damage)
end)
</syntaxhighlight>

== Notes ==
* The final <code>actionId</code> is omitted by some scripted damage paths; handlers must accept <code>nil</code>.

[[Category:Lua Events]]
[[Category:Server Events]]
[[Category:Combat Events]]

OnPlayerHit - Revision history

QCherry: Update Lua event reference