SetPlayerArmor

setPlayerArmor

Equips or clears a player's authoritative armor slot.

Syntax

bool setPlayerArmor(int playerId, string itemKey)

Parameters

Name	Type	Required	Description
playerId	int	yes	The connected player identifier.
itemKey	string	yes	A key returned by getPlayerArmorNames, or "none" to clear the slot.

Returns

Returns true when the equipment change is accepted and replicated; otherwise returns false.

Examples

Example 1

Give an item and equip it in the armor slot:

local itemKey = "water_robe"
if givePlayerItem(playerId, itemKey) then
    setPlayerArmor(playerId, itemKey)
end

Example 2

Clear the armor slot:

setPlayerArmor(playerId, "none")

Notes

• Available only in server-side resource scripts.
• The player must own at least one copy of a non-empty item before it can be equipped.
• The selected appearance is reliably synchronized and included in late-join state.