GetPlayerBodyNames: Difference between revisions
Jump to navigation
Jump to search
Document player skin, body and head appearance API |
Document Protocol 23 voice and player presentation APIs |
||
| (One intermediate revision by the same user not shown) | |||
| 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 = | ||
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 | Returns a one-based array of stable face-profile keys. The first entry is <code>default</code>. | ||
== Examples == | == Examples == | ||
List every available | 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. | ||
* | * Deprecated: use <code>getPlayerIdentityNames</code> for complete character identities or <code>getPlayerFaceNames</code> for face-only profiles. | ||
* | * This is a compatibility alias for <code>getPlayerFaceNames</code>. | ||
* See [[Player | * The profile controls GTO skin traits, proportions and mimic data. It does not replace armor or select hair. | ||
* See [[Player face catalog]] for the complete list. | |||
[[Category:Lua Functions]] | [[Category:Lua Functions]] | ||
| Line 32: | Line 33: | ||
[[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
getPlayerBodyNames
Deprecated compatibility API that returns the validated legacy face-profile keys exposed by the server.
Syntax
table getPlayerBodyNames()
Parameters
This function does not accept parameters.
Returns
Returns a one-based array of stable face-profile keys. The first entry is default.
Examples
List every available legacy body/face profile:
for _, bodyKey in ipairs(getPlayerBodyNames()) do
outputDebugString(bodyKey)
end
Notes
- Available only in server-side resource scripts.
- Deprecated: use
getPlayerIdentityNamesfor complete character identities orgetPlayerFaceNamesfor face-only profiles. - This is a compatibility alias for
getPlayerFaceNames. - The profile controls GTO skin traits, proportions and mimic data. It does not replace armor or select hair.
- See Player face catalog for the complete list.