https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetSingleItemAPI:GetSingleItem - Revision history2026-10-18T04:53:46ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetSingleItem&diff=30466&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:45:01Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Item}}<br />
Returns the data of the item in one slot of one item location.<br />
<br />
<pre><br />
item = GetSingleItem(location, slot, includeEmpty)<br />
</pre><br />
<br />
== Arguments ==<br />
;location : <code>number</code> – A <code>GameData.ItemLocs</code> value. See the table below.<br />
;slot : <code>number</code> – Slot inside that location, starting at 1.<br />
;includeEmpty : <code>boolean</code> – <code>true</code> to get a table even when the slot is empty.<br />
<br />
== Returns ==<br />
;item : <code>table</code> – An [[API:GetInventoryItemData#Item data table|item data table]], or nothing (see Details).<br />
<br />
== Details ==<br />
* Accepted locations and the highest slot number the client accepts for each:<br />
{| class="wikitable"<br />
! Location !! Value !! Highest slot<br />
|-<br />
| <code>GameData.ItemLocs.EQUIPPED</code> || 2 || 27<br />
|-<br />
| <code>GameData.ItemLocs.INVENTORY</code> || 3 || 80<br />
|-<br />
| <code>GameData.ItemLocs.BANK</code> || 4 || 241<br />
|-<br />
| <code>GameData.ItemLocs.QUEST_ITEM</code> || 9 || 65<br />
|-<br />
| <code>GameData.ItemLocs.INVENTORY_OVERFLOW</code> || 20 || –<br />
|-<br />
| <code>GameData.ItemLocs.CRAFTING_ITEM</code> || 30 || 80<br />
|-<br />
| <code>GameData.ItemLocs.CURRENCY_ITEM</code> || 31 || 132<br />
|}<br />
* Nothing is returned when the location is not in the table, when <code>slot</code> is 0 or above the limit, or when the slot is empty and <code>includeEmpty</code> is <code>false</code>.<br />
* With <code>includeEmpty = true</code> an empty slot gives a table with default values (<code>id</code> 0, empty <code>name</code>).<br />
* For <code>INVENTORY_OVERFLOW</code> the <code>slot</code> argument is ignored: the client picks the slot from the overflow contents itself. [[API:GetOverflowData|GetOverflowData]] is the function the stock UI uses for the overflow.<br />
* The limits are the client's upper bounds. They are larger than the number of slots a player normally has, so check the slot count yourself.<br />
* <code>includeEmpty</code> must be a real boolean. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.<br />
* The function needs at least three arguments and only reads the last three.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when an argument has the wrong type.<br />
<br />
== Example ==<br />
Refreshing one bank slot, from <code>default/ea_bankwindow/source/bankwindow.lua</code>:<br />
<pre><br />
local itemData = GetSingleItem( GameData.ItemLocs.BANK, slot, false )<br />
<br />
BankWindow.items[slot] = itemData<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GetInventoryItemData|GetInventoryItemData]]<br />
* [[API:GetBankData|GetBankData]]<br />
* [[API:GetEquipmentData|GetEquipmentData]]</div>Maintenance script