GetPlayerHead
getPlayerHead
Deprecated compatibility API that returns a player's authoritative legacy head layer.
Syntax
string|false getPlayerHead(int playerId)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
playerId |
int |
yes | The connected player identifier. |
Returns
Returns the stable head key, or false when the player is invalid or appearance state is unavailable.
Examples
Read a player's head option:
local headKey = getPlayerHead(playerId)
if headKey then
outputDebugString("Head: " .. headKey)
end
Notes
- Available only in server-side resource scripts.
- Deprecated: use
getPlayerIdentityfor complete character identity state. - The returned state is server-authoritative and late-join safe.
- The selected layer is independent from the GTO face profile and equipped armor.