Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:26Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Returns the item rewards the player has unlocked through the Tome of Knowledge.

<pre>
itemList = TomeGetItemRewardsList()
</pre>

== Arguments ==
None.

== Returns ==
;itemList : <code>table</code> – Array of item rewards.

Each entry:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>rewardId</code> || <code>number</code> || Id of the reward, for [[API:TomeGetItemRewardData|TomeGetItemRewardData]].
|-
| <code>itemId</code> || <code>number</code> || Id of the item. <code>0</code> while the client does not have the item's details yet.
|-
| <code>name</code> || <code>wstring</code> || Item name. Only present when <code>itemId</code> is not 0.
|-
| <code>iconNum</code> || <code>number</code> || Icon number for <code>GetIconData</code>. Only present when <code>itemId</code> is not 0.
|-
| <code>type</code> || <code>number</code> || The item's type. Only present when <code>itemId</code> is not 0.
|}

== Details ==
* Only rewards the player has unlocked are listed.

== Errors ==
None.

== Example ==
From <code>ea_tomeofknowledge/source/tomewindow_rewards.lua</code>:
<pre>
local itemList = TomeGetItemRewardsList()
...
for index, entryData in ipairs( itemList ) do
WindowSetId( entryWindowName, entryData.rewardId )
if( entryData.itemId ~= 0 )
then
ButtonSetText( entryWindowName.."Text", entryData.name )
local texture, x, y = GetIconData( entryData.iconNum )
DynamicImageSetTexture( entryWindowName.."IconIconBase", texture, x, y )
else
ButtonSetText( entryWindowName.."Text", L"" )
DynamicImageSetTexture( entryWindowName.."IconIconBase", L"", 0, 0 )
end
end
</pre>

== See also ==
* [[API:TomeGetItemRewardData|TomeGetItemRewardData]]
* [[API:TomeGetTacticRewardsList|TomeGetTacticRewardsList]]

API:TomeGetItemRewardsList - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)