Revision as of 21:43, 15 August 2026

setPlayerBody

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

bool setPlayerBody(int playerId, string bodyKey)

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

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

Use Milten's complete character appearance:

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

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.

@@ Line 21: / Line 21: @@
 == Examples ==
-Use Milten's complete prebaked character model:
+Use Milten's complete character appearance:
 <syntaxhighlight lang="lua" line>
 if not setPlayerBody(playerId, "milten") then
@@ Line 30: / Line 30: @@
 == Notes ==
 * Available only in server-side resource scripts.
-* A named body contains its original head because G1R does not export those NPC meshes as independently composable body parts.
+* A named body includes the character's original body, head and outfit or armor appearance.
-* Set the head to <code>default</code> before selecting a named body. Non-default heads are valid only with <code>body = default</code>.
+* Set the body to <code>default</code> before selecting an independent head or displaying separately equipped armor.
 * The reliable state is replayed during relevance entry and late join.
 * This emits <code>onPlayerBodyChange</code> when accepted.