SetPlayerSkin
setPlayerSkin
Changes a player's authoritative legacy skin-surface preset.
Syntax
bool setPlayerSkin(int playerId, string skinKey)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
playerId |
int |
yes | The connected player identifier. |
skinKey |
string |
yes | A stable key returned by getPlayerSkinNames.
|
Returns
Returns true when the validated preset is accepted and replicated; otherwise returns false.
Examples
Apply a validated skin-surface preset:
if not setPlayerSkin(playerId, "cor_kalom") then
outputChatBox("The selected skin is unavailable.", playerId)
end
Notes
- Available only in server-side resource scripts.
- This is the compatibility channel for Mutable skin, tattoo and scar data. It is separate from the full-body and head state.
- A selected named full-body preset takes visual precedence until the player returns to
body = default. - The reliable state is sent immediately to relevant players and replayed during late join and relevance entry.
- This emits
onPlayerSkinChangewhen accepted. - See Player skin catalog for every currently supported key.