Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:51:07Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Item}}
Sends an equipment upgrade request for an item, optionally with a second item used for the upgrade.

<pre>
UpgradeEquipment(isTest, mainBackpack, mainSlot, secondBackpack, secondSlot)
</pre>

== Arguments ==
;isTest : <code>boolean</code> – Sent with the request. The stock UI passes the <code>isTest</code> flag of its upgrade window.
;mainBackpack : <code>number</code> – Backpack of the item to upgrade, as an <code>EA_Window_Backpack.TYPE_*</code> value: 2 (<code>TYPE_INVENTORY</code>), 3 (<code>TYPE_CURRENCY</code>) or 4 (<code>TYPE_CRAFTING</code>).
;mainSlot : <code>number</code> – Slot of that item inside the backpack, starting at 1.
;secondBackpack : <code>number</code> – Backpack of the second item, same values as <code>mainBackpack</code>, or 0 for no second item.
;secondSlot : <code>number</code> – Slot of the second item, or 0.

== Returns ==
Nothing.

== Details ==
* <code>mainBackpack</code> must be 2, 3 or 4, or the error below is raised and nothing is sent.
* If <code>secondBackpack</code> is not 2, 3 or 4, the request is sent without a second item.
* Both items are converted to absolute inventory slots before sending.
* <code>isTest</code> must be a real boolean. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.
* If there is no player object or the Lua state is not available, nothing happens.
* The function needs at least five arguments and only reads the last five.

== Errors ==
* <code>Error in function call 'UpgradeEquipment': Invalid main item backpack.</code>
* The generic ''Invalid Parameters'' message when an argument has the wrong type.

== Example ==
From <code>default/ea_craftingwindow/source/equipmentupgradewindow.lua</code>:
<pre>
UpgradeEquipment( isTest, currentItems[SLOT_MAINITEM].sourceBackpack, currentItems[SLOT_MAINITEM].sourceSlot, currentItems[SLOT_REFINEMENT].sourceBackpack, currentItems[SLOT_REFINEMENT].sourceSlot )
</pre>
Without a second item:
<pre>
UpgradeEquipment( isTest, currentItems[SLOT_MAINITEM].sourceBackpack, currentItems[SLOT_MAINITEM].sourceSlot, 0, 0 )
</pre>

== See also ==
* [[API:GetSingleItem|GetSingleItem]]
* [[API:RequestSalvageItem|RequestSalvageItem]]

API:UpgradeEquipment - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)