QCherry: Update Lua event reference

2026-08-14T22:31:39Z

Update Lua event reference

New page

= onPlayerDead =
Compatibility alias triggered together with onPlayerDeath when health reaches zero.

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

== Callback signature ==
<syntaxhighlight lang="lua">
onPlayerDead(playerId, killerId, reason)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Description
|-
| <code>playerId</code> || <code>int</code> || The player whose health reached zero.
|-
| <code>killerId</code> || <code>int</code> || The responsible player ID, or the runtime's no-player value.
|-
| <code>reason</code> || <code>string</code> || The authoritative reason for the zero-health transition.
|}

== Examples ==
Handle the event:
<syntaxhighlight lang="lua" line>
addEventHandler("onPlayerDead", root, function(playerId, killerId, reason)
outputDebugString("Legacy death event for player " .. playerId)
end)
</syntaxhighlight>

== Notes ==
* Do not register the same policy on both [[onPlayerDeath]] and <code>onPlayerDead</code>, or it will run twice.

[[Category:Lua Events]]
[[Category:Server Events]]
[[Category:Life State Events]]

OnPlayerDead - Revision history

QCherry: Update Lua event reference