SetPlayerBody

From Wiki G1R-MP G1 Remake Multiplayer
Revision as of 11:36, 27 August 2026 by QCherry (talk | contribs) (Document 0.1a Lua API, identities, moderation and synchronized spells)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

setPlayerBody

Deprecated compatibility API retained for legacy resources. It is unsupported for player appearance selection in G1R:MP 0.1.

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 server accepts the legacy state; this does not guarantee a supported visual result in G1R:MP 0.1. Returns false when validation fails.

Examples

Migrate a legacy body call to the supported identity setter:

-- Deprecated: setPlayerBody(playerId, "milten")
setPlayerIdentity(playerId, "milten")

Notes

  • Available only in server-side resource scripts.
  • Deprecated and unsupported for appearance selection in G1R:MP 0.1. Use setPlayerIdentity; it is the only supported complete identity setter.
  • Do not migrate to setPlayerFace, which is also deprecated and unsupported in 0.1.
  • This is a compatibility alias for setPlayerFace.
  • The server may retain and replay the legacy state for protocol compatibility, but resources must not rely on a visible face/body-only change.
  • This emits both onPlayerBodyChange and onPlayerFaceChange when accepted.