Latest revision as of 06:12, 24 August 2026

getPlayerHead

Deprecated compatibility API that returns a player's authoritative legacy head layer.

string|false getPlayerHead(int playerId)

Name	Type	Required	Description
`playerId`	`int`	yes	The connected player identifier.

Returns the stable head key, or false when the player is invalid or appearance state is unavailable.

Read a player's head option:

local headKey = getPlayerHead(playerId)
if headKey then
    outputDebugString("Head: " .. headKey)
end

@@ Line 1: / Line 1: @@
 <!-- This page is generated automatically from the function definition: getPlayerHead. -->
 = getPlayerHead =
-Returns a player's authoritative independent head option.
+Deprecated compatibility API that returns a player's authoritative legacy head layer.
 == Syntax ==
@@ Line 29: / Line 29: @@
 == Notes ==
 * Available only in server-side resource scripts.
+* Deprecated: use <code>getPlayerIdentity</code> for complete character identity state.
 * The returned state is server-authoritative and late-join safe.
-* A named body preset retains its original rendered head even when a separate head state is stored.
+* The selected layer is independent from the GTO face profile and equipped armor.
 [[Category:Lua Functions]]
@@ Line 36: / Line 37: @@
 [[Category:Player Functions]]
 [[Category:Appearance Functions]]
+[[Category:Deprecated Lua API]]