Client Integration

This page documents the public client-side exports for BJJ Inventory v1, with usage examples for external collaborators.

openInventory

Opens an inventory using the passed data.

exports['bjj_inventory']:openInventory(invType, data)

• invType: string — e.g. 'player', 'shop', 'stash', 'crafting', 'container', 'drop', 'glovebox', 'trunk', 'dumpster'
• data: number | string | table

exports['bjj_inventory']:openInventory('player', 3)

exports['bjj_inventory']:openInventory('shop', { type = 'General', id = 4 })

exports['bjj_inventory']:openInventory('stash', 1)
exports['bjj_inventory']:openInventory('stash', 'society_police')
exports['bjj_inventory']:openInventory('stash', { id = 'police_locker', owner = 'license:xxxxxxxx' })

openNearbyInventory

Opens the nearby player's inventory if possible.

exports['bjj_inventory']:openNearbyInventory()

closeInventory

Closes the player's inventory.

exports['bjj_inventory']:closeInventory()

Items

Returns a table of all registered items, or a single item if a name is provided.

exports['bjj_inventory']:Items(itemName)

• itemName?: string

useItem

Uses the passed item, then triggers the callback function.

exports['bjj_inventory']:useItem(data, cb)

• data: table
• cb?: function

useSlot

Uses the item in the given inventory slot.

exports['bjj_inventory']:useSlot(slot)

• slot: number

setStashTarget

Forces the secondary-inventory key to open the passed inventory.

exports['bjj_inventory']:setStashTarget(id, owner)

• id: string | number
• owner?: string | number

getCurrentWeapon

Get data for the currently equipped weapon.

exports['bjj_inventory']:getCurrentWeapon()

displayMetadata

Sets a metadata property to display in the tooltip.

exports['bjj_inventory']:displayMetadata(metadata, value)

• metadata: string | table
• value?: string

giveItemToTarget

Gives an item from the player's inventory to another player.

exports['bjj_inventory']:giveItemToTarget(serverId, slotId, count)

• serverId: number
• slotId: number
• count?: number

weaponWheel

Enables the weapon wheel, but disables the use of inventory weapons.

exports['bjj_inventory']:weaponWheel(state)

• state: boolean

Search

Searches the inventory for an item or list of items.

exports['bjj_inventory']:Search(search, item, metadata)

• search: 'slots' | 'count'
• item: string | table
• metadata?: table | string

Statebags

• invBusy: boolean — Whether the player's inventory is busy
• invHotkeys: boolean — Enable/disable inventory hotkeys
• invOpen: boolean — Whether the inventory is open
• canUseWeapons: boolean — Enable/disable weapon use

local invBusy = LocalPlayer.state.invBusy
LocalPlayer.state.invHotkeys = false