Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:25Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Returns the item behind a Tome of Knowledge item reward, and where in the Tome it is unlocked.

<pre>
itemData = TomeGetItemRewardData(rewardId)
</pre>

== Arguments ==
;rewardId : <code>number</code> – Reward id: the <code>rewardId</code> of an item reward (reward type <code>GameData.Tome.REWARD_ITEM</code> or <code>REWARD_ITEM_NO_AUTOCREATE</code>), or of an entry from [[API:TomeGetItemRewardsList|TomeGetItemRewardsList]].

== Returns ==
;itemData : <code>table</code> – Always a table (possibly empty) when the argument is a number.

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>unlockInfo</code> || <code>table</code> || Where the reward is unlocked (see below).
|-
| item fields || various || When the client knows the item, the table also holds the item's data, in the same layout as other item tables (for example <code>name</code> and <code>iconNum</code>, which the stock UI reads).
|}

<code>unlockInfo</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>section</code> || <code>number</code> || Tome section of the unlocking entry, or <code>0</code>.
|-
| <code>entry</code> || <code>number</code> || Id of the unlocking entry in that section, or <code>0</code>.
|-
| <code>name</code> || <code>wstring</code> || Name of the unlocking entry.
|-
| <code>text</code> || <code>wstring</code> || Text describing the unlocking entry.
|}

== Details ==
* <code>section</code> and <code>entry</code> are both <code>0</code> when the reward has no unlocking entry. The stock UI then does not offer a link to it.
* If the id is not a valid item reward, an error is logged and an empty table is returned.
* The error message carries the name <code>TomeGetPlayerItemRewardData</code>.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>Error in function call 'TomeGetPlayerItemRewardData': %d is not a valid item reward id.</code>

== Example ==
From <code>ea_tomeofknowledge/source/tomewindow.lua</code>:
<pre>
local itemData = TomeGetItemRewardData( rewardData.rewardId )
iconNum = itemData.iconNum
</pre>

From <code>ea_tomeofknowledge/source/tomewindow_rewards.lua</code>:
<pre>
local itemData = TomeGetItemRewardData( itemId )
if( itemData == nil ) then
return
end

if( itemData.unlockInfo.section == 0 and itemData.unlockInfo.entry == 0 ) then
return
end

TomeWindow.OpenTomeToEntry( itemData.unlockInfo.section, itemData.unlockInfo.entry )
</pre>

== See also ==
* [[API:TomeGetItemRewardsList|TomeGetItemRewardsList]]
* [[API:TomeGetTacticRewardData|TomeGetTacticRewardData]]
* [[API:TomeGetPlayerTitleData|TomeGetPlayerTitleData]]

API:TomeGetItemRewardData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)