Client
Inventory (client). Local player reads. Add/remove, stashes, shops, and hooks live on server. Shared types: Inventory.
Inventory (client)
Local player reads. Add/remove, stashes, shops, and hooks live on server. Shared types: Inventory.
Items(itemName?)
Items(itemName)| Param | Type | Description |
|---|---|---|
itemName | string? | Omit for all item definitions keyed by name |
| Returns | one ItemDefinition, or the full list keyed by name |
Usage Example
local water = bridge.inventory.Items('water')
local allItems = bridge.inventory.Items()hasItem(item, count?, metadata?)
if bridge.inventory.hasItem('lockpick', 1) then end| Param | Type | Default |
|---|---|---|
item | string | — |
count | number? | 1 |
metadata | table? | — |
| Returns | boolean |
getImagePath(itemName)
local icon = bridge.inventory.getImagePath('water')| Param | Type |
|---|---|
itemName | string |
| Returns | string — NUI icon path |
getItemInfo(itemName)
getItemInfo(itemName)| Param | Type |
|---|---|
itemName | string |
| Returns | BridgeItemInfo — ox-shaped definition plus a resolved image path |
Usage Example
local info = bridge.inventory.getItemInfo('water')
print(info.label, info.image, info.weight)getItemCount(item, metadata?)
local count = bridge.inventory.getItemCount('water')| Param | Type |
|---|---|
item | string |
metadata | table? |
| Returns | number |
getInventoryItems()
local items = bridge.inventory.getInventoryItems()| Returns | occupied slots — slot-keyed map on ox / m-Inventory / one_inventory; sorted array on other adapters. Iterate with pairs. |
Examples
-- Show craft option only when player has materials
if bridge.inventory.hasItem('steel', 2) and bridge.inventory.hasItem('plastic', 1) then
options[#options + 1] = {
title = 'Craft plate carrier',
onSelect = function()
TriggerServerEvent('myresource:craftPlateCarrier')
end,
}
end
-- Menu icon from bridge image path
local icon = bridge.inventory.getImagePath('bandage')
-- Iterate local inventory (ox-shaped slots). Use pairs: ox keys by slot number.
local items = bridge.inventory.getInventoryItems()
for _, slot in pairs(items) do
print(slot.slot, slot.name, slot.count, json.encode(slot.metadata))
end