Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:48:18Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Game}}
Asks the server to reset a reward in the account rewards ("claim") window.

<pre>
ResetMarketingReward(rewardIndex)
</pre>

== Arguments ==
;rewardIndex : <code>number</code> – Position of the reward in the list from [[API:GameData.InteractData.GetClaimWindowList|GameData.InteractData.GetClaimWindowList]], starting at 1.

== Returns ==
Nothing.

== Details ==
* The client sends the same request as [[API:ClaimMarketingReward|ClaimMarketingReward]], with a "reset" flag set. What a reset does is decided by the server. The stock UI only shows its Reset button for rewards whose <code>rewardCanReset</code> field is <code>true</code>.
* Nothing is sent if the stored item list and reward list have different lengths, or the index is too large. Only the low byte of <code>rewardIndex</code> is used.
* The range check accepts an index one past the end of the list. In that case the client reads past the end of its stored list. Pass only indexes of entries in the list.
* The argument check names the wrong function: if the argument is missing or not a number, the ''Invalid Parameters'' message names <code>ItemContainerLootItem</code>.
* Exactly one argument must be passed.

== Errors ==
None besides the generic ''Invalid Parameters'' message (see Details).

== Example ==
From <code>default/ea_claimwindow/source/claimwindow.lua</code>:
<pre>
function EA_Window_Claim.ResetReward()
if EA_Window_Claim.currentlySelectedChoice ~= EA_Window_Claim.NO_SELECTION_MADE
then
ResetMarketingReward( EA_Window_Claim.currentlySelectedChoice )
end
end
</pre>

== See also ==
* [[API:ClaimMarketingReward|ClaimMarketingReward]]
* [[API:GameData.InteractData.GetClaimWindowList|GameData.InteractData.GetClaimWindowList]]

API:ResetMarketingReward - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)