2025-05-09 02:00:02 -04:00
---@diagnostic disable: duplicate-set-field
2025-12-14 16:22:35 -05:00
if GetResourceState ( 'ox_inventory' ) == 'missing' then return end
if GetResourceState ( 'tgiann-inventory' ) ~= 'missing' then return end
if GetResourceState ( 'qs-inventory' ) ~= 'missing' then return end
if GetResourceState ( 'origen_inventory' ) ~= 'missing' then return end
--check for providers =/
2025-01-10 16:36:20 -05:00
local ox_inventory = exports.ox_inventory
Inventory = Inventory or {}
2025-05-19 07:20:23 -05:00
Inventory.Stashes = Inventory.Stashes or {}
2025-06-04 15:25:20 -04:00
2025-12-14 16:22:35 -05:00
---@description This will get the name of the in use resource.
---@return string
Inventory.GetResourceName = function ()
return "ox_inventory"
end
---@description This will add an item, and return true or false based on success
2025-03-03 01:09:24 -05:00
---@param src number
---@param item string
---@param count number
2025-12-14 16:22:35 -05:00
---@param slot number (optional)
---@param metadata table (optional)
2025-03-03 01:09:24 -05:00
---@return boolean
2025-01-10 16:36:20 -05:00
Inventory.AddItem = function ( src , item , count , slot , metadata )
2025-08-12 18:08:49 -04:00
if not ox_inventory : CanCarryItem ( src , item , count , metadata ) then return false end
2025-12-14 16:22:35 -05:00
local success = ox_inventory : AddItem ( src , item , count , metadata )
if not success then return false end
2025-02-05 01:54:55 -05:00
TriggerClientEvent ( "community_bridge:client:inventory:updateInventory" , src , { action = "add" , item = item , count = count , slot = slot , metadata = metadata })
2025-12-14 16:22:35 -05:00
return success
2025-01-10 16:36:20 -05:00
end
2025-12-14 16:22:35 -05:00
---@description This will remove an item, and return true or false based on success
2025-03-03 01:09:24 -05:00
---@param src number
---@param item string
---@param count number
2025-12-14 16:22:35 -05:00
---@param slot number (optional)
---@param metadata table (optional)
2025-03-03 01:09:24 -05:00
---@return boolean
2025-01-10 16:36:20 -05:00
Inventory.RemoveItem = function ( src , item , count , slot , metadata )
2025-12-14 16:22:35 -05:00
local success = ox_inventory : RemoveItem ( src , item , count , metadata , slot )
if not success then return false end
2025-02-05 01:54:55 -05:00
TriggerClientEvent ( "community_bridge:client:inventory:updateInventory" , src , { action = "remove" , item = item , count = count , slot = slot , metadata = metadata })
2025-12-14 16:22:35 -05:00
return success
2025-06-04 15:25:20 -04:00
end
2025-12-14 16:22:35 -05:00
---@description This will return a table with the item info, {name, label, stack, weight, description, image}
2025-03-03 01:09:24 -05:00
---@param item string
---@return table
2025-05-09 06:03:09 -04:00
Inventory.GetItemInfo = function ( item )
local itemData = ox_inventory : Items ( item )
if not itemData then return {} end
return {
name = itemData.name or "Missing Name" ,
label = itemData.label or "Missing Label" ,
stack = itemData.stack or "true" ,
weight = itemData.weight or "0" ,
description = itemData.description or "none" ,
image = string.format ( "nui://ox_inventory/web/images/%s" , itemData.client and itemData.client . image or string.format ( "%s.png" , item )),
}
2025-01-31 19:15:33 -05:00
end
2025-12-14 16:22:35 -05:00
---@description This will return the entire items table from the inventory.
2025-07-09 17:26:16 -04:00
---@return table
Inventory.Items = function ()
return ox_inventory : Items ()
end
2025-12-14 16:22:35 -05:00
---@description This will return the count of the item in the players inventory, if not found will return 0.
2025-03-03 01:09:24 -05:00
---@param src number
---@param item string
2025-12-14 16:22:35 -05:00
---@param metadata table (optional)
2025-03-03 01:09:24 -05:00
---@return number
2025-01-10 16:36:20 -05:00
Inventory.GetItemCount = function ( src , item , metadata )
return ox_inventory : GetItemCount ( src , item , metadata , false )
end
2025-12-14 16:22:35 -05:00
---@description This wil return the players inventory.
2025-03-03 01:09:24 -05:00
---@param src number
---@return table
2025-01-31 19:56:25 -05:00
Inventory.GetPlayerInventory = function ( src )
2025-01-10 16:36:20 -05:00
return ox_inventory : GetInventoryItems ( src , false )
end
2025-12-14 16:22:35 -05:00
---@description Returns the specified slot data as a table.
2025-05-09 06:03:09 -04:00
---@param src number
---@param slot number
2025-12-14 16:22:35 -05:00
---@return table {weight, name, metadata, slot, label, count}
2025-05-09 06:03:09 -04:00
Inventory.GetItemBySlot = function ( src , slot )
return ox_inventory : GetSlot ( src , slot )
end
2025-12-14 16:22:35 -05:00
---@description This will set the metadata of an item in the inventory.
2025-03-03 01:09:24 -05:00
---@param src number
---@param item string
2025-05-09 06:03:09 -04:00
---@param slot number
---@param metadata table
---@return nil
Inventory.SetMetadata = function ( src , item , slot , metadata )
ox_inventory : SetMetadata ( src , slot , metadata )
2025-01-10 16:36:20 -05:00
end
2025-12-14 16:22:35 -05:00
---@description This will register a stash
2025-08-29 23:53:44 -04:00
---@param id number|string
2025-03-03 01:09:24 -05:00
---@param label string
---@param slots number
---@param weight number
2025-12-14 16:22:35 -05:00
---@param owner string (optional)
---@param groups table (optional)
---@param coords table (optional)
2025-08-29 23:53:44 -04:00
---@return boolean
---@return string|number
2025-05-09 06:03:09 -04:00
Inventory.RegisterStash = function ( id , label , slots , weight , owner , groups , coords )
2025-12-14 16:22:35 -05:00
id = tostring ( id )
-- ox standard doesnt return anything so probably shouldnt return so everything else has the same standard. Id is pointless if its a param already. Yeaaaa probably should change this.
2025-08-29 23:53:44 -04:00
if Inventory.Stashes [ id ] then return true , id end
2025-12-14 16:22:35 -05:00
Inventory.Stashes [ id ] = { id = id , label = label , slots = slots , weight = weight , owner = owner , groups = groups , coords = coords }
2025-08-27 05:47:44 -05:00
ox_inventory : RegisterStash ( id , label , slots , weight , owner , groups , coords )
2025-08-29 23:53:44 -04:00
return true , id
2025-01-10 16:36:20 -05:00
end
2025-12-14 16:22:35 -05:00
---@description This will open the specified stash for the src passed.
---@param src number
---@param _type string "stash", "trunk", "glovebox"
---@param id string
---@return nil
Inventory.OpenStash = function ( src , _type , id )
_type = _type or "stash"
ox_inventory : forceOpenInventory ( src , _type , id )
end
---@description This will add items to a stash, and return true or false based on success
---@param id string
---@param items table {item, count, metadata}
---@return boolean
Inventory.AddStashItems = function ( id , items )
if type ( items ) ~= "table" then return false end
local success = false
for _ , v in pairs ( items ) do
success = ox_inventory : AddItem ( id , v.item , v.count or v.amount , v.metadata or v.info or {})
end
return success
end
---@description This will clear the specified inventory, will always return true unless a value isnt passed correctly.
---@param id string
---@param _type string unused with ox_inventory
---@return boolean
Inventory.ClearStash = function ( id , _type )
id = tostring ( id )
ox_inventory : ClearInventory ( id )
if Inventory.Stashes [ id ] then Inventory.Stashes [ id ] = nil end
-- ox standard doesnt return anything so probably shouldnt return so everything else has the same standard. Yeaaaa probably should change this.
return true
end
---@description This will return a boolean if the player has the item.
2025-03-03 01:09:24 -05:00
---@param src number
---@param item string
2025-12-14 16:22:35 -05:00
---@param requiredCount number (optional)
2025-05-09 06:03:09 -04:00
---@return boolean
2025-12-14 16:22:35 -05:00
Inventory.HasItem = function ( src , item , requiredCount )
return ox_inventory : GetItemCount ( src , item , nil , false ) >= ( requiredCount or 1 )
2025-05-09 06:03:09 -04:00
end
2025-12-14 16:22:35 -05:00
---@description This is to get if there is available space in the inventory, will return boolean.
2025-05-09 06:03:09 -04:00
---@param src number
---@param item string
---@param count number
---@return boolean
Inventory.CanCarryItem = function ( src , item , count )
return ox_inventory : CanCarryItem ( src , item , count )
2025-01-10 16:36:20 -05:00
end
2025-12-14 16:22:35 -05:00
---@description This will update the plate to the vehicle inside the inventory. (It will also update with jg-mechanic if using it)
2025-03-03 01:09:24 -05:00
---@param oldplate string
---@param newplate string
---@return boolean
2025-01-10 16:36:20 -05:00
Inventory.UpdatePlate = function ( oldplate , newplate )
ox_inventory : UpdateVehicle ( oldplate , newplate )
2025-12-14 16:22:35 -05:00
-- ox standard doesnt return anything so probably shouldnt return so everything else has the same standard. Yeaaaa probably should change this.
2026-03-13 12:35:30 -04:00
if GetResourceState ( 'jg-mechanic' ) == 'missing' then return true end
2025-05-09 06:03:09 -04:00
return true , exports [ "jg-mechanic" ]: vehiclePlateUpdated ( oldplate , newplate )
2025-01-10 16:36:20 -05:00
end
2025-12-14 16:22:35 -05:00
---@description This will add items to a trunk, and return true or false based on success
---@param identifier string
---@param items table
---@return boolean
Inventory.AddTrunkItems = function ( identifier , items )
local id = "trunk" .. identifier
if type ( items ) ~= "table" then return false end
Inventory.RegisterStash ( id , identifier , 20 , 10000 , nil , nil , nil )
Wait ( 100 )
local success = false
for _ , v in pairs ( items ) do
success = ox_inventory : AddItem ( id , v.item , v.count or v.amount , v.metadata or v.info or {})
end
return success
end
---@description This will get the image path for an item, it is an alternate option to GetItemInfo. If a image isnt found will revert to community_bridge logo (useful for menus)
2025-03-03 01:09:24 -05:00
---@param item string
---@return string
2025-01-10 16:36:20 -05:00
Inventory.GetImagePath = function ( item )
2025-04-16 05:24:03 -05:00
item = Inventory.StripPNG ( item )
2025-01-10 16:36:20 -05:00
local file = LoadResourceFile ( "ox_inventory" , string.format ( "web/images/%s.png" , item ))
local imagePath = file and string.format ( "nui://ox_inventory/web/images/%s.png" , item )
return imagePath or "https://avatars.githubusercontent.com/u/47620135"
2025-03-07 04:08:40 -05:00
end
2025-12-14 16:22:35 -05:00
---@description This will open the specified shop for the src passed.
2025-05-09 06:03:09 -04:00
---@param src number
2025-08-29 23:49:59 -04:00
---@param shopTitle string
Inventory.OpenShop = function ( src , shopTitle )
TriggerClientEvent ( 'ox_inventory:openInventory' , src , 'shop' , { type = shopTitle })
2025-03-07 04:08:40 -05:00
end
2025-12-14 16:22:35 -05:00
---@description This will register a shop, if it already exists it will return true.
2025-08-29 23:47:52 -04:00
---@param shopTitle string
2025-12-14 16:22:35 -05:00
---@param inventory table
2025-08-29 23:47:52 -04:00
---@param shopCoords table
---@param shopGroups table
2025-12-14 16:22:35 -05:00
Inventory.RegisterShop = function ( shopTitle , inventory , shopCoords , shopGroups )
ox_inventory : RegisterShop ( shopTitle , { name = shopTitle , inventory = inventory , groups = shopGroups , })
-- ox standard doesnt return anything so probably shouldnt return so everything else has the same standard. Yeaaaa probably should change this.
2025-08-29 23:47:52 -04:00
return true
2025-08-27 05:47:44 -05:00
end
2025-05-09 06:03:09 -04:00
2025-12-14 16:22:35 -05:00
---@description This will open a players inventory, used for admin purposes and stuff.
2025-05-09 06:03:09 -04:00
---@param src number
2025-12-14 16:22:35 -05:00
---@param target number
2025-07-28 00:10:51 -05:00
Inventory.OpenPlayerInventory = function ( src , target )
assert ( src , "OpenPlayerInventory: src is required" )
2025-12-14 16:22:35 -05:00
assert ( target , "OpenPlayerInventory: target is required" )
ox_inventory : forceOpenInventory ( src , 'player' , target )
2025-07-28 00:10:51 -05:00
end
2025-05-10 00:01:56 -04:00
return Inventory