search

Server

hashtag
📦 Core Item Operations

These functions are the most commonly used for interacting with player items, such as adding, removing, and checking item counts.

hashtag
AddItem

Adds an item to an inventory. This function handles all logic regarding stacking, weight limits, and finding available slots. If the inventory is full or the item is invalid, it returns false.

exports['ak47_inventory']:AddItem(inv, item, amount, slot, info, weight, expiretime)

  • inv: string or number

    • player id (source) or unique inventory identifier

  • item: string

    • item name

  • amount: number

    • amount of the item to add

  • slot: number (optional)

    • specific slot index to place the item in (force placement)

  • info: table (optional)

    • item metadata table (e.g., durability, serial number)

  • weight: number (optional)

    • override the default weight of this specific item instance

  • expiretime: number (optional)

    • override the default expiration timestamp of this specific item instance

Return: boolean, string or number

  • success (true/false)

  • reason (if failed) OR slot index (if success)

hashtag
RemoveItem

Removes a specific quantity of an item from an inventory. It prioritizes removing from specific slots if provided, otherwise it searches and removes from the first available stack(s).

  • inv: string or number

    • player id (source) or unique inventory identifier

  • item: string

    • item name

  • amount: number

    • amount of the item to remove

  • slot: number (optional)

    • specific slot index to remove the item from

Return: boolean, string

  • success (true/false)

  • reason (e.g., "notenough")

hashtag
HasItems

Verifies if an inventory contains a list of specific items in the required quantities. This is commonly used for crafting recipes or trade requirements.

  • inv: string or number

  • items: table

    • Key-value table: {[item_name] = amount} (e.g., {'bread' = 1, 'water' = 2})

Return: boolean, table

  • hasAll (true if all items are present)

  • missingItems (table of missing items and the amounts still needed)

hashtag
GetItem

Retrieves a consolidated object containing data about a specific item in an inventory. This is useful for checking if a player has an item and getting its total combined count across all slots.

  • inv: string or number

  • item: string

    • item name

  • info: table (optional)

    • filter by specific metadata

  • strict: boolean (optional)

    • if true, checks for an exact metadata match (does not sum duplicates with different metadata)

Return: table

  • item table with total item amount & properties

hashtag
GetAmount

Returns the total numeric count of a specific item in an inventory. It sums up all stacks of that item.

  • identifier: string or number

  • item: string

  • info: table (optional)

  • strict: boolean (optional)

Return: number

hashtag
CanAddItem

Checks if an inventory has enough weight capacity and slot space to accept an item. This function does not actually add the item, it only performs the check.

  • identifier: string or number

  • item: string

  • amount: number

  • skipWeight: boolean (optional)

    • if true, ignores weight limit checks (only checks slot limit)

Return: boolean

hashtag
CanCarryAmount

Calculates the maximum amount of a specific item that fits into the inventory's remaining weight capacity.

  • identifier: string or number

  • item: string or table

Return: number

  • amount that fits

hashtag
CanSwapItem

Determines if two items can be swapped between slots or inventories without exceeding weight limits. This is used during drag-and-drop operations.

  • inv: string or number

  • firstItem: string

  • firstItemCount: number

  • testItem: string

  • testItemCount: number

Return: boolean

hashtag
🗃️ Inventory Management

Functions for managing inventory instances (opening, creating, loading, saving).

hashtag
OpenInventory

Opens the inventory user interface for a specific player. This allows them to view the specified inventory identifier.

  • source: number

    • The player ID opening the inventory

  • identifier: string

    • The identifier of the inventory to open

  • data: table (optional)

    • Configuration data for creating the inventory on-the-fly (e.g., dumpsters)

hashtag
CloseInventory

Forces the inventory UI to close for a specific player.

  • source: number

hashtag
CreateInventory

Initializes a new inventory in the system memory. This is required for creating stashes, trunks, or other non-player inventories before they can be accessed.

  • identifier: string

  • data: table

    • label: string

    • maxWeight: number

    • slots: number

    • type: string (backpack, stash, player, shop, trunk, glovebox)

    • type2: string (optional, e.g. 'smallBackpack')

    • temp: boolean (optional, true = not saved to database)

    • whitelist: table (optional)

    • blacklist: table (optional)

