SetPlayerBody: Difference between revisions

From Wiki G1R-MP G1 Remake Multiplayer
Jump to navigation Jump to search
← Older edit

QCherry (talk | contribs)

3 user groups
887 edits
Document Protocol 23 voice and player presentation APIs
Document 0.1a Lua API, identities, moderation and synchronized spells
 
Line 1: Line 1:
<!-- This page is generated automatically from the function definition: setPlayerBody. -->
= setPlayerBody =
= setPlayerBody =
Deprecated compatibility API that changes a player's authoritative legacy face profile.
Deprecated compatibility API retained for legacy resources. It is unsupported for player appearance selection in G1R:MP 0.1.


== Syntax ==
== Syntax ==
Line 18: Line 17:


== Returns ==
== Returns ==
Returns <code>true</code> when the validated profile is accepted and replicated; otherwise returns <code>false</code>.
Returns <code>true</code> when the server accepts the legacy state; this does not guarantee a supported visual result in G1R:MP 0.1. Returns <code>false</code> when validation fails.


== Examples ==
== Examples ==
Apply Milten's GTO face profile through the compatibility API:
Migrate a legacy body call to the supported identity setter:
<syntaxhighlight lang="lua" line>
<syntaxhighlight lang="lua" line>
if not setPlayerBody(playerId, "milten") then
-- Deprecated: setPlayerBody(playerId, "milten")
    outputChatBox("The face profile could not be applied.", playerId)
setPlayerIdentity(playerId, "milten")
end
</syntaxhighlight>
</syntaxhighlight>


== Notes ==
== Notes ==
* Available only in server-side resource scripts.
* Available only in server-side resource scripts.
* Deprecated: use <code>setPlayerIdentity</code> for complete character identities or <code>setPlayerFace</code> for face-only changes.
* Deprecated and unsupported for appearance selection in G1R:MP 0.1. Use <code>setPlayerIdentity</code>; it is the only supported complete identity setter.
* Do not migrate to <code>setPlayerFace</code>, which is also deprecated and unsupported in 0.1.
* This is a compatibility alias for <code>setPlayerFace</code>.
* This is a compatibility alias for <code>setPlayerFace</code>.
* The profile controls GTO skin traits, proportions and mimic data. Head/hair and armor remain independent.
* The server may retain and replay the legacy state for protocol compatibility, but resources must not rely on a visible face/body-only change.
* The reliable state is replayed during relevance entry and late join.
* This emits both <code>onPlayerBodyChange</code> and <code>onPlayerFaceChange</code> when accepted.
* This emits both <code>onPlayerBodyChange</code> and <code>onPlayerFaceChange</code> when accepted.


Latest revision as of 11:36, 27 August 2026

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.
Retrieved from "https://g1r-mp.com/wiki/index.php?title=SetPlayerBody&oldid=664"