Exports

All server exports are also answered as exports['qb-inventory'], so existing QBCore scripts work unchanged.

Server

ExportArguments
AddItemsrc, item, amount, slot, info, reason
RemoveItemid, item, amount, slot, reason
SetInventoryid, items
ClearInventoryid, filterItems
SetItemDatasrc, itemName, key, val, slot
GetItemByNamesrc, item
GetItemsByNamesrc, item
GetItemCountsrc, items
HasItemsrc, items, amount
GetInventoryid
GetItemBySlotsrc, slot
GetFreeWeightsrc
ClearStashid
GetSlotsid
GetTotalWeightitems
CanAddItemsrc, item, amount
GetFirstSlotByItemitems, itemName
GetSlotsByItemitems, itemName
GetInventoryTypeid
LoadInventorysrc, citizenid
SaveInventorysrc, offline
OpenInventorysrc, id, data
OpenInventoryByIdsrc, playerId
CloseInventorysrc, id
CreateInventoryid, data
RemoveInventoryid
UseItem
CreateShopdata
OpenShopsrc, name
exports['fusing-inventory']:AddItem(source, 'water_bottle', 1, false, false, 'my-script')

Hooks and listeners

ExportArguments
RegisterHookkind, fn
RegisterListenerkind, fn
RemoveHookkind, id
RemoveListenerkind, id

Kinds: ItemMoved, ItemDropped, ItemUsed, ItemBought, ItemAdded, ItemRemoved, InventoryOpened, ShopOpened.

  • A hook runs before the action. Returning false stops it.
  • A listener is told afterwards and cannot change anything.
  • RegisterHook and RegisterListener return an ID for removing it later.
  • Hooks and listeners are removed automatically when the resource that added them stops.

Client

ExportReturns
GetCurrentStashThe stash currently open