QCherry: Update Lua event reference

2026-08-14T22:31:50Z

Update Lua event reference

New page

= onPlayerLifeStateChange =
Triggered whenever the authoritative life state changes between alive, downed, and dead.

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

== Callback signature ==
<syntaxhighlight lang="lua">
onPlayerLifeStateChange(playerId, previousState, currentState, sourcePlayerId, reason, reviveAtServerTimeMs)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Description
|-
| <code>playerId</code> || <code>int</code> || The affected player ID.
|-
| <code>previousState</code> || <code>string</code> || The previous state: alive, downed, or dead.
|-
| <code>currentState</code> || <code>string</code> || The new state: alive, downed, or dead.
|-
| <code>sourcePlayerId</code> || <code>int</code> || The player responsible for the transition, if any.
|-
| <code>reason</code> || <code>string</code> || The transition reason.
|-
| <code>reviveAtServerTimeMs</code> || <code>int</code> || Scheduled server-time revival timestamp, or zero when not scheduled.
|}

== Examples ==
Handle the event:
<syntaxhighlight lang="lua" line>
addEventHandler("onPlayerLifeStateChange", root, function(playerId, previousState, currentState, sourcePlayerId, reason, reviveAtServerTimeMs)
outputDebugString(getPlayerName(playerId) .. ": " .. previousState .. " -> " .. currentState)
end)
</syntaxhighlight>

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

OnPlayerLifeStateChange - Revision history

QCherry: Update Lua event reference