GetArmorUpgradePresets: 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 31: | Line 31: | ||
== 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]]. | ||
* Names: light_1, light_2, medium_1, medium_2, heavy_1, heavy_2. Each slot uses the highest existing tier not exceeding the requested tier; sparse families can repeat pieces. none is accepted by preset setters but is not returned here. | * Names: light_1, light_2, medium_1, medium_2, heavy_1, heavy_2. Each slot uses the highest existing tier not exceeding the requested tier; sparse families can repeat pieces. none is accepted by preset setters but is not returned here. | ||
Latest revision as of 13:27, 20 October 2026
getArmorUpgradePresets
AVAILABLE FROM UPDATE 0.1.9
Available from 0.1.9.
Lists named compatible part selections for one base armor.
Syntax
presets = getArmorUpgradePresets(armorKey)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
armorKey |
string |
yes | Exact lowercase base key; not an upgrade part key. |
Returns
A table keyed by available preset names. Each value is {top=string, mid=string, bottom=string}; empty slots are empty strings. A known base with no parts returns {}. Unknown/wrong-type base returns false.
Examples
local presets = getArmorUpgradePresets("mercenary")
if presets and presets.heavy_2 then
outputDebugString(presets.heavy_2.top)
end
Notes
- Server-side only; available from 0.1.9.
- See Armor upgrades, Armor catalog and Armor upgrade catalog.
- Names: light_1, light_2, medium_1, medium_2, heavy_1, heavy_2. Each slot uses the highest existing tier not exceeding the requested tier; sparse families can repeat pieces. none is accepted by preset setters but is not returned here.
- Equivalent alias: GetArmorUpgradePresets.