SetPlayerSkin - Revision history

QCherry: Document Protocol 23 voice and player presentation APIs

2026-08-24T06:13:22Z

Document Protocol 23 voice and player presentation APIs

← Older revision		Revision as of 06:13, 24 August 2026
Line 30:		Line 30:
	== Notes ==		== Notes ==
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* This is the compatibility channel for Mutable skin, tattoo and scar data. It is separate from the ~~full-body~~ and ~~head~~ state.		* This is the compatibility channel for Mutable skin, tattoo and scar data. It is separate from the identity and armor state.
	* A named body preset takes visual precedence over independent head and armor appearance while it is active.
	* The reliable state is sent immediately to relevant players and replayed during late join and relevance entry.		* The reliable state is sent immediately to relevant players and replayed during late join and relevance entry.
	* This emits <code>onPlayerSkinChange</code> when accepted.		* This emits <code>onPlayerSkinChange</code> when accepted.

QCherry: Clarify player appearance API behavior

2026-08-15T21:43:41Z

Clarify player appearance API behavior

← Older revision		Revision as of 21:43, 15 August 2026
Line 31:		Line 31:
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* This is the compatibility channel for Mutable skin, tattoo and scar data. It is separate from the full-body and head state.		* This is the compatibility channel for Mutable skin, tattoo and scar data. It is separate from the full-body and head state.
	* A ~~selected~~ named ~~full-~~body preset takes visual precedence ~~until the player returns to <code>body = default</code>~~.		* A named body preset takes visual precedence over independent head and armor appearance while it is active.
	* The reliable state is sent immediately to relevant players and replayed during late join and relevance entry.		* The reliable state is sent immediately to relevant players and replayed during late join and relevance entry.
	* This emits <code>onPlayerSkinChange</code> when accepted.		* This emits <code>onPlayerSkinChange</code> when accepted.

QCherry: Document player skin, body and head appearance API

2026-08-15T18:59:33Z

Document player skin, body and head appearance API

← Older revision		Revision as of 18:59, 15 August 2026
Line 1:		Line 1:
	<!-- This page is generated automatically from the function definition: setPlayerSkin. -->		<!-- This page is generated automatically from the function definition: setPlayerSkin. -->
	= setPlayerSkin =		= setPlayerSkin =
	Changes a player's authoritative ~~body~~-~~and-face appearance~~ preset.		Changes a player's authoritative legacy skin-surface preset.

	== Syntax ==		== Syntax ==
Line 21:		Line 21:

	== Examples ==		== Examples ==
	Apply ~~Milten's~~ validated ~~human appearance~~ preset:		Apply a validated skin-surface preset:
	<syntaxhighlight lang="lua" line>		<syntaxhighlight lang="lua" line>
	if not setPlayerSkin(playerId, "~~milten~~") then		if not setPlayerSkin(playerId, "cor_kalom") then
	outputChatBox("The selected skin is unavailable.", playerId)		outputChatBox("The selected skin is unavailable.", playerId)
	end		end
Line 30:		Line 30:
	== Notes ==		== Notes ==
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* ~~The~~ body and ~~face are changed together because G1R validates them through one CharacterDefinition and Mutable generation chain~~.		* This is the compatibility channel for Mutable skin, tattoo and scar data. It is separate from the full-body and head state.
			* A selected named full-body preset takes visual precedence until the player returns to <code>body = default</code>.
	* The reliable state is sent immediately to relevant players and replayed during late join and relevance entry.		* The reliable state is sent immediately to relevant players and replayed during late join and relevance entry.
	* This emits <code>onPlayerSkinChange</code> when accepted.		* This emits <code>onPlayerSkinChange</code> when accepted.

QCherry: Complete Lua function catalog

2026-08-15T09:55:34Z

Complete Lua function catalog

← Older revision		Revision as of 09:55, 15 August 2026
Line 35:		Line 35:
	* See [[Player skin catalog]] for every currently supported key.		* See [[Player skin catalog]] for every currently supported key.

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

QCherry: Update Lua API reference

2026-08-15T09:49:02Z

Update Lua API reference

New page

= setPlayerSkin =
Changes a player's authoritative body-and-face appearance preset.

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

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

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

== Examples ==
Apply Milten's validated human appearance preset:
<syntaxhighlight lang="lua" line>
if not setPlayerSkin(playerId, "milten") then
outputChatBox("The selected skin is unavailable.", playerId)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* The body and face are changed together because G1R validates them through one CharacterDefinition and Mutable generation chain.
* The reliable state is sent immediately to relevant players and replayed during late join and relevance entry.
* This emits <code>onPlayerSkinChange</code> when accepted.
* See [[Player skin catalog]] for every currently supported key.

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