SetPlayerHead - Revision history

QCherry: Document Protocol 23 voice and player presentation APIs

2026-08-24T06:13:11Z

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: setPlayerHead. -->		<!-- This page is generated automatically from the function definition: setPlayerHead. -->
	= setPlayerHead =		= setPlayerHead =
	~~Changes~~ a player's ~~independent Nameless Hero~~ head ~~option~~.		Deprecated compatibility API that changes a player's legacy head layer.

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

	== Examples ==		== Examples ==
	~~Select the second editable~~ head:		Use Milten's head and hair without replacing equipped armor:
	<syntaxhighlight lang="lua" line>		<syntaxhighlight lang="lua" line>
	~~setPlayerBody(playerId, "default")~~		if not setPlayerHead(playerId, "milten") then
	if not setPlayerHead(playerId, "~~head_02~~") then
	outputChatBox("The head option could not be applied.", playerId)		outputChatBox("The head option could not be applied.", playerId)
	end		end
Line 31:		Line 30:
	== Notes ==		== Notes ==
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* ~~This API writes the validated Mutable~~ <code>~~Head~~</code> ~~option~~ and never accepts raw Unreal paths.		* Deprecated: use <code>setPlayerIdentity</code> to apply a complete supported identity atomically.
	* ~~To display an independent head, set~~ the ~~body to <code>default</code>. Named body presets retain their original head~~.		* This API accepts only catalog keys and never accepts raw Unreal paths.
			* Named entries are composed with the current GTO face geometry and authoritative 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>onPlayerHeadChange</code> when accepted.		* This emits <code>onPlayerHeadChange</code> when accepted.
Line 40:		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:40Z

Clarify player appearance API behavior

← Older revision		Revision as of 21:43, 15 August 2026
Line 32:		Line 32:
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* This API writes the validated Mutable <code>Head</code> option and never accepts raw Unreal paths.		* This API writes the validated Mutable <code>Head</code> option and never accepts raw Unreal paths.
	* ~~A non-~~default head ~~is rejected while a named full-body preset is active~~.		* To display an independent head, set the body to <code>default</code>. Named body presets retain their original head.
	* 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>onPlayerHeadChange</code> when accepted.		* This emits <code>onPlayerHeadChange</code> when accepted.

QCherry: Document player skin, body and head appearance API

2026-08-15T18:59:31Z

Document player skin, body and head appearance API

New page

= setPlayerHead =
Changes a player's independent Nameless Hero head option.

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

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

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

== Examples ==
Select the second editable head:
<syntaxhighlight lang="lua" line>
setPlayerBody(playerId, "default")
if not setPlayerHead(playerId, "head_02") then
outputChatBox("The head option could not be applied.", playerId)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* This API writes the validated Mutable <code>Head</code> option and never accepts raw Unreal paths.
* A non-default head is rejected while a named full-body preset is active.
* The reliable state is replayed during relevance entry and late join.
* This emits <code>onPlayerHeadChange</code> when accepted.

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