SetPlayerHead
setPlayerHead
Deprecated compatibility API that changes a player's legacy head layer.
Syntax
bool setPlayerHead(int playerId, string headKey)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
playerId |
int |
yes | The connected player identifier. |
headKey |
string |
yes | A stable key returned by getPlayerHeadNames.
|
Returns
Returns true when the compatible head is accepted and replicated; otherwise returns false.
Examples
Use Milten's head and hair without replacing equipped armor:
if not setPlayerHead(playerId, "milten") then
outputChatBox("The head option could not be applied.", playerId)
end
Notes
- Available only in server-side resource scripts.
- Deprecated: use
setPlayerIdentityto apply a complete supported identity atomically. - This API accepts only catalog keys and never accepts raw Unreal paths.
- Named entries are composed with the current GTO face geometry and authoritative armor.
- The reliable state is replayed during relevance entry and late join.
- This emits
onPlayerHeadChangewhen accepted.