Example:

hashtag
LoadInventory

lLoads an inventory from the database. If provided with data, it can also create the inventory if it doesn't already exist.

Return: boolean

Example:

hashtag
SaveInventory

Forces an immediate save of a specific inventory to the database.

  • identifier: string or number

hashtag
SaveAllInventory

Forces a save of all currently loaded inventories that have pending changes. This is typically run automatically on server stop/restart.

hashtag
ClearInventory

Removes all items from an inventory, effectively wiping it clean.

  • identifier: string or number

hashtag
UnloadInventory

Unloads an inventory from server memory (saving it first) to free up resources. It will be reloaded from the database if accessed again.

  • identifier: string or number

hashtag
DeleteInventory

Permanently deletes an inventory from the database and removes it from server memory.

  • identifier: string or number

hashtag
🔍 Data Retrieval & Getters

Functions for reading specific states or configurations.

hashtag
GetInventory

Retrieves the full inventory object, including the list of items, current weight, max weight, and other configuration properties.

  • identifier: string or number

Return: table

  • inventoryTable

hashtag
GetInventoryItems

Retrieves just the list (table) of items from an inventory. Useful for iteration when you don't need weight or other inventory properties.

  • identifier: string or number

Return: table

  • itemsTable

hashtag
Search

A versatile search function to find item counts or full slot data.

  • identifier: string or number

  • search: string

    • 'slots' (returns a table of item data) or 'count'/'amount' (returns the total numeric count)

  • item: table (list of item names) or string

  • info: table or string (optional)

hashtag
Items

Retrieves the shared item configuration from the server. You can use this to fetch the definition of every item or a specific item's details (label, weight, etc.).

hashtag
GetItemLabel

Returns the friendly display label of a specific item name (e.g., returns "Water Bottle" for input "water").

  • item: string

    • item name

Return: string

hashtag
GetCurrentWeapon

Retrieves the item data of the weapon currently equipped by the player.

  • identifier: string or number

Return: table

  • weaponItemData

hashtag
CanCarryWeight

Checks if the inventory has enough remaining capacity to hold a specific amount of weight.

  • identifier: string or number

  • weight: number

Return: boolean, number

  • canHold (true/false)

  • availableWeight (remaining weight capacity)

hashtag
GetEmptySlot

Returns the index of the first available empty slot in the inventory. Returns nil if full.

  • identifier: string or number

Return: number

  • slotId

hashtag
GetContainerFromSlot

If a slot contains a container item (like a backpack), this retrieves the actual inventory data object associated with that container.

  • identifier: string or number

  • slotId: number

Return: table

  • containerInventoryData

hashtag
📍 Slot Operations

Functions for interacting with specific slots or finding item locations.

hashtag
GetSlot

Retrieves the item data stored at a specific slot index. Returns nil or an empty table if the slot is empty.

  • identifier: string or number

  • slot: number

Return: table

  • The item data table at that slot

hashtag
GetSlotForItem

Finds the optimal slot index for an item. It will return the index of an existing stack (if stackable and space exists) or the first available empty slot.

  • identifier: string or number

  • itemName: string

  • info: table (optional)

Return: number

  • slotId

hashtag
GetSlotWithItem

Retrieves the data of the first slot found containing the specific item.

  • identifier: string or number

  • itemName: string

  • info: table (optional)

  • strict: boolean (optional)

Return: table

  • slotData

hashtag
GetSlotIdWithItem

Retrieves the slot index (ID) of the first slot found containing the specific item.

  • identifier: string or number

  • itemName: string

  • info: table (optional)

  • strict: boolean (optional)

Return: number

  • slotId

hashtag
GetSlotsWithItem

Retrieves a list of all slot data tables that contain the specific item. Useful for finding every instance of an item split across multiple slots.

  • identifier: string or number

  • itemName: string

  • info: table (optional)

  • strict: boolean (optional)

