GetNpcArmorUpgrades: Difference between revisions
Jump to navigation
Jump to search
Document armor catalogs and eight armor-upgrade Lua APIs from upcoming 0.1.9; public release unchanged |
Release 0.1.9 / BUILD264 / Protocol42: availability and download setup; preserve experimental limits |
||
| Line 2: | Line 2: | ||
<div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;"> | <div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;"> | ||
<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">AVAILABLE FROM UPDATE 0.1.9</div> | <div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">AVAILABLE FROM UPDATE 0.1.9</div> | ||
<div style="color:#111111; margin-top:0.25rem;">Available from 0.1.9 | <div style="color:#111111; margin-top:0.25rem;">Available from 0.1.9.</div> | ||
</div> | </div> | ||
| Line 29: | Line 29: | ||
== Notes == | == Notes == | ||
* Server-side only; available from 0.1.9 | * Server-side only; available from 0.1.9. | ||
* See [[Armor upgrades]], [[Armor catalog]] and [[Armor upgrade catalog]]. | * See [[Armor upgrades]], [[Armor catalog]] and [[Armor upgrade catalog]]. | ||
* Read-only; reading does not require NPC ownership. | * Read-only; reading does not require NPC ownership. | ||
Latest revision as of 13:27, 20 October 2026
getNpcArmorUpgrades
AVAILABLE FROM UPDATE 0.1.9
Available from 0.1.9.
Reads the canonical selected armor pieces for a scripted NPC.
Syntax
parts = getNpcArmorUpgrades(npcId)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
npcId |
number |
yes | Existing scripted human NPC ID: finite integer 1..4294967295, not a numeric string. |
Returns
A table with top, mid and bottom strings; empty slots are "". Returns false for an invalid/unavailable ID or invalid argument count/type. A valid character with no selected parts returns three empty strings, not false.
Examples
local parts = getNpcArmorUpgrades(npcId)
if parts then outputDebugString(parts.top) end
Notes
- Server-side only; available from 0.1.9.
- See Armor upgrades, Armor catalog and Armor upgrade catalog.
- Read-only; reading does not require NPC ownership.
- Equivalent alias: GetNpcArmorUpgrades.