Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:14Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Game}}
Returns the items in the player's backpack, one table per backpack slot.

<pre>
items = GetInventoryItemData()
</pre>

== Arguments ==
None.

== Returns ==
;items : <code>table</code> – Array of item data tables, indexed by backpack slot from 1. See [[#Item data table|Item data table]] below.

== Details ==
* There is one entry for every backpack slot the player has, including empty slots. An empty slot has an item table with default values (for example <code>id</code> 0 and an empty <code>name</code>).
* If there is no player object, or the Lua state is not available, the function returns nothing.
* A new table is built on every call. The stock UI caches it in <code>DataUtils.GetItems()</code> (<code>easystem_utils/source/datautils.lua</code>) and rebuilds it only when <code>GameData.Player.itemsDirty</code> is set.
* The same item data table is used by [[API:GetEquipmentData|GetEquipmentData]], [[API:GetQuestItemData|GetQuestItemData]], [[API:GetTradeItemData|GetTradeItemData]], [[API:GetCurrentEnhancementItemData|GetCurrentEnhancementItemData]], [[API:GetChoiceRewardsData|GetChoiceRewardsData]] and [[API:GetGivenRewardsData|GetGivenRewardsData]].

=== Item data table ===
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>timestamp</code> || <code>number</code> || —
|-
| <code>id</code> || <code>number</code> || Item id. 0 for an empty slot.
|-
| <code>uniqueID</code> || <code>number</code> || Id of this particular item instance.
|-
| <code>name</code> || <code>wstring</code> || Item name. For a broken item that has a broken name, this is the broken name (see below).
|-
| <code>description</code> || <code>wstring</code> || Description text.
|-
| <code>iconNum</code> || <code>number</code> || Icon id for [[API:GetIconData|GetIconData]]. For a broken item that has a broken name, this is the broken icon.
|-
| <code>equipSlot</code> || <code>number</code> || Equipment slot the item goes in. 0 if none.
|-
| <code>type</code> || <code>number</code> || Item type.
|-
| <code>level</code> || <code>number</code> || Required level.
|-
| <code>iLevel</code> || <code>number</code> || Item level.
|-
| <code>tier</code> || <code>number</code> || —
|-
| <code>renown</code> || <code>number</code> || Required renown rank.
|-
| <code>rarity</code> || <code>number</code> || Rarity. The client adds 1 to its stored value, so the lowest rarity is 1.
|-
| <code>sellPrice</code> || <code>number</code> || Vendor price.
|-
| <code>capacity</code> || <code>number</code> || —
|-
| <code>stackCount</code> || <code>number</code> || Number of items in the stack.
|-
| <code>races</code> || <code>table</code> || Array of race ids (<code>number</code>, 1–7) that may use the item. Empty if there is no race restriction.
|-
| <code>careers</code> || <code>table</code> || Array of career ids (<code>number</code>, 1–31) that may use the item.
|-
| <code>slots</code> || <code>table</code> || Array of slot numbers (<code>number</code>, 1–20) the item can be used on.
|-
| <code>skills</code> || <code>table</code> || Array of skill ids (<code>number</code>, 0–27).
|-
| <code>flags</code> || <code>table</code> || Table of 20 booleans with keys <code>0</code>–<code>19</code>. Index it with <code>GameData.Item.EITEMFLAG_*</code> values.
|-
| <code>armor</code> || <code>number</code> || Armor value.
|-
| <code>dps</code> || <code>number</code> || Damage per second.
|-
| <code>speed</code> || <code>number</code> || Weapon speed.
|-
| <code>blockRating</code> || <code>number</code> || Block rating.
|-
| <code>itemSet</code> || <code>number</code> || Item set id.
|-
| <code>trophyLocation</code> || <code>number</code> || —
|-
| <code>trophyLocIndex</code> || <code>number</code> || The client adds 1 to its stored value.
|-
| <code>bop</code> || <code>boolean</code> || —
|-
| <code>boundToPlayer</code> || <code>boolean</code> || —
|-
| <code>isNew</code> || <code>boolean</code> || —
|-
| <code>broken</code> || <code>boolean</code> || <code>true</code> if the item is broken.
|-
| <code>repairedName</code> || <code>wstring</code> || Only for a broken item that has a broken name: the normal (repaired) name.
|-
| <code>repairedIconNum</code> || <code>number</code> || Only for a broken item that has a broken name: the normal icon.
|-
| <code>brokenName</code> || <code>wstring</code> || Only for a broken item that has a broken name: the broken name.
|-
| <code>brokenIconNum</code> || <code>number</code> || Only for a broken item that has a broken name: the broken icon.
|-
| <code>repairPrice</code> || <code>number</code> || Only for a broken item that has a broken name: cost to repair. <code>sellPrice</code> is also replaced in this case.
|-
| <code>bonus</code> || <code>table</code> || Array of bonus tables, indexed from 1, at most 10 entries. See [[#Bonus tables|Bonus tables]].
|-
| <code>craftingBonus</code> || <code>table</code> || Array of crafting bonus tables, indexed from 1. Each has <code>bonusType</code> (<code>number</code>, always 6), <code>bonusReference</code> (<code>number</code>) and <code>bonusValue</code> (<code>number</code>).
|-
| <code>marketingIndex</code> || <code>number</code> || —
|-
| <code>marketingVariation</code> || <code>number</code> || —
|-
| <code>numEnhancementSlots</code> || <code>number</code> || Number of enhancement (talisman) slots, at most 3.
|-
| <code>enhSlot</code> || <code>table</code> || Filled enhancement slots, keyed by slot number from 1. Empty slots have no entry. See [[#Enhancement slot tables|Enhancement slot tables]].
|-
| <code>noChargeLeftDontDelete</code> || <code>number</code> || —
|-
| <code>currChargesRemaining</code> || <code>number</code> || Charges left.
|-
| <code>tintA</code>, <code>tintB</code> || <code>number</code> || —
|-
| <code>dyeTintA</code>, <code>dyeTintB</code> || <code>number</code> || —
|-
| <code>cultivationType</code> || <code>number</code> || —
|-
| <code>craftingSkillRequirement</code> || <code>number</code> || Crafting skill needed to use the item.
|-
| <code>maxEquip</code> || <code>number</code> || —
|-
| <code>isRefinable</code> || <code>boolean</code> || —
|-
| <code>timeLeftBeforeDecay</code> || <code>number</code> || —
|-
| <code>decayPaused</code> || <code>boolean</code> || —
|-
| <code>isTwoHanded</code> || <code>boolean</code> || —
|-
| <code>customizedIconNum</code> || <code>number</code> || —
|-
| <code>customizedIconName</code> || <code>wstring</code> || —
|}

==== Bonus tables ====
Every entry of <code>bonus</code> has a <code>type</code> field. The other fields depend on it. The type numbers match <code>GameDefs.ITEMBONUS_*</code> in <code>easystem_utils/source/gamedefs.lua</code>.
{| class="wikitable"
! <code>type</code> !! Fields
|-
| 2 (<code>ITEMBONUS_MAGIC</code>) || <code>reference</code> (<code>number</code>, the stat), <code>value</code> (<code>number</code>, may be negative), <code>isPercentage</code> (<code>boolean</code>), <code>duration</code> (<code>number</code>, seconds)
|-
| 3 (<code>ITEMBONUS_USE</code>) || <code>reference</code> (<code>number</code>), <code>value</code> (<code>number</code>), <code>cooldownTimeLeft</code> (<code>number</code>, seconds), <code>totalCooldownTime</code> (<code>number</code>, seconds)
|-
| 5 (<code>ITEMBONUS_CONTINUOUS</code>) || <code>reference</code> (<code>number</code>), <code>value</code> (always 0), <code>duration</code> (<code>number</code>, seconds)
|}
Bonuses of type 2 are listed first, then type 3, then type 5. The list stops after 10 entries.

==== Enhancement slot tables ====
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>name</code> || <code>wstring</code> || Name of the enhancement in the slot.
|-
| <code>id</code> || <code>number</code> || Item id of the enhancement.
|-
| <code>iconNum</code> || <code>number</code> || Icon id of the enhancement.
|-
| <code>inventorySlot</code> || <code>number</code> || —
|-
| <code>rarity</code> || <code>number</code> || —
|-
| <code>level</code> || <code>number</code> || —
|-
| <code>bonus</code>, <code>craftingBonus</code>, <code>marketingIndex</code>, <code>marketingVariation</code> || || Same layout as on the item itself.
|}

== Errors ==
None.

== Example ==
From <code>easystem_utils/source/datautils.lua</code>:
<pre>
function DataUtils.GetItems()
if (GameData.Player.itemsDirty)
then
GameData.Player.itemsDirty = false
DataUtilsData.items = GetInventoryItemData()
end

return DataUtilsData.items
end
</pre>

Reading flags and bonuses, from <code>easystem_tooltips/source/itemtooltips.lua</code>:
<pre>
local itemIsSalvagable = (itemData.flags[GameData.Item.EITEMFLAG_MAGICAL_SALVAGABLE] == true);
...
for i, bonus in ipairs(itemData.bonus) do
...
if( bonus.type == GameDefs.ITEMBONUS_MAGIC and bonus.reference > 0 and bonus.value ~= 0 ) then
</pre>

== See also ==
* [[API:GetEquipmentData|GetEquipmentData]]
* [[API:GetQuestItemData|GetQuestItemData]]
* [[API:GetIconData|GetIconData]]

API:GetInventoryItemData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)