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

2026-08-27T11:36:31Z

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: setPlayerFace. -->~~
	= setPlayerFace =		= setPlayerFace =
	~~Changes a~~ player~~'s authoritative GTO face profile without replacing head/hair or armor~~.		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 ==
	~~Change only~~ the ~~GTO face shape and mimic profile~~:		Migrate a legacy face call to the supported identity setter:
	<syntaxhighlight lang="lua" line>		<syntaxhighlight lang="lua" line>
	~~if not~~ setPlayerFace(playerId, "milten") ~~then~~		-- Deprecated: setPlayerFace(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.
	* The ~~reliable~~ state ~~is replayed during relevance entry and late join~~.		* Deprecated and unsupported for appearance selection in G1R:MP 0.1. Use <code>setPlayerIdentity</code>; it is the only supported complete identity setter.
			* The server may retain and replay the legacy state for protocol compatibility, but resources must not rely on a visible face-only change.
	* This emits both <code>onPlayerFaceChange</code> and the legacy <code>onPlayerBodyChange</code> event.		* This emits both <code>onPlayerFaceChange</code> and the legacy <code>onPlayerBodyChange</code> event.

Line 37:		Line 36:
	[[Category:Player Functions]]		[[Category:Player Functions]]
	[[Category:Appearance Functions]]		[[Category:Appearance Functions]]
			[[Category:Deprecated Lua API]]

QCherry: Document Protocol 23 voice and player presentation APIs

2026-08-24T06:13:09Z

Document Protocol 23 voice and player presentation APIs

New page

= setPlayerFace =
Changes a player's authoritative GTO face profile without replacing head/hair or armor.

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

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

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

== Examples ==
Change only the GTO face shape and mimic profile:
<syntaxhighlight lang="lua" line>
if not setPlayerFace(playerId, "milten") then
outputChatBox("The face profile could not be applied.", playerId)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* The reliable state is replayed during relevance entry and late join.
* This emits both <code>onPlayerFaceChange</code> and the legacy <code>onPlayerBodyChange</code> event.

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

SetPlayerFace - Revision history

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

QCherry: Document Protocol 23 voice and player presentation APIs