https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ATomeGetCardDataAPI:TomeGetCardData - Revision history2026-10-17T22:57:29ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:TomeGetCardData&diff=30801&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:50:20Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Tome}}<br />
Returns the data of a Tome of Knowledge card, including where it is unlocked.<br />
<br />
<pre><br />
cardData = TomeGetCardData(cardId)<br />
</pre><br />
<br />
== Arguments ==<br />
;cardId : <code>number</code> – Card id, for example the <code>cardId</code> field of entries from [[API:TomeGetAchievementsSubTypeData|TomeGetAchievementsSubTypeData]] or [[API:TomeGetCardList|TomeGetCardList]].<br />
<br />
== Returns ==<br />
;cardData : <code>table</code> – The card's data. For an unknown id an error is logged and an empty table is returned.<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>cardId</code> || <code>number</code> || Card id.<br />
|-<br />
| <code>valueName</code> || <code>wstring</code> || Name of the card's value. <code>L"???"</code> for a locked card.<br />
|-<br />
| <code>suitName</code> || <code>wstring</code> || Name of the card's suit. <code>L"???"</code> for a locked card.<br />
|-<br />
| <code>iconNum</code> || <code>number</code> || Icon id for [[API:GetIconData|GetIconData]]. <code>0</code> for a locked card.<br />
|-<br />
| <code>suit</code> || <code>number</code> || Suit number. <code>0</code> for a locked card.<br />
|-<br />
| <code>value</code> || <code>number</code> || Value number. <code>0</code> for a locked card.<br />
|-<br />
| <code>rarity</code> || <code>number</code> || Rarity number. <code>2</code> for a locked card.<br />
|-<br />
| <code>unlockInfo</code> || <code>table</code> || Where the card is unlocked (see below). Filled for locked cards too.<br />
|}<br />
<br />
Fields of <code>unlockInfo</code>:<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>section</code> || <code>number</code> || Tome section of the unlocking entry, a <code>GameData.Tome.SECTION_*</code> value; <code>0</code> if none.<br />
|-<br />
| <code>entry</code> || <code>number</code> || Id of the unlocking entry in that section; <code>0</code> if none.<br />
|-<br />
| <code>name</code> || <code>wstring</code> || Name of the unlocking entry.<br />
|-<br />
| <code>text</code> || <code>wstring</code> || –<br />
|}<br />
<br />
== Details ==<br />
* The stock UI opens the Tome at <code>unlockInfo.section</code> / <code>unlockInfo.entry</code> when a card is clicked, unless both are <code>0</code>.<br />
* Exactly one argument must be passed.<br />
<br />
== Errors ==<br />
Written to the UI log; the function still returns a table.<br />
* <code>Error in function call 'TomeGetCardData': %d is not a valid card id.</code><br />
<br />
== Example ==<br />
From <code>default/ea_tomeofknowledge/source/tomewindow_rewards.lua</code>:<br />
<pre><br />
local cardData = TomeGetCardData( cardId )<br />
...<br />
if( cardData.unlockInfo.section == 0 and cardData.unlockInfo.entry == 0 ) then<br />
...<br />
TomeWindow.OpenTomeToEntry( cardData.unlockInfo.section, cardData.unlockInfo.entry )<br />
</pre><br />
<br />
From <code>default/ea_tomeofknowledge/source/tomewindow.lua</code>:<br />
<pre><br />
local texture, x, y = GetIconData( cardData.iconNum )<br />
...<br />
local cardName = GetFormatStringFromTable( "Default", StringTables.Default.TEXT_CARD_NAME, { cardData.valueName, cardData.suitName } )<br />
</pre><br />
<br />
== See also ==<br />
* [[API:TomeGetCardList|TomeGetCardList]]<br />
* [[API:TomeGetAchievementsSubTypeData|TomeGetAchievementsSubTypeData]]<br />
* [[API:TomeGetBestiarySpeciesData|TomeGetBestiarySpeciesData]]</div>Maintenance script