SetPlayerBody

setPlayerBody

Changes a player's authoritative full-body identity preset.

Syntax

bool setPlayerBody(int playerId, string bodyKey)

Parameters

Name	Type	Required	Description
playerId	int	yes	The connected player identifier.
bodyKey	string	yes	A stable key returned by getPlayerBodyNames.

Returns

Returns true when the compatible preset is accepted and replicated; otherwise returns false.

Examples

Use Milten's complete character appearance:

if not setPlayerBody(playerId, "milten") then
    outputChatBox("The body preset could not be applied.", playerId)
end

Notes

• Available only in server-side resource scripts.
• A named body includes the character's original body, head and outfit or armor appearance.
• Set the body to default before selecting an independent head or displaying separately equipped armor.
• The reliable state is replayed during relevance entry and late join.
• This emits onPlayerBodyChange when accepted.