Client

Ready

Is player inverntory is ready to use

exports['ak47_inventory']:Ready()

Return: boolean

OpenInventory

exports['ak47_inventory']:OpenInventory(data)

• data: table or string

  • string: target inventory identifier

  • table:

    • identifier (inventory identifier)

    • label (inventory label)

    • type (inventory type: stash, backpack, glovebox, trunk)

    • maxWeight (inventory max weight)

    • slots (inventory max slots)

Example:

Existing Stash

exports['ak47_inventory']:OpenInventory('stash:1234')

New/Housing Stash

Player Inventory

OpenNearbyInventory

-- opens nearby player invetnroy
exports['ak47_inventory']:OpenNearbyInventory()

CloseInventory

exports['ak47_inventory']:CloseInventory()

Items

All Items

exports['ak47_inventory']:Items()

Single Item

GetItem

exports['ak47_inventory']:GetItem(name, info, strict)

• name: string

  • item name

• info?: any

  • Only returns the amount of items that strictly match the given info.

• Strictly match info properties, otherwise use partial matching.

GetFirstItem

exports['ak47_inventory']:GetFirstItem(item)

• item: string

  • item name

Return: table

• first item table with total item amount & properties

GetItemLabel

exports['ak47_inventory']:GetItemLabel(name)

• name: string

  • item name

• return: string

  • item label

HasItems

exports['ak47_inventory']:HasItems(items)

• items: table

  • table of items

• return:

  • boolean

  • table table of missing items with amount

Example:

exports['ak47_inventory']:HasItems({
    water = 5,
    bread = 3
})

Search

exports['ak47_inventory']:Search(searchType, item, info)

• searchType: 'slots' or 'amount'

  • 'slots' returns a table of slots where the item was found at.

  • 'amount' returns the amount of the specified item in player's inventory. If searching for multiple items returns key-value pairs of itemName = amount.

• item: table or string

  • Can be a single item name or array of item names.

• info?: table or string

  • If info is provided as a string it will search the item's info.type property.

Amount

Single Item

local amount = exports['ak47_inventory']:Search('amount', 'water')
print('You have '..amount.. ' water')

Multiple Items

Slots

Single Item

local water = exports['ak47_inventory']:Search('slots', 'water')
local amount = 0
 
for _, v in pairs(water) do
    print(v.slot..' contains '..v.amount..' water '..json.encode(v.info))
    amount = amount + v.amount
end
 
print('You have '..amount..' water')

Multiple Items

GetAmount

exports['ak47_inventory']:GetAmount(itemName, info, strict)

• itemName: string

• info?: table

• strict?: boolean

  • Strictly match info properties, otherwise use partial matching.

Return:

• amount: number

GetPlayerItems

exports['ak47_inventory']:GetPlayerItems()

Return:

• items: table

GetPlayerWeight

exports['ak47_inventory']:GetPlayerWeight()

Return:

• inventoryWeight: number

GetPlayerMaxWeight

exports['ak47_inventory']:GetPlayerMaxWeight()

Return:

• maxWeight: number

GetSlotWithItem

exports['ak47_inventory']:GetSlotWithItem(itemName, info, strict)

• itemName: string

• info?: table

• strict?: boolean

  • Strictly match info properties, otherwise use partial matching.

Return:

• slotData: table?

GetSlotIdWithItem

exports['ak47_inventory']:GetSlotIdWithItem(itemName, info, strict)

• itemName: string

• info?: table

• strict?: boolean

  • Strictly match info properties, otherwise use partial matching.

Return:

• slotId: number?

GetSlotsWithItem

exports['ak47_inventory']:GetSlotsWithItem(itemName, info, strict)

• itemName: string

• info?: table

• strict?: boolean

  • Strictly match info properties, otherwise use partial matching.

Return:

• slotsData: table[]?

GetSlotIdsWithItem

exports['ak47_inventory']:GetSlotIdsWithItem(itemName, info, strict)

• itemName: string

• info?: table

• strict?: boolean

  • Strictly match info properties, otherwise use partial matching.

Return:

• slotIds: number[]?

SetInventoryBusy

exports['ak47_inventory']:SetInventoryBusy(boolean) --true/false

Use Case:

local invBusy = LocalPlayer.state.invBusy
 
if invBusy then
    -- Do stuff when busy
else
    -- Do stuff when not busy
end

UnEquipeWeapon

exports['ak47_inventory']:UnEquipeWeapon()