View source for GetPlayerBody

<!-- This page is generated automatically from the function definition: getPlayerBody. -->
= 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]]