SetNpcArmor: Difference between revisions
Jump to navigation
Jump to search
Update Lua API reference |
Document new NPC/player-mode API and events available from 0.1.5 |
||
| (One intermediate revision by the same user not shown) | |||
| Line 32: | Line 32: | ||
* Use <code>getPlayerArmorNames</code> to enumerate supported keys. | * Use <code>getPlayerArmorNames</code> to enumerate supported keys. | ||
[[Category:Lua Functions]] | |||
[[Category:Server Functions]] | [[Category:Server Functions]] | ||
[[Category:World Functions]] | [[Category:World Functions]] | ||
[[Category:NPC Functions]] | [[Category:NPC Functions]] | ||
[[Category:Equipment Functions]] | [[Category:Equipment Functions]] | ||
<!-- npc-appearance015:start --> | |||
== 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. | |||
<!-- npc-appearance015:end --> | |||
Latest revision as of 17:37, 25 September 2026
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.