> For the complete documentation index, see [llms.txt](https://devix.gitbook.io/devix/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://devix.gitbook.io/devix/devix-inventory/inventory-exports.md).

# Inventory Exports

```lua
exports['devix-inventory']:ExportName(...)
```

***

## Server — Item list & shared data

| Export                                                                             | Description                                                           |
| ---------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| [GetItemList](/devix/devix-inventory/inventory-exports/getitemlist.md)             | Returns the full shared item list.                                    |
| [Items](/devix/devix-inventory/inventory-exports/items.md)                         | Ox-style alias for the shared items table (same data as GetItemList). |
| [GetSharedItemInfo](/devix/devix-inventory/inventory-exports/getsharediteminfo.md) | Returns an item definition, including its label, weight, and image.   |
| [GetItemSize](/devix/devix-inventory/inventory-exports/getitemsize.md)             | Grid width/height for an item.                                        |
| [GetItemCondition](/devix/devix-inventory/inventory-exports/getitemcondition.md)   | Reads condition/durability (0–100) from item info metadata.           |
| [SetItemCondition](/devix/devix-inventory/inventory-exports/setitemcondition.md)   | Writes condition/durability onto item info metadata.                  |

## Server — Adding and removing items

| Export                                                                           | Description                                           |
| -------------------------------------------------------------------------------- | ----------------------------------------------------- |
| [AddItem](/devix/devix-inventory/inventory-exports/additem.md)                   | Gives an item to a player.                            |
| [RemoveItem](/devix/devix-inventory/inventory-exports/removeitem.md)             | Removes an item from a player.                        |
| [RawAddItem](/devix/devix-inventory/inventory-exports/rawadditem.md)             | Alias of AddItem (same behavior).                     |
| [RawRemoveItem](/devix/devix-inventory/inventory-exports/rawremoveitem.md)       | Alias of RemoveItem (same behavior).                  |
| [AddClothingItems](/devix/devix-inventory/inventory-exports/addclothingitems.md) | Adds clothing items from an appearance purchase flow. |

## Server — Reading inventory

| Export                                                                                           | Description                                                       |
| ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- |
| [LoadInventory](/devix/devix-inventory/inventory-exports/loadinventory.md)                       | Loads a player's inventory as a slot-based table.                 |
| [GetInventory](/devix/devix-inventory/inventory-exports/getinventory.md)                         | Player inventory by source (same format as LoadInventory).        |
| [GetItemCount](/devix/devix-inventory/inventory-exports/getitemcount.md)                         | Total count of an item for a player.                              |
| [GetItemCountByIdentifier](/devix/devix-inventory/inventory-exports/getitemcountbyidentifier.md) | Item count by citizenid/identifier (works without online source). |
| [GetItemBySlot](/devix/devix-inventory/inventory-exports/getitembyslot.md)                       | Returns the item at a slot.                                       |
| [GetItemByName](/devix/devix-inventory/inventory-exports/getitembyname.md)                       | First stack matching item name.                                   |
| [GetItemsByName](/devix/devix-inventory/inventory-exports/getitemsbyname.md)                     | All stacks matching item name.                                    |
| [GetSlotWithItem](/devix/devix-inventory/inventory-exports/getslotwithitem.md)                   | First slot that contains the item.                                |
| [GetSlotsWithItem](/devix/devix-inventory/inventory-exports/getslotswithitem.md)                 | All slots containing the item.                                    |
| [GetSlotsByItem](/devix/devix-inventory/inventory-exports/getslotsbyitem.md)                     | Slot numbers containing an item.                                  |
| [GetFirstSlotByItem](/devix/devix-inventory/inventory-exports/getfirstslotbyitem.md)             | First slot number with the item.                                  |
| [GetContainerFromSlot](/devix/devix-inventory/inventory-exports/getcontainerfromslot.md)         | Returns bag/container inventory linked to a player slot.          |
| [HasItem](/devix/devix-inventory/inventory-exports/hasitem.md)                                   | Whether the player has at least the given amount.                 |
| [CanCarryItem](/devix/devix-inventory/inventory-exports/cancarryitem.md)                         | Whether the player has space/weight for the item amount.          |
| [CanCarryWeight](/devix/devix-inventory/inventory-exports/cancarryweight.md)                     | Whether the player can carry additional weight.                   |
| [GetTotalWeight](/devix/devix-inventory/inventory-exports/gettotalweight.md)                     | Returns the total weight of an items table.                       |

## Server — Replace, clear, police

| Export                                                                                                 | Description                                                               |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
| [SetInventory](/devix/devix-inventory/inventory-exports/setinventory.md)                               | Replaces the player's inventory with the given table.                     |
| [ClearInventory](/devix/devix-inventory/inventory-exports/clearinventory.md)                           | Clears all items or a filtered set from the player.                       |
| [ConfiscateInventory](/devix/devix-inventory/inventory-exports/confiscateinventory.md)                 | Stores the player's inventory for later restoration.                      |
| [ReturnInventory](/devix/devix-inventory/inventory-exports/returninventory.md)                         | Restores inventory previously taken by ConfiscateInventory.               |
| [CreateTemporaryStash](/devix/devix-inventory/inventory-exports/createtemporarystash.md)               | Creates a temporary stash from an options table (ox-style compatibility). |
| [SyncPlayerInventoryToClient](/devix/devix-inventory/inventory-exports/syncplayerinventorytoclient.md) | Forces a client inventory sync/refresh for the player.                    |
| [SaveInventory](/devix/devix-inventory/inventory-exports/saveinventory.md)                             | Persists inventory to the database or framework.                          |

## Server — Using items & metadata

| Export                                                                                                         | Description                                                |
| -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| [UseItem](/devix/devix-inventory/inventory-exports/useitem.md)                                                 | Triggers the usable-item handler through devix-core.       |
| [UpdateSlotMetadata](/devix/devix-inventory/inventory-exports/updateslotmetadata.md)                           | Replaces metadata (`info`) on a player inventory slot.     |
| [UpdateItemInfoBySerie](/devix/devix-inventory/inventory-exports/updateiteminfobyserie.md)                     | Updates item metadata matching name + serie/serial.        |
| [UpdateItemInfoFirstWeaponByName](/devix/devix-inventory/inventory-exports/updateiteminfofirstweaponbyname.md) | Updates metadata on the first weapon stack with that name. |
| [DecreaseWeaponDurabilityByShoot](/devix/devix-inventory/inventory-exports/decreaseweapondurabilitybyshoot.md) | Decreases equipped/used weapon condition when shooting.    |

## Server — Opening UI for player

| Export                                                                                           | Description                                                                  |
| ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- |
| [OpenStashInventory](/devix/devix-inventory/inventory-exports/openstashinventory.md)             | Opens a stash by its unique ID.                                              |
| [OpenSecondInventory](/devix/devix-inventory/inventory-exports/opensecondinventory.md)           | Opens a second panel for stashes, trunks, gloveboxes, or searches.           |
| [OpenInventory](/devix/devix-inventory/inventory-exports/openinventory.md)                       | Opens inventory UI.                                                          |
| [OpenInventoryById](/devix/devix-inventory/inventory-exports/openinventorybyid.md)               | Opens another player's inventory for an admin/viewer.                        |
| [OpenPlayerSearchForAdmin](/devix/devix-inventory/inventory-exports/openplayersearchforadmin.md) | Admin search of a target inventory (no distance / hands-up / weapon checks). |

## Server — Stash API

| Export                                                                           | Description                                                     |
| -------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| [RegisterStash](/devix/devix-inventory/inventory-exports/registerstash.md)       | Registers a stash (id, label, slots, max weight, owner/groups). |
| [NormalizeStashId](/devix/devix-inventory/inventory-exports/normalizestashid.md) | Normalizes a stash id string for consistent storage keys.       |
| [RegisterShop](/devix/devix-inventory/inventory-exports/registershop.md)         | Registers a shop type and its item data (ox-style bridge).      |
| [GetStashItems](/devix/devix-inventory/inventory-exports/getstashitems.md)       | Returns stash contents as a slot-based table.                   |
| [AddItemStash](/devix/devix-inventory/inventory-exports/additemstash.md)         | Adds an item into a stash (finds a free slot).                  |
| [RemoveItemStash](/devix/devix-inventory/inventory-exports/removeitemstash.md)   | Removes an item from a stash.                                   |

## Server — Grid & clothes

| Export                                                                                                   | Description                                            |
| -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| [LoadGridInventory](/devix/devix-inventory/inventory-exports/loadgridinventory.md)                       | Loads raw grid inventory from the database.            |
| [SaveGridInventory](/devix/devix-inventory/inventory-exports/savegridinventory.md)                       | Writes a grid inventory to the database.               |
| [LoadClothes](/devix/devix-inventory/inventory-exports/loadclothes.md)                                   | Loads saved clothing slots for a source or identifier. |
| [GetPlayerIdentifierForSource](/devix/devix-inventory/inventory-exports/getplayeridentifierforsource.md) | Returns the framework identifier for a player source.  |

## Server — Equipped weapon

| Export                                                                                                   | Description                                                                    |
| -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| [SetEquippedWeapon](/devix/devix-inventory/inventory-exports/setequippedweapon.md)                       | Tracks the player's currently equipped weapon data.                            |
| [GetEquippedWeapon](/devix/devix-inventory/inventory-exports/getequippedweapon.md)                       | Returns the currently equipped weapon table.                                   |
| [SetEquippedWeaponCondition](/devix/devix-inventory/inventory-exports/setequippedweaponcondition.md)     | Sets condition on the equipped weapon info.                                    |
| [SetEquippedWeaponMetadata](/devix/devix-inventory/inventory-exports/setequippedweaponmetadata.md)       | Replaces equipped weapon `info` metadata.                                      |
| [ClearEquippedWeapon](/devix/devix-inventory/inventory-exports/clearequippedweapon.md)                   | Clears equipped weapon state for the player.                                   |
| [SyncEquippedWeaponAmmoToGrid](/devix/devix-inventory/inventory-exports/syncequippedweaponammotogrid.md) | Syncs equipped weapon ammo into the inventory grid slot.                       |
| [SyncEquippedAmmoOnGridLoad](/devix/devix-inventory/inventory-exports/syncequippedammoongridload.md)     | When grid loads, syncs ammo onto the equipped weapon if it matches name/serie. |
| [PlayerDroppedWeaponCleanup](/devix/devix-inventory/inventory-exports/playerdroppedweaponcleanup.md)     | Cleans equipped weapon state when the player drops or disconnects.             |
| [getConfigWeaponAttachments](/devix/devix-inventory/inventory-exports/getconfigweaponattachments.md)     | Returns the weapon attachments config table.                                   |

## Server — Hooks (ox bridge)

| Export                                                                                   | Description                                                             |
| ---------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| [registerHook](/devix/devix-inventory/inventory-exports/registerhook.md)                 | Registers an ox\_inventory-style hook callback.                         |
| [RegisterHookCallback](/devix/devix-inventory/inventory-exports/registerhookcallback.md) | Alias of registerHook.                                                  |
| [RegisterHookExport](/devix/devix-inventory/inventory-exports/registerhookexport.md)     | Registers a hook that calls another resource's export with the payload. |
| [removeHooks](/devix/devix-inventory/inventory-exports/removehooks.md)                   | Removes hooks registered by a resource (usually on stop).               |

## Server — Misc

| Export                                                                                               | Description                                                       |
| ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| [UpdateItembackState](/devix/devix-inventory/inventory-exports/updateitembackstate.md)               | Refreshes itemback (weapon-on-back) visuals/state for the player. |
| [ReloadCreatorLootFromJson](/devix/devix-inventory/inventory-exports/reloadcreatorlootfromjson.md)   | Reloads loot-creator definitions from JSON on disk.               |
| [CanOpenInventoryAdminPanel](/devix/devix-inventory/inventory-exports/canopeninventoryadminpanel.md) | Whether the player is allowed to open the inventory admin panel.  |

## Client — Opening UI

| Export                                                                                 | Description                                                                    |
| -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| [GetItemList](/devix/devix-inventory/inventory-exports/getitemlist.md)                 | Returns the full shared item list.                                             |
| [OpenInventory](/devix/devix-inventory/inventory-exports/openinventory.md)             | Opens inventory UI.                                                            |
| [OpenStashInventory](/devix/devix-inventory/inventory-exports/openstashinventory.md)   | Opens a stash by its unique ID.                                                |
| [OpenSecondInventory](/devix/devix-inventory/inventory-exports/opensecondinventory.md) | Opens a second panel for stashes, trunks, gloveboxes, or searches.             |
| [SetStashTarget](/devix/devix-inventory/inventory-exports/setstashtarget.md)           | Sets stash target context used when opening a stash from client scripts.       |
| [OpenCrafting](/devix/devix-inventory/inventory-exports/opencrafting.md)               | Opens the crafting UI.                                                         |
| [OpenDrop](/devix/devix-inventory/inventory-exports/opendrop.md)                       | Opens a ground drop by id.                                                     |
| [OpenGlovebox](/devix/devix-inventory/inventory-exports/openglovebox.md)               | Opens the vehicle glovebox (entity or plate).                                  |
| [OpenTrunk](/devix/devix-inventory/inventory-exports/opentrunk.md)                     | Opens the vehicle trunk (entity or plate).                                     |
| [SearchPlayer](/devix/devix-inventory/inventory-exports/searchplayer.md)               | Requests a search of another player's inventory. Config controls requirements. |
| [CloseInventory](/devix/devix-inventory/inventory-exports/closeinventory.md)           | Closes inventory UI and releases NUI focus.                                    |
| [IsOpen](/devix/devix-inventory/inventory-exports/isopen.md)                           | Whether the inventory UI is currently open.                                    |

## Client — State, admin, clothes

| Export                                                                                                       | Description                                                   |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------- |
| [SetInventoryDeathLock](/devix/devix-inventory/inventory-exports/setinventorydeathlock.md)                   | Locks/unlocks inventory while the player is dead.             |
| [GetInventoryDeathLock](/devix/devix-inventory/inventory-exports/getinventorydeathlock.md)                   | Returns whether death-lock is active.                         |
| [HasItem](/devix/devix-inventory/inventory-exports/hasitem.md)                                               | Whether the player has at least the given amount.             |
| [GetInventoryLocaleForNui](/devix/devix-inventory/inventory-exports/getinventorylocalefornui.md)             | Locale strings table for the inventory NUI.                   |
| [ApplyClothingFromServer](/devix/devix-inventory/inventory-exports/applyclothingfromserver.md)               | Re-applies clothing visuals from server-stored clothing data. |
| [OpenAdminPanel](/devix/devix-inventory/inventory-exports/openadminpanel.md)                                 | Opens the inventory admin panel if the player is allowed.     |
| [StartWeaponAttachment3DPreview](/devix/devix-inventory/inventory-exports/startweaponattachment3dpreview.md) | Starts the 3D weapon attachment preview camera/prop.          |
| [StopWeaponAttachment3DPreview](/devix/devix-inventory/inventory-exports/stopweaponattachment3dpreview.md)   | Stops the 3D weapon attachment preview.                       |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://devix.gitbook.io/devix/devix-inventory/inventory-exports.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.