Inventory
Give, take, and check items. echo_inventory is ox_inventory-compatible, so the API is identical.
Call echo_inventory's server exports directly. These are the same functions and signatures as ox_inventory, so existing ox_inventory snippets work — just point them at exports.echo_inventory.
⚠️ Call echo_inventory, not ox_inventory
echo_inventory provides ox_inventory, but provide does not reroute exports. Call exports.echo_inventory:AddItem(...), not exports.ox_inventory:AddItem(...).
Item exports
All server-side. source is the player's server id.
-- give / take
exports.echo_inventory:AddItem(source, 'water', 1)
exports.echo_inventory:RemoveItem(source, 'water', 1)
-- check before giving
if exports.echo_inventory:CanCarryItem(source, 'water', 1) then
exports.echo_inventory:AddItem(source, 'water', 1)
end
-- how many does the player have?
local count = exports.echo_inventory:GetItemCount(source, 'water')
| Export | Description |
|---|---|
AddItem(source, name, count, metadata?, slot?) |
Add an item to a player's inventory. |
RemoveItem(source, name, count, metadata?, slot?) |
Remove an item. |
GetItemCount(source, name, metadata?) |
Total count of an item the player holds. |
CanCarryItem(source, name, count, metadata?) |
True if there's room/weight for it. |
GetItem(source, name, metadata?, returnsCount?) |
Item data (or count when returnsCount is true). |
Search(source, query, name, metadata?) |
Search a player's inventory ('count' or 'slots'). |
📖 Full reference
Anything ox_inventory's server exports do, echo_inventory does the same way — consult the ox_inventory exports reference for the complete list and metadata shapes.