Files

207 lines
7.7 KiB
Lua
Raw Permalink Normal View History

2025-05-09 02:00:02 -04:00
---@diagnostic disable: duplicate-set-field
if GetResourceState('tgiann-inventory') == 'missing' then return end
local tgiann = exports["tgiann-inventory"]
Inventory = Inventory or {}
---@description This will get the name of the in use resource.
---@return string
Inventory.GetResourceName = function()
return "tgiann-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
---@param slot number (optional)
---@param metadata table (optional)
2025-03-03 01:09:24 -05:00
---@return boolean
Inventory.AddItem = function(src, item, count, slot, metadata)
2025-08-12 18:08:49 -04:00
if not tgiann:CanCarryItem(src, item, count) then return false end
local success = tgiann:AddItem(src, item, count, slot, metadata, false)
if not success then return false end
TriggerClientEvent("community_bridge:client:inventory:updateInventory", src, {action = "add", item = item, count = count, slot = slot, metadata = metadata})
return success or false
end
---@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
---@param slot number (optional)
---@param metadata table (optional)
2025-03-03 01:09:24 -05:00
---@return boolean
Inventory.RemoveItem = function(src, item, count, slot, metadata)
local success = tgiann:RemoveItem(src, item, count, slot, metadata)
if not success then return false end
TriggerClientEvent("community_bridge:client:inventory:updateInventory", src, {action = "remove", item = item, count = count, slot = slot, metadata = metadata})
return success or false
end
---@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 = tgiann:GetItemList()
if not itemData[item] then return {} end
return {
name = itemData.name or "Missing Name",
label = itemData.label or "Missing Label",
stack = itemData.unique or "false",
weight = itemData.weight or "0",
description = itemData.description or "none",
image = itemData.image or Inventory.GetImagePath(item),
}
2025-03-07 04:08:40 -05:00
end
---@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 tgiann:GetItemList()
end
---@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
---@param metadata table (optional)
2025-03-03 01:09:24 -05:00
---@return number
Inventory.GetItemCount = function(src, item, metadata)
local _item = tgiann:GetItemByName(src, item, metadata)
return _item.amount or 0
end
---@description This will 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)
local inventory = tgiann:GetPlayerItems(src)
local items = {}
for _, v in pairs(inventory) do
if tonumber(_) then
table.insert(items, {name = v.name, label = v.name, weight = 0, description = v.description, slot = v.slot, count = v.amount, metadata = v.info})
end
end
return items
end
---@description Returns the specified slot data as a table.
2025-03-03 01:09:24 -05:00
---@param src number
---@param slot number
---@return table {weight, name, metadata, slot, label, count}
Inventory.GetItemBySlot = function(src, slot)
local item = tgiann:GetItemBySlot(src, slot)
if not item then return {} end
2025-05-09 02:00:02 -04:00
return {
name = item.name,
label = item.label,
weight = item.weight,
slot = slot,
count = item.amount or item.count,
metadata = item.info or item.metadata or {},
stack = item.unique or item.stack or false,
2025-05-09 02:00:02 -04:00
description = item.description
}
end
---@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
---@param slot number
---@param metadata table
---@return nil
Inventory.SetMetadata = function(src, item, slot, metadata)
tgiann:UpdateItemMetadata(src, item, slot, metadata)
end
---@description This will open the specified stash for the src passed.
2025-05-09 06:03:09 -04:00
---@param src number
---@param _type string
2025-05-09 06:03:09 -04:00
---@param id number||string
---@return nil
2025-06-07 20:33:11 -05:00
Inventory.OpenStash = function(src, _type, id)
_type = _type or "stash"
local tbl = Inventory.Stashes[id] or {weight = 1000000, slot = 50, label = "Stash"}
2025-06-07 20:33:11 -05:00
return tgiann:ForceOpenInventory(src, _type, id, tbl and { maxWeight = tbl.weight , slots = tbl.slot, label = tbl.label})
2025-05-09 06:03:09 -04:00
end
---@description This will return a boolean if the player has the item.
2025-05-09 06:03:09 -04:00
---@param src number
2025-03-03 01:09:24 -05:00
---@param item string
2026-06-06 22:36:44 -04:00
---@param requiredCount number (optional)
2025-05-09 06:03:09 -04:00
---@return boolean
2026-06-06 22:36:44 -04:00
Inventory.HasItem = function(src, item, requiredCount)
return tgiann:HasItem(src, item, requiredCount or 1)
2025-05-09 06:03:09 -04:00
end
---@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 tgiann:CanCarryItem(src, item, count)
end
---@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
Inventory.UpdatePlate = function(oldplate, newplate)
local queries = {
'UPDATE tgiann_inventory_trunkitems SET plate = @newplate WHERE plate = @oldplate',
'UPDATE tgiann_inventory_gloveboxitems SET plate = @newplate WHERE plate = @oldplate',
}
local values = { newplate = newplate, oldplate = oldplate }
MySQL.transaction.await(queries, values)
2025-06-04 15:25:20 -04:00
tgiann:UpdateVehicle(oldplate, newplate)
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)
end
---@description This will add items to a trunk, and return true or false based on success
2025-06-04 15:25:20 -04:00
---@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
for _, v in pairs(items) do
tgiann:AddItemToSecondaryInventory("trunk", identifier, v.item, v.count, nil, v.metadata)
end
return true
end
---@description This will clear the specified inventory, will always return true unless a value isnt passed correctly.
2025-06-04 15:25:20 -04:00
---@param id string
---@return boolean
Inventory.ClearStash = function(id, _type)
if type(id) ~= "string" then return false end
tgiann:DeleteInventory(_type, id)
if Inventory.Stashes[id] then Inventory.Stashes[id] = nil end
2025-06-04 15:25:20 -04:00
return true
end
---@description This will get the image path for this item, if not found will return placeholder.
2025-05-09 06:03:09 -04:00
---@param item string
---@return string
Inventory.GetImagePath = function(item)
2025-08-03 16:23:19 -04:00
local pngItem = Inventory.StripPNG(item)
local webpItem = Inventory.StripWebp(item)
local pngPath = LoadResourceFile("inventory_images", string.format("/images/%s.png", pngItem))
local webpPath = LoadResourceFile("inventory_images", string.format("/images/%s.webp", webpItem))
local imagePath = pngPath and string.format("nui://inventory_images/images/%s.png", pngItem) or webpPath and string.format("nui://inventory_images/images/%s.webp", webpItem)
2025-05-09 06:03:09 -04:00
return imagePath or "https://avatars.githubusercontent.com/u/47620135"
end
---@description This will open a players inventory, used for admin purposes and stuff.
2025-05-09 06:03:09 -04:00
---@param src number
---@param target number
2025-07-28 00:10:51 -05:00
Inventory.OpenPlayerInventory = function(src, target)
assert(src, "OpenPlayerInventory: src is required")
assert(target, "OpenPlayerInventory: target is required")
tgiann:OpenInventoryById(src, target)
2025-07-28 00:10:51 -05:00
end
return Inventory