SetNpcArmor
Jump to navigation
Jump to search
setNpcArmor
Changes the authoritative armor of a resource-owned scripted NPC.
Syntax
bool setNpcArmor(int npcId, string itemKey)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
npcId |
int |
yes | The server-assigned NPC identifier returned by spawnNpc or getNpcs.
|
itemKey |
string |
yes | A validated key returned by getPlayerArmorNames; armor and weapon accept none to clear the slot.
|
Returns
Returns true when the validated change is accepted and replicated; otherwise returns false.
Examples
Change an NPC's armor:
setNpcArmor(npcId, "none")
Notes
- Available only in server-side resource scripts.
- The state is sent reliably to current viewers and replayed on relevance entry and late join.
- Raw Unreal object paths are never accepted from Lua.
- Use
getPlayerArmorNamesto enumerate supported keys.
Appearance API since 0.1.5
From 0.1.5 setNpcIdentity, setNpcSkinColor and setNpcTattoo remain independent of armor. Changing or removing armor does not clear these values. Covered skin/tattoo regions naturally remain hidden by garments.