QCherry: Document Protocol 23 voice and player presentation APIs

2026-08-24T06:14:59Z

Document Protocol 23 voice and player presentation APIs

New page

= onPlayerFaceChange =
Triggered after a validated authoritative GTO face profile has changed.

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

== Callback signature ==
<syntaxhighlight lang="lua">
onPlayerFaceChange(playerId, previousFace, newFace, sourceResource)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Description
|-
| <code>playerId</code> || <code>int</code> || The affected connected player ID.
|-
| <code>previousFace</code> || <code>string</code> || The previous stable face-profile key.
|-
| <code>newFace</code> || <code>string</code> || The new stable face-profile key.
|-
| <code>sourceResource</code> || <code>string</code> || The resource that requested the change.
|}

== Examples ==
Handle the event:
<syntaxhighlight lang="lua" line>
addEventHandler("onPlayerFaceChange", root, function(playerId, previousFace, newFace, sourceResource)
outputDebugString(getPlayerName(playerId) .. " face: " .. previousFace .. " -> " .. newFace)
end)
</syntaxhighlight>

== Notes ==
* Head/hair and armor are independent from this state.
* The corresponding reliable visual state is replayed during relevance entry and late join.

[[Category:Lua Events]]
[[Category:Server Events]]
[[Category:Player Events]]

OnPlayerFaceChange - Revision history

QCherry: Document Protocol 23 voice and player presentation APIs