Player.Functions.GetItemByName

Summary

Gets a player's item (and amount) by name in QBCore's inventory. Check before removing or gating actions on having an item.

Returns

table|nil — the item, or nil if not held.

Parameters

Example

local Player = QBCore.Functions.GetPlayer(src)
local itm = Player.Functions.GetItemByName('lockpick')
if itm and itm.amount > 0 then
  -- has a lockpick
end

Common pitfalls

• Returns nil when the player doesn't have it — null-check.
• On ox_inventory servers, use ox_inventory:Search instead.

Related functions

Related guides

• ox_inventory vs qb-inventory: Which Is Better?
• Understanding ox_lib, ox_inventory & ox_target — the Modern FiveM Stack
• ox_inventory Not Working / Items Not Showing — How to Fix