QCherry: Document Protocol 23 voice and player presentation APIs

2026-08-24T06:12:08Z

Document Protocol 23 voice and player presentation APIs

← Older revision		Revision as of 06:12, 24 August 2026
Line 1:		Line 1:
	<!-- This page is generated automatically from the function definition: getPlayerBody. -->		<!-- This page is generated automatically from the function definition: getPlayerBody. -->
	= getPlayerBody =		= getPlayerBody =
	~~Returns~~ a player's authoritative ~~full-body identity preset~~.		Deprecated compatibility API that returns a player's authoritative legacy face profile.

	== Syntax ==		== Syntax ==
Line 19:		Line 19:

	== Examples ==		== Examples ==
	Read a player's body ~~preset~~:		Read a player's legacy body/face profile:
	<syntaxhighlight lang="lua" line>		<syntaxhighlight lang="lua" line>
	local bodyKey = getPlayerBody(playerId)		local bodyKey = getPlayerBody(playerId)
Line 29:		Line 29:
	== Notes ==		== Notes ==
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
			* Deprecated: use <code>getPlayerIdentity</code> for complete character identity state or <code>getPlayerFace</code> for the face-only layer.
			* This is a compatibility alias for <code>getPlayerFace</code>.
	* The returned state is server-authoritative and late-join safe.		* The returned state is server-authoritative and late-join safe.

Line 35:		Line 37:
	[[Category:Player Functions]]		[[Category:Player Functions]]
	[[Category:Appearance Functions]]		[[Category:Appearance Functions]]
			[[Category:Deprecated Lua API]]

QCherry: Document player skin, body and head appearance API

2026-08-15T18:59:22Z

Document player skin, body and head appearance API

New page

= getPlayerBody =
Returns a player's authoritative full-body identity preset.

== Syntax ==
<syntaxhighlight lang="lua">
string|false getPlayerBody(int playerId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.
|}

== Returns ==
Returns the stable body key, or <code>false</code> when the player is invalid or appearance state is unavailable.

== Examples ==
Read a player's body preset:
<syntaxhighlight lang="lua" line>
local bodyKey = getPlayerBody(playerId)
if bodyKey then
outputDebugString("Body: " .. bodyKey)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* The returned state is server-authoritative and late-join safe.

[[Category:Lua Functions]]
[[Category:Server Functions]]
[[Category:Player Functions]]
[[Category:Appearance Functions]]

GetPlayerBody - Revision history

QCherry: Document Protocol 23 voice and player presentation APIs

QCherry: Document player skin, body and head appearance API