GetPlayerBody
getPlayerBody
Deprecated compatibility API that returns a player's authoritative legacy face profile.
Syntax
string|false getPlayerBody(int playerId)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
playerId |
int |
yes | The connected player identifier. |
Returns
Returns the stable body key, or false when the player is invalid or appearance state is unavailable.
Examples
Read a player's legacy body/face profile:
local bodyKey = getPlayerBody(playerId)
if bodyKey then
outputDebugString("Body: " .. bodyKey)
end
Notes
- Available only in server-side resource scripts.
- Deprecated: use
getPlayerIdentityfor complete character identity state orgetPlayerFacefor the face-only layer. - This is a compatibility alias for
getPlayerFace. - The returned state is server-authoritative and late-join safe.