Armor catalog: 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 1: | Line 1: | ||
= Armor catalog = | = Armor catalog = | ||
'''Available from 0.1.9 | '''Available from 0.1.9.''' Both client and server need the matching update. | ||
Complete list of the 26 base armor keys exposed by [[getPlayerArmorNames]] | Complete list of the 26 base armor keys exposed by [[getPlayerArmorNames]] from 0.1.9. The first 24 keys already existed; Royal Guard and Judge are new catalog additions in 0.1.9. The 84 selectable upgrade pieces are listed separately in [[Armor upgrade catalog]]. | ||
A guild base is not a complete heavy outfit. Equip the base, then select its parts or a preset with [[Armor upgrades|the armor-upgrade API]]. Use the exact lowercase keys below. Display names are explanatory English labels, not localized inventory text. | A guild base is not a complete heavy outfit. Equip the base, then select its parts or a preset with [[Armor upgrades|the armor-upgrade API]]. Use the exact lowercase keys below. Display names are explanatory English labels, not localized inventory text. | ||
Latest revision as of 13:26, 20 October 2026
Armor catalog
Available from 0.1.9. Both client and server need the matching update. Complete list of the 26 base armor keys exposed by getPlayerArmorNames from 0.1.9. The first 24 keys already existed; Royal Guard and Judge are new catalog additions in 0.1.9. The 84 selectable upgrade pieces are listed separately in Armor upgrade catalog.
A guild base is not a complete heavy outfit. Equip the base, then select its parts or a preset with the armor-upgrade API. Use the exact lowercase keys below. Display names are explanatory English labels, not localized inventory text.
Base armor keys (26)
| Key | Name | Upgrade pieces | Notes |
|---|---|---|---|
mercenary |
Mercenary | 18 | Existing base; selectable parts from 0.1.9. |
rogue |
Rogue | 18 | Existing base; selectable parts from 0.1.9. |
guard |
Guard | 18 | Existing base; selectable parts from 0.1.9. |
shadow |
Shadow | 18 | Existing base; selectable parts from 0.1.9. |
templar |
Templar | 8 | Existing base; selectable parts from 0.1.9. |
novice |
Novice | 4 | Existing base; selectable parts from 0.1.9. |
high_fire_robe |
High Fire Mage robe | 0 | Existing standalone garment; no selectable upgrade parts. |
fire_robe |
Fire Mage robe | 0 | Existing standalone garment; no selectable upgrade parts. |
high_water_robe |
High Water Mage robe | 0 | Existing standalone garment; no selectable upgrade parts. |
water_robe |
Water Mage robe | 0 | Existing standalone garment; no selectable upgrade parts. |
high_guru_robe |
High Guru robe | 0 | Existing standalone garment; no selectable upgrade parts. |
guru_robe |
Guru robe | 0 | Existing standalone garment; no selectable upgrade parts. |
heavy_baron_armor_01 |
Heavy Baron armor 01 | 0 | Existing standalone garment; no selectable upgrade parts. No verified default server protection profile; this is not a measured zero-protection value. |
heavy_baron_armor_02 |
Heavy Baron armor 02 | 0 | Existing standalone garment; no selectable upgrade parts. No verified default server protection profile; this is not a measured zero-protection value. |
medium_baron_armor |
Medium Baron armor | 0 | Existing standalone garment; no selectable upgrade parts. No verified default server protection profile; this is not a measured zero-protection value. |
heavy_ore_armor |
Heavy Ore armor | 0 | Existing standalone garment; no selectable upgrade parts. |
medium_ore_armor |
Medium Ore armor | 0 | Existing standalone garment; no selectable upgrade parts. |
nameless_hero_clothes |
Nameless Hero clothes | 0 | Existing standalone garment; no selectable upgrade parts. No verified default server protection profile; this is not a measured zero-protection value. |
qa_test_armor |
QA test armor | 0 | Existing standalone garment; no selectable upgrade parts. No verified default server protection profile; this is not a measured zero-protection value. Diagnostic garment, not a recommended production reward. |
crawler_plate_armor |
Crawler plate armor | 0 | Existing standalone garment; no selectable upgrade parts. |
dread_robe |
Dread robe | 0 | Existing standalone garment; no selectable upgrade parts. |
medium_digger_dress |
Medium digger dress | 0 | Existing standalone garment; no selectable upgrade parts. |
light_digger_dress |
Light digger dress | 0 | Existing standalone garment; no selectable upgrade parts. |
scraper_dress |
Scraper dress | 0 | Existing standalone garment; no selectable upgrade parts. |
royal_guard_armor |
Royal Guard armor | 0 | Catalog addition from 0.1.9. Native definition found; separate wear/visual validation and default protection qualification remain. |
judge_robe |
Judge robe | 0 | Catalog addition from 0.1.9. Native definition found; separate wear/visual validation and default protection qualification remain. |
How to use the keys
- givePlayerItem grants inventory ownership. setPlayerArmor equips a player base; ownership and requirements are checked.
- setNpcArmor equips a scripted NPC owned by the calling resource. It does not require a player inventory.
- getArmorUpgrades lists compatible pieces; getArmorUpgradePresets returns complete slot selections for a family.
- setPlayerArmorPreset and setNpcArmorPreset select parts for the already equipped base. They do not choose a different base or grant items.
- getItemStats and getItemStatDefinitions describe effective protection, overrides and supported fields. Unknown defaults must not be treated as confirmed values. See Item type stats.
The list is the exposed multiplayer catalog, not a guarantee that every possible identity/outfit combination renders correctly. Verify the identities and garments used by your gamemode. No new game assets are created by these functions.