GetPlayerHeadNames: Difference between revisions
Jump to navigation
Jump to search
Clarify player appearance API behavior |
Document Protocol 23 voice and player presentation APIs |
||
| Line 1: | Line 1: | ||
<!-- This page is generated automatically from the function definition: getPlayerHeadNames. --> | <!-- This page is generated automatically from the function definition: getPlayerHeadNames. --> | ||
= getPlayerHeadNames = | = getPlayerHeadNames = | ||
Deprecated compatibility API that returns every validated legacy head-layer option. | |||
== Syntax == | == Syntax == | ||
| Line 12: | Line 12: | ||
== Returns == | == Returns == | ||
Returns <code>default</code> | Returns a one-based array containing native Mutable options and named character identity layers. The first entry is <code>default</code>. | ||
== Examples == | == Examples == | ||
| Line 24: | Line 24: | ||
== Notes == | == Notes == | ||
* Available only in server-side resource scripts. | * Available only in server-side resource scripts. | ||
* | * Deprecated: use <code>getPlayerIdentityNames</code> for complete character identities. | ||
* | * The <code>head_01</code> and <code>head_02</code> entries use native Mutable geometry. | ||
* Named entries copy compatible face, eye and skin materials to the Mutable character and render only validated hair or beard sections on the common human skeleton. | |||
* No named entry includes the source character's armor. | |||
* See [[Player head catalog]] for the complete list. | |||
[[Category:Lua Functions]] | [[Category:Lua Functions]] | ||
| Line 31: | Line 34: | ||
[[Category:Player Functions]] | [[Category:Player Functions]] | ||
[[Category:Appearance Functions]] | [[Category:Appearance Functions]] | ||
[[Category:Deprecated Lua API]] | |||
Latest revision as of 06:12, 24 August 2026
getPlayerHeadNames
Deprecated compatibility API that returns every validated legacy head-layer option.
Syntax
table getPlayerHeadNames()
Parameters
This function does not accept parameters.
Returns
Returns a one-based array containing native Mutable options and named character identity layers. The first entry is default.
Examples
List the available independent heads:
for _, headKey in ipairs(getPlayerHeadNames()) do
outputDebugString(headKey)
end
Notes
- Available only in server-side resource scripts.
- Deprecated: use
getPlayerIdentityNamesfor complete character identities. - The
head_01andhead_02entries use native Mutable geometry. - Named entries copy compatible face, eye and skin materials to the Mutable character and render only validated hair or beard sections on the common human skeleton.
- No named entry includes the source character's armor.
- See Player head catalog for the complete list.