Return: table

  • list of slotData objects

hashtag
GetSlotIdsWithItem

Retrieves a list of all slot IDs containing the item.

  • Return: table (List of IDs).

hashtag
GetItemSlots

Provides detailed information about where an item is located, including a map of slots-to-amounts and the count of empty slots.

  • identifier: string or number

  • item: table (must have .name) or string

  • info: table (optional)

Return: table, number, number

  • slots (key=slotId, value=amount)

  • totalAmount

  • emptySlotsCount

hashtag
GetFirstItem

Finds and returns the data of the first occurrence of an item found in the inventory, regardless of how many stacks exist.

  • inv: string or number

  • item: string

    • item name

Return: table

  • first found item table

hashtag
✏️ Updates & Modification

Functions that modify existing items or inventory properties.

hashtag
SetItemInfo

Updates the metadata (info table) of an item in a specific slot.

  • identifier: string or number

  • slot: number

  • info: table

hashtag
SetQuality

Sets the quality (durability) of an item in a specific slot.

  • identifier: string or number

  • slot: number

  • quality: number

hashtag
RemoveQuality

Reduces the quality (durability) of an item in a specific slot. Can optionally remove the item if quality reaches zero.

  • identifier: string or number

  • slot: number

  • value: number

hashtag
SetMaxWeight

Dynamically updates the maximum weight limit of an inventory.

  • identifier: string or number

  • newWeight: number

hashtag
SetSlotCount

Changes the number of slots an inventory is currently have.

  • identifier: string or number

  • slots: number

hashtag
UpdatePlayerInv

Forces a synchronization of the server-side inventory data to the client-side UI for a specific player. Use this if you modify inventory data manually.

  • identifier: string or number

hashtag
SetInvItems

Completely overwrites the items in an inventory with a new table of items. Warning: This replaces the entire item set.

  • identifier: string or number

  • items: table

hashtag
ClearClothing

Removes all items stored in the clothing slots of an inventory (e.g., masks, hats).

  • identifier: string or number

hashtag
🛠️ Administrative & Special

Specialized functions for shops, police systems, and vehicle handling.

hashtag
ConfiscateInventory

Moves all items from a player's inventory to a temporary "confiscated" storage (prefixed with conf:) and clears their main inventory.

  • identifier: string or number

hashtag
ReturnInventory

Restores items from the "confiscated" storage back to the player's main inventory.

  • identifier: string or number

hashtag
CreateShop

Helper to create a shop inventory with items for sale. Supports job restrictions, licenses, and custom sell prices.

  • identifier: string - Unique ID for this shop.

  • name: string - Label displayed to the player.

  • itemTable: table - List of items with configurations (see example below).

  • account: string - Currency to use (e.g., 'money', 'bank', 'black_money').

Supported itemTable options:

  • item: Item name (required)

  • buyPrice: Cost to purchase from shop

  • sellPrice: Money given to player when selling TO shop

  • stock: Available quantity (-1 for infinite)

  • jobs: Table of allowed jobs/grades {[jobName] = minGrade}

  • gangs: Table of allowed gangs/grades {[gangName] = minGrade}

  • license: Table { name = "weapon", class = "A" } (optional class)

  • requires: Table of items needed to purchase {[item_name] = amount}

  • hasSerial: Boolean (true generates random serial on purchase)

  • quality: Initial quality (default 100)

Example:

hashtag
SetWhitelistedItemsForContainer

Restricts an inventory to only accept a specific list of items. Any item not in this list cannot be added.

  • identifier: string or number

  • items: table (list of allowed item names)

Example:

hashtag
SetBlacklistedItemsForContainer

Restricts an inventory by preventing specific items from being stored in it.

  • identifier: string or number

  • items: table (list of disallowed item names)

Example:

hashtag
OnChangeVehiclePlate

A utility helper to migrate trunk and glovebox inventories when a vehicle's plate is changed (e.g., applying a fake plate).

  • oldPlate: string

  • newPlate: string

PreviousClientNextEvent Handlers

Last updated