SetPlayerBody - Revision history

QCherry: Document 0.1a Lua API, identities, moderation and synchronized spells

2026-08-27T11:36:29Z

Document 0.1a Lua API, identities, moderation and synchronized spells

← Older revision		Revision as of 11:36, 27 August 2026
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.

QCherry: Document Protocol 23 voice and player presentation APIs

2026-08-24T06:13:07Z

Document Protocol 23 voice and player presentation APIs

← Older revision		Revision as of 06:13, 24 August 2026
Line 1:		Line 1:
	<!-- This page is generated automatically from the function definition: setPlayerBody. -->		<!-- This page is generated automatically from the function definition: setPlayerBody. -->
	= setPlayerBody =		= setPlayerBody =
	~~Changes~~ a player's authoritative ~~full-body identity preset~~.		Deprecated compatibility API that changes a player's authoritative legacy face profile.

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

	== Returns ==		== Returns ==
	Returns <code>true</code> when the ~~compatible preset~~ is accepted and replicated; otherwise returns <code>false</code>.		Returns <code>true</code> when the validated profile is accepted and replicated; otherwise returns <code>false</code>.

	== Examples ==		== Examples ==
	~~Use~~ Milten's ~~complete character appearance~~:		Apply Milten's GTO face profile through the compatibility API:
	<syntaxhighlight lang="lua" line>		<syntaxhighlight lang="lua" line>
	if not setPlayerBody(playerId, "milten") then		if not setPlayerBody(playerId, "milten") then
	outputChatBox("The ~~body preset~~ could not be applied.", playerId)		outputChatBox("The face profile could not be applied.", playerId)
	end		end
	</syntaxhighlight>		</syntaxhighlight>
Line 30:		Line 30:
	== Notes ==		== Notes ==
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* ~~A named body includes the~~ character~~'s original body, head and outfit~~ or ~~armor appearance~~.		* Deprecated: use <code>setPlayerIdentity</code> for complete character identities or <code>setPlayerFace</code> for face-only changes.
	* ~~Set the body to~~ <code>~~default~~</code> ~~before selecting an~~ independent ~~head or displaying separately equipped armor~~.		* 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 reliable state is replayed during relevance entry and late join.		* The reliable state is replayed during relevance entry and late join.
	* This emits <code>onPlayerBodyChange</code> when accepted.		* This emits both <code>onPlayerBodyChange</code> and <code>onPlayerFaceChange</code> when accepted.

	[[Category:Lua Functions]]		[[Category:Lua Functions]]
Line 39:		Line 40:
	[[Category:Player Functions]]		[[Category:Player Functions]]
	[[Category:Appearance Functions]]		[[Category:Appearance Functions]]
			[[Category:Deprecated Lua API]]

QCherry: Clarify player appearance API behavior

2026-08-15T21:43:38Z

Clarify player appearance API behavior

← Older revision		Revision as of 21:43, 15 August 2026
Line 21:		Line 21:

	== Examples ==		== Examples ==
	Use Milten's complete ~~prebaked~~ character ~~model~~:		Use Milten's complete character appearance:
	<syntaxhighlight lang="lua" line>		<syntaxhighlight lang="lua" line>
	if not setPlayerBody(playerId, "milten") then		if not setPlayerBody(playerId, "milten") then
Line 30:		Line 30:
	== Notes ==		== Notes ==
	* Available only in server-side resource scripts.		* 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.		* The reliable state is replayed during relevance entry and late join.
	* This emits <code>onPlayerBodyChange</code> when accepted.		* This emits <code>onPlayerBodyChange</code> when accepted.

QCherry: Document player skin, body and head appearance API

2026-08-15T18:59:30Z

Document player skin, body and head appearance API

New page

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

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerBody(int playerId, string bodyKey)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.
|-
| <code>bodyKey</code> || <code>string</code> || yes || A stable key returned by <code>getPlayerBodyNames</code>.
|}

== Returns ==
Returns <code>true</code> when the compatible preset is accepted and replicated; otherwise returns <code>false</code>.

== Examples ==
Use Milten's complete prebaked character model:
<syntaxhighlight lang="lua" line>
if not setPlayerBody(playerId, "milten") then
outputChatBox("The body preset could not be applied.", playerId)
end
</syntaxhighlight>

== 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 <code>default</code> before selecting a named body. Non-default heads are valid only with <code>body = default</code>.
* The reliable state is replayed during relevance entry and late join.
* This emits <code>onPlayerBodyChange</code> when accepted.

[[Category:Lua Functions]]
[[Category:Server Functions]]
[[Category:Player Functions]]
[[Category:Appearance Functions]]