Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:42:32Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Loot}}
Returns the rewards shown in the account rewards ("claim") window.

<pre>
rewards = GameData.InteractData.GetClaimWindowList()
</pre>

== Arguments ==
None.

== Returns ==
;rewards : <code>table</code> – Array of reward tables, indexed from 1. Empty if there are no rewards.

Each reward table is an [[API:GetInventoryItemData#Item data table|item data table]] for the reward item, with these extra fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>rewardStatus</code> || <code>number</code> || Status of the reward. The stock UI defines the values in <code>ea_claimwindow/source/claimwindow.lua</code>: 0 not received, 1 sent by mail, 2 error sending, 3 not eligible, 4 claimed, 5 has remaining quantity, 6 needs more quantity.
|-
| <code>rewardCanReset</code> || <code>boolean</code> || Whether the reward can be reset with [[API:ResetMarketingReward|ResetMarketingReward]].
|-
| <code>rewardSubject</code> || <code>wstring</code> || Text shown for the reward; the stock UI puts it in the row's subject label.
|}

== Details ==
* The client keeps two parallel lists for this window: the items and the reward entries. If they have different lengths, the three extra fields are left out and only the item data tables are returned.
* The index of a reward in this table is the <code>rewardIndex</code> for [[API:ClaimMarketingReward|ClaimMarketingReward]] and [[API:ResetMarketingReward|ResetMarketingReward]].
* If the Lua state is not available, the function returns nothing.

== Errors ==
None.

== Example ==
From <code>default/ea_claimwindow/source/claimwindow.lua</code>:
<pre>
EA_Window_Claim.lootData = GameData.InteractData.GetClaimWindowList()
EA_Window_Claim.lootDataDisplayOrder = {}

for lootIndex, itemData in ipairs( EA_Window_Claim.lootData )
do
table.insert( EA_Window_Claim.lootDataDisplayOrder, lootIndex )
end
...
if(itemData.rewardCanReset == true)
</pre>

== See also ==
* [[API:ClaimMarketingReward|ClaimMarketingReward]]
* [[API:ResetMarketingReward|ResetMarketingReward]]

API:GameData.InteractData.GetClaimWindowList - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)