SetPlayerBody

From Wiki G1R-MP G1 Remake Multiplayer
Revision as of 18:59, 15 August 2026 by QCherry (talk | contribs) (Document player skin, body and head appearance API)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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 prebaked character model:

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 contains its original head because G1R does not export those NPC meshes as independently composable body parts.
  • Set the head to default before selecting a named body. Non-default heads are valid only with body = default.
  • The reliable state is replayed during relevance entry and late join.
  • This emits onPlayerBodyChange when accepted.