esx_addoninventory

esx_addoninventory is a server-only library resource that stores item counts outside of a player's own inventory. Use it for society storage rooms, property stashes and similar containers. Other resources such as esx_society and esx_property read and write these inventories.

OverviewCopy Anchor Link

Like esx_addonaccount, inventories are either shared (shared = 1, one inventory without an owner) or personal (shared = 0, one inventory per player identifier, created when the player loads and stored as xPlayer.get('addonInventories')).

InstallationCopy Anchor Link

ensure es_extended
ensure esx_addoninventory
ensure esx_society

INSERT INTO `addon_inventory` (`name`, `label`, `shared`) VALUES
  ('society_mechanic', 'Mechanic', 1);

ConfigurationCopy Anchor Link

There is no config.lua. The addon_inventory table is the configuration.

Item labels come from the ESX items table and are loaded on startup.

ox_inventory modeCopy Anchor Link

If ox_inventory is running (ESX sets Config.OxInventory automatically), the resource does not load its own inventories. Instead it registers each addon_inventory row as an ox_inventory stash:

In this mode the exports and the getter events are not registered. Use exports.ox_inventory functions on the stash id instead.

Server exportsCopy Anchor Link

GetSharedInventoryCopy Anchor Link

exports.esx_addoninventory:GetSharedInventory(name)

Returns the inventory object or nil.

local inventory = exports.esx_addoninventory:GetSharedInventory('society_mechanic')

if inventory then
    inventory.addItem('fixkit', 5)
end

AddSharedInventoryCopy Anchor Link

exports.esx_addoninventory:AddSharedInventory(society)

Inserts a shared inventory row and creates an empty inventory in memory. It does not check whether the inventory already exists: calling it twice replaces the in-memory inventory with an empty one (the database insert fails on the primary key). Check with GetSharedInventory first.

if not exports.esx_addoninventory:GetSharedInventory('society_bahama') then
    exports.esx_addoninventory:AddSharedInventory({ name = 'society_bahama', label = 'Bahama Mamas' })
end

Inventory objectCopy Anchor Link

RegisterNetEvent('myresource:takeFromStorage', function(itemName, count)
    local xPlayer = ESX.GetPlayerFromId(source)
    count = math.floor(tonumber(count) or 0)
    if not xPlayer or xPlayer.job.name ~= 'mechanic' or count < 1 then return end

    local inventory = exports.esx_addoninventory:GetSharedInventory('society_mechanic')
    local item = inventory and inventory.getItem(itemName)
    if not item or item.count < count or not xPlayer.canCarryItem(itemName, count) then return end

    inventory.removeItem(itemName, count)
    xPlayer.addInventoryItem(itemName, count)
end)

EventsCopy Anchor Link

Both events are local server events (AddEventHandler). Clients cannot trigger them.

TriggerEvent('esx_addoninventory:getInventory', 'property', xPlayer.identifier, function(inventory)
    if inventory then inventory.addItem('bread', 1) end
end)

Integration tipsCopy Anchor Link

• Use the same society_<job> name in esx_addonaccount, esx_addoninventory and esx_datastore so job resources find all three.
• Shared inventories are also mirrored to GlobalState.SharedInventories.
• New addon_inventory rows are loaded without a restart when ESX fires esx:sqlCatalogReady for addon_inventory or items.

Common issuesCopy Anchor Link

• No such export GetSharedInventory: ox_inventory is running, so the resource is in stash mode. Use ox_inventory stashes.
• Item shows without a label: the item is missing from the items table.
• SQL import error "table already exists": the tables are already there. Skip the import.

RelatedCopy Anchor Link

• esx_addonaccount
• esx_society
• ox_inventory with ESX
• Add items

Frequently asked questions