GetPlayerBodyNames - Revision history

QCherry: Document Protocol 23 voice and player presentation APIs

2026-08-24T06:12:09Z

Document Protocol 23 voice and player presentation APIs

← Older revision		Revision as of 06:12, 24 August 2026
Line 1:		Line 1:
	<!-- This page is generated automatically from the function definition: getPlayerBodyNames. -->		<!-- This page is generated automatically from the function definition: getPlayerBodyNames. -->
	= getPlayerBodyNames =		= getPlayerBodyNames =
	~~Returns every~~ validated ~~full~~-~~body identity preset~~ exposed by the server.		Deprecated compatibility API that returns the validated legacy face-profile keys exposed by the server.

	== Syntax ==		== Syntax ==
Line 12:		Line 12:

	== Returns ==		== Returns ==
	Returns a one-based array of stable ~~body~~ keys. The first entry is <code>default</code>.		Returns a one-based array of stable face-profile keys. The first entry is <code>default</code>.

	== Examples ==		== Examples ==
	List every available ~~full-~~body ~~preset~~:		List every available legacy body/face profile:
	<syntaxhighlight lang="lua" line>		<syntaxhighlight lang="lua" line>
	for _, bodyKey in ipairs(getPlayerBodyNames()) do		for _, bodyKey in ipairs(getPlayerBodyNames()) do
Line 24:		Line 24:
	== Notes ==		== Notes ==
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* ~~Named G1R characters are~~ complete ~~visual presets containing their original body, head and outfit~~ or ~~armor appearance.~~		* Deprecated: use <code>getPlayerIdentityNames</code> for complete character identities or <code>getPlayerFaceNames</code> for face-only profiles.
	* Independent head and armor visuals are shown with the <code>~~default~~</code> ~~body~~.		* This is a compatibility alias for <code>getPlayerFaceNames</code>.
	* ~~Use~~ <code>~~default~~</code> ~~to restore the editable Nameless Hero body~~.		* The profile controls GTO skin traits, proportions and mimic data. It does not replace armor or select hair.
	* See [[Player ~~body~~ catalog]] for the complete list.		* See [[Player face catalog]] for the complete list.

	[[Category:Lua Functions]]		[[Category:Lua Functions]]
Line 33:		Line 33:
	[[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:32Z

Clarify player appearance API behavior

← Older revision		Revision as of 21:43, 15 August 2026
Line 24:		Line 24:
	== Notes ==		== Notes ==
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* Named G1R ~~human~~ characters are ~~shipped as~~ complete ~~prebaked~~ body-and-head ~~skeletal meshes~~.		* Named G1R characters are complete visual presets containing their original body, head and outfit or armor appearance.
			* Independent head and armor visuals are shown with the <code>default</code> body.
	* Use <code>default</code> to restore the editable Nameless Hero body.		* Use <code>default</code> to restore the editable Nameless Hero body.
	* See [[Player body catalog]] for the complete list.		* See [[Player body catalog]] for the complete list.

QCherry: Document player skin, body and head appearance API

2026-08-15T18:59:23Z

Document player skin, body and head appearance API

New page

= getPlayerBodyNames =
Returns every validated full-body identity preset exposed by the server.

== Syntax ==
<syntaxhighlight lang="lua">
table getPlayerBodyNames()
</syntaxhighlight>

== Parameters ==
This function does not accept parameters.

== Returns ==
Returns a one-based array of stable body keys. The first entry is <code>default</code>.

== Examples ==
List every available full-body preset:
<syntaxhighlight lang="lua" line>
for _, bodyKey in ipairs(getPlayerBodyNames()) do
outputDebugString(bodyKey)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Named G1R human characters are shipped as complete prebaked body-and-head skeletal meshes.
* Use <code>default</code> to restore the editable Nameless Hero body.
* See [[Player body catalog]] for the complete list.

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