Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:21Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Returns the Tome of Knowledge cards the player has unlocked.

<pre>
cards = TomeGetCardList()
</pre>

== Arguments ==
None.

== Returns ==
;cards : <code>table</code> – Array of card tables, indexed from 1. Empty if no card is unlocked.

Each card table:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>cardId</code> || <code>number</code> || Card id. Pass it to [[API:TomeGetCardData|TomeGetCardData]] for the full data.
|-
| <code>valueName</code> || <code>wstring</code> || Name of the card's value; empty if the name table is not loaded.
|-
| <code>suitName</code> || <code>wstring</code> || Name of the card's suit; empty if the name table is not loaded.
|-
| <code>iconNum</code> || <code>number</code> || Icon id for [[API:GetIconData|GetIconData]].
|}

== Details ==
* Locked cards are left out.
* The list is in the client's card order, not sorted by name.

== Errors ==
None.

== Example ==
From <code>default/ea_tomeofknowledge/source/tomewindow_rewards.lua</code>:
<pre>
local cardList = TomeGetCardList()
...
local entryCount = 0
for index, entryData in ipairs( cardList ) do
entryCount = entryCount + 1
...
</pre>

== See also ==
* [[API:TomeGetCardData|TomeGetCardData]]

API:TomeGetCardList - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)