Exports & Events

Taken from the shipped source for version 1.0.0.

🖥️ Server exports

Export	Arguments	Description
`OpenInventory`	`(src)`	Open the inventory for a player.
`CloseInventory`	`(src)`	Close it.
`RefreshInventory`	`(src)`	Push the current inventory to the player.
`AddItem`	`(identifier, item, amount, slot, info, reason)`	Add an item.
`RemoveItem`	`(identifier, item, amount, slot, reason)`	Remove an item.
`CanAddItem`	`(src, item, amount)`	Whether the item fits.
`HasItem`	`(src, items, amount)`	Whether the player has the items.
`GetItemBySlot`	`(src, slot)`	Item in a slot.
`GetItemByName`	`(src, item)`	First item with that name.
`GetItemsByName`	`(src, item)`	All items with that name.
`GetItemCount`	`(src, items)`	Total count.
`GetTotalWeight`	`(items)`	Weight of an item list.
`GetFreeWeight`	`(src)`	Remaining carry weight.
`GetInventory`	`(identifier)`	The inventory table.
`SetInventory`	`(src, items)`	Replace the inventory.
`ClearInventory`	`(src, filterItems)`	Clear the inventory, optionally keeping filterItems.
`UseItem`	`(itemName, ...)`	Use an item.
`GetFramework`	`()`	Detected framework.
`GetItemDefinition`	`(item)`	Item definition table.


local result = exports['nomad-inventory']:OpenInventory(...)

Export	Arguments	Description
`OpenInventory`	`()`	Open the inventory from the client.

Event	Side	Description
`nomad-inventory:server:openInventory`	server	Open the inventory.
`nomad-inventory:server:refreshInventory`	server	Refresh.
`nomad-inventory:server:useItem`	server	Use an item.
`nomad-inventory:server:moveItem`	server	Move an item between slots.
`nomad-inventory:server:setQuickSlot`	server	Assign a hotbar slot.
`nomad-inventory:server:showHotbar`	server	Show the hotbar.
`nomad-inventory:server:useHotbarSlot`	server	Use a hotbar slot.
`inventory:server:OpenInventory`	server	QB compatibility alias.
`qb-inventory:server:OpenInventory`	server	QB compatibility alias.
`qb-inventory:server:closeInventory`	server	QB compatibility alias.
`qb-inventory:server:SetInventoryData`	server	QB compatibility alias.
`nomad-inventory:client:openInventory`	client	Open the UI.
`nomad-inventory:client:closeInventory`	client	Close the UI.
`nomad-inventory:client:inventoryData`	client	Receive inventory data.
`nomad-inventory:client:hotbarData`	client	Receive hotbar data.
`nomad-inventory:client:notify`	client	Notification.
`nomad-inventory:client:usedItem`	client	An item was used.
`inventory:client:openInventory / qb-inventory:client:openInventory`	client	QB compatibility aliases.