https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ASendUseItemAPI:SendUseItem - Revision history2026-10-17T14:22:14ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:SendUseItem&diff=30707&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:48:49Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Item}}<br />
Asks the server to use an item, optionally on another item.<br />
<br />
<pre><br />
SendUseItem(location, slot, option, targetLocation, targetSlot)<br />
</pre><br />
<br />
== Arguments ==<br />
;location : <code>number</code> – Where the item is, as a <code>GameData.ItemLocs</code> value.<br />
;slot : <code>number</code> – Slot of the item in <code>location</code>, starting at 1.<br />
;option : <code>number</code> – Extra choice sent with the request, as a single byte. The stock UI passes 0, the 0-based index of a "use option" picked in a dialog, or an ability value for targeted uses.<br />
;targetLocation : <code>number</code> – Location of the target item, or 0 for no target.<br />
;targetSlot : <code>number</code> – Slot of the target item, or 0 for no target.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* Supported locations are <code>EQUIPPED</code>, <code>INVENTORY</code>, <code>QUEST_ITEM</code>, <code>INVENTORY_OVERFLOW</code>, <code>CRAFTING_ITEM</code> and <code>CURRENCY_ITEM</code>. For any other location, including <code>BANK</code>, nothing is sent.<br />
* The target is converted the same way. An unsupported or 0 target location is sent as "no target".<br />
* The client does not check that the slot holds an item, or that the item can be used. The server decides.<br />
* If there is no player object, nothing happens.<br />
* The function needs at least five arguments and only reads the last five.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when an argument is not a number.<br />
<br />
== Example ==<br />
Using an item from the backpack, from <code>default/ea_backpackwindow/source/backpackutils.lua</code>:<br />
<pre><br />
if not ItemUtils.ShowUseOptions(itemData, GameData.ItemLocs.INVENTORY, slot)<br />
then<br />
SendUseItem( GameData.ItemLocs.INVENTORY, slot, 0, 0, 0 )<br />
end<br />
</pre><br />
<br />
Using an item on another item, from <code>default/ea_modifyitem/source/useitemtargeting.lua</code>:<br />
<pre><br />
SendUseItem(sourceLoc, sourceSlot, ability, targetLoc, targetSlot)<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GetSingleItem|GetSingleItem]]<br />
* [[API:DyePreview|DyePreview]]<br />
* [[API:CanUseDyeItem|CanUseDyeItem]]</div>Maintenance script