API Reference

This page documents the public API for BJJ Inventory v1. Only use these exports and events for integration.

Exports

Export	Parameters	Returns	Description
`getInventory()`	—	table	Returns the inventory core object
`getItem(itemName)`	`itemName: string`	table \| nil	Returns item data for the given name
`addItem(source, item, count)`	`source: number`, `item: string`, `count: number`	boolean	Adds item(s) to a player's inventory
`removeItem(source, item, count)`	`source: number`, `item: string`, `count: number`	boolean	Removes item(s) from a player's inventory
`getItemCount(source, item)`	`source: number`, `item: string`	number	Returns the count of an item in a player's inventory
`openStash(source, stashId)`	`source: number`, `stashId: string	number`	boolean
`closeStash(source, stashId)`	`source: number`, `stashId: string	number`	boolean

Parameter Details

addItem / removeItem

source: Player's server ID
item: Name of the item (string)
count: Number of items to add/remove (integer)

getItem / getItemCount

itemName: Name of the item (string)

openStash / closeStash

stashId: Stash identifier (string or number)

Events

Event	Parameters	Description
`bjj_inventory:client:inventoryChanged`	`data: table`	Fired when a player's inventory changes
`bjj_inventory:client:stashOpened`	`stashId: string	number`
`bjj_inventory:client:stashClosed`	`stashId: string	number`
`bjj_inventory:client:itemUsed`	`item: string`, `data: table`	Fired when an item is used

Example Usage

-- Add an item to a player
exports['bjj_inventory']:addItem(source, 'repairkit', 1)

-- Listen for inventory changes
RegisterNetEvent('bjj_inventory:client:inventoryChanged', function(data)
    print('Inventory updated for: ' .. data.owner)
end)

For advanced use cases, contact the development team for guidance on safe integration.

API Reference

On this page