Server Integration

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

setPlayerInventory

Creates and sets the player's inventory.

exports['bjj_inventory']:setPlayerInventory(player, data)

• player: table (see docs for structure)
• data?: table (optional, loads from DB if not provided)

forceOpenInventory

Forces a player to open an inventory, bypassing usual security checks.

exports['bjj_inventory']:forceOpenInventory(playerId, invType, data)

• playerId: number
• invType: string — e.g. 'player', 'stash', 'container', etc.
• data: number | string | table

exports['bjj_inventory']:forceOpenInventory(1, 'player', 3)

RegisterCommand('openplayerinv', function(source, args)
    exports['bjj_inventory']:forceOpenInventory(source, 'player', tonumber(args[1]))
end, true)

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

UpdateVehicle

Update the internal reference to vehicle stashes.

exports['bjj_inventory']:UpdateVehicle(oldPlate, newPlate)

• oldPlate: string
• newPlate: string

Items

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

exports['bjj_inventory']:Items(itemName)

• itemName?: string

AddItem / RemoveItem

Add or remove items from inventories.

exports['bjj_inventory']:AddItem(inv, item, count, metadata, slot, cb)
exports['bjj_inventory']:RemoveItem(inv, item, count, metadata, slot, ignoreTotal)

• See API Reference for argument details and examples.

GetItem / GetItemCount

Get item data or count from an inventory.

exports['bjj_inventory']:GetItem(inv, item, metadata, returnsCount)
exports['bjj_inventory']:GetItemCount(inv, itemName, metadata, strict)

RegisterStash / CreateTemporaryStash

Register custom or temporary stashes.

exports['bjj_inventory']:RegisterStash(id, label, slots, maxWeight, owner, groups, coords)
exports['bjj_inventory']:CreateTemporaryStash(properties)

More Functions

See the API Reference for additional inventory, slot, and search functions.