Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:32Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Returns an armor set of the Tome of Knowledge Old World Armory with its pieces.

<pre>
setData = TomeGetOldWorldArmoryArmorSet(armorSetId)
</pre>

== Arguments ==
;armorSetId : <code>number</code> – Armor set id, as in [[API:TomeGetOldWorldArmoryTOC|TomeGetOldWorldArmoryTOC]]. Only the low 16 bits are used.

== Returns ==
;setData : <code>table</code> – The set's data, or nothing if the id is invalid, the set is locked, or the player's data is not available.

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Armor set id.
|-
| <code>name</code> || <code>wstring</code> || Name of the set; empty if the name table is not loaded.
|-
| <code>pieces</code> || <code>table</code> || Array of piece tables (see below).
|}

Each piece table in <code>pieces</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>itemData</code> || <code>table</code> || [[API:GetInventoryItemData#Item data table|Item data table]] of the piece for the player. Missing when the client has no item data for the piece; the stock UI skips such pieces.
|-
| <code>unlocked</code> || <code>boolean</code> || Whether the player has unlocked the piece.
|}

== Details ==
* The piece item can differ between characters; the client picks it using the player's own data.
* Exactly one argument must be passed.

== Errors ==
These are written to the UI log, and the function returns nothing.
* <code>Error in function call 'TomeGetOldWorldArmoryArmorSet': %d is not a valid armor set id.</code>
* <code>Error in function call 'TomeGetOldWorldArmoryArmorSet': %d is not unlocked.</code>

== Example ==
From <code>default/ea_tomeofknowledge/source/tomewindow_oldworldarmory.lua</code>:
<pre>
local setData = TomeGetOldWorldArmoryArmorSet( armorSetId )
if not setData
...
for index, itemInfo in ipairs( setData.pieces )
do
if( not itemInfo.itemData )
...
LabelSetText( fullItemWindowName.."Name", itemInfo.itemData.name )
ButtonSetPressedFlag( fullItemWindowName.."CompletedBtn", itemInfo.unlocked )
</pre>

== See also ==
* [[API:TomeGetOldWorldArmoryTOC|TomeGetOldWorldArmoryTOC]]
* [[API:TomeGetOldWorldArmoryTierTOC|TomeGetOldWorldArmoryTierTOC]]

API:TomeGetOldWorldArmoryArmorSet - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)