2025-05-09 02:00:02 -04:00
---@diagnostic disable: duplicate-set-field
2025-01-10 16:36:20 -05:00
Inventory = Inventory or {}
2025-05-09 06:03:09 -04:00
---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
---@param slot number
---@param metadata table
2025-05-09 06:03:09 -04:00
---@return boolean
2025-01-25 12:59:51 -05:00
Inventory.AddItem = function ( src , item , count , slot , metadata )
2025-05-09 06:03:09 -04:00
TriggerClientEvent ( "community_bridge:client:inventory:updateInventory" , src , { action = "add" , item = item , count = count , slot = slot , metadata = metadata })
2025-01-10 16:36:20 -05:00
return Framework.AddItem ( src , item , count , slot , metadata )
end
2025-05-09 06:03:09 -04:00
---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
---@param slot number
---@param metadata table
2025-05-09 06:03:09 -04:00
---@return boolean
2025-01-10 16:36:20 -05:00
Inventory.RemoveItem = function ( src , item , count , slot , metadata )
2025-01-14 12:30:29 -06:00
item = type ( item ) == "table" and item.name or item
2025-05-09 06:03:09 -04:00
TriggerClientEvent ( "community_bridge:client:inventory:updateInventory" , src , { action = "remove" , item = item , count = count , slot = slot , metadata = metadata })
2025-01-14 12:30:29 -06:00
return Framework.RemoveItem ( src , item , count , slot , metadata )
2025-01-10 16:36:20 -05:00
end
2025-05-09 06:03:09 -04:00
---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
2025-04-12 02:30:38 -04:00
---@return table
2025-01-10 16:36:20 -05:00
Inventory.GetItemInfo = function ( item )
2025-04-12 02:30:38 -04:00
return Framework.GetItemInfo ( item )
2025-01-10 16:36:20 -05:00
end
2025-05-09 06:03:09 -04:00
---This will return the count of the item in the players inventory, if not found will return 0.
---
---if metadata is passed it will find the matching items count.
2025-03-03 01:09:24 -05:00
---@param src number
---@param item string
---@param metadata table
---@return number
2025-01-10 16:36:20 -05:00
Inventory.GetItemCount = function ( src , item , metadata )
return Framework.GetItemCount ( src , item , metadata )
end
2025-05-09 06:03:09 -04:00
---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 Framework.GetPlayerInventory ( src )
end
2025-05-09 06:03:09 -04:00
---Returns the specified slot data as a table.
---
---format {weight, name, metadata, slot, label, count}
2025-03-03 01:09:24 -05:00
---@param src number
---@param slot number
---@return table
2025-01-31 19:15:33 -05:00
Inventory.GetItemBySlot = function ( src , slot )
return Framework.GetItemBySlot ( src , slot )
end
2025-05-09 06:03:09 -04:00
---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
---@param slot number
---@param metadata table
2025-05-09 06:03:09 -04:00
---@return nil
2025-01-10 16:36:20 -05:00
Inventory.SetMetadata = function ( src , item , slot , metadata )
return Framework.SetMetadata ( src , item , slot , metadata )
end
2025-05-09 06:03:09 -04:00
---This will open the specified stash for the src passed.
2025-03-03 01:09:24 -05:00
---@param src number
2025-05-09 06:03:09 -04:00
---@param id number||string
2025-03-03 01:09:24 -05:00
---@param label string
---@param slots number
---@param weight number
---@param owner string
---@param groups table
---@param coords table
2025-05-09 06:03:09 -04:00
---@return nil
2025-01-10 16:36:20 -05:00
Inventory.OpenStash = function ( src , id , label , slots , weight , owner , groups , coords )
2025-04-12 02:30:38 -04:00
return false , Prints.Error ( "This Inventory Has Not Been Bridged For A Stash Feature." )
2025-01-10 16:36:20 -05:00
end
2025-05-09 06:03:09 -04:00
---This will register a stash
---@param id number||string
---@param label string
---@param slots number
---@param weight number
---@param owner string
---@param groups table
---@param coords table
---@return boolean
Inventory.RegisterStash = function ( id , label , slots , weight , owner , groups , coords )
return false , Prints.Error ( "This Inventory Has Not Been Bridged For A Stash Feature." )
end
---This will return a boolean if the player has the item.
---@param src number
---@param item string
---@return boolean
Inventory.HasItem = function ( src , item )
return Framework.HasItem ( src , item )
end
---This is to get if there is available space in the inventory, will return boolean.
---@param src number
---@param item string
---@param count number
---@return boolean
Inventory.CanCarryItem = function ( src , item , count )
return false , Prints.Error ( "This Inventory Has Not Been Bridged For A CanCarryItem Feature." )
end
---This will update the plate to the vehicle inside the inventory. (It will also update with jg-mechanic if using it)
---@param oldplate string
---@param newplate string
---@return boolean
Inventory.UpdatePlate = function ( oldplate , newplate )
return false , Prints.Error ( "This Inventory Has Not Been Bridged For A UpdatePlate Feature." )
end
-- This will open the specified shop for the src passed.
---@param src number
---@param shopTitle string
Inventory.OpenShop = function ( src , shopTitle )
return false , Prints.Error ( "This Inventory Has Not Been Bridged For A OpenShop Feature." )
end
-- This will register a shop, if it already exists it will return true.
-- @param shopTitle string
-- @param shopInventory table
-- @param shopCoords table
-- @param shopGroups table
2025-05-24 22:10:39 -05:00
Inventory.RegisterShop = function ( shopTitle , shopInventory , shopCoords , shopGroups )
2025-05-09 06:03:09 -04:00
return false , Prints.Error ( "This Inventory Has Not Been Bridged For A CreateShop Feature." )
end
---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 )
return "https://avatars.githubusercontent.com/u/47620135"
2025-04-16 05:24:03 -05:00
end
Inventory.StripPNG = function ( item )
if string.find ( item , ".png" ) then
item = string.gsub ( item , ".png" , "" )
end
return item
2025-05-10 00:01:56 -04:00
end
return Inventory