Exports

List of every exports for axr_inventory to setup your server

Server Exports

getPlayerInventory

---Get player inventory data| 1 param
---@param user_id int | required
--- return array
exports.axr_inventory:getPlayerInventory(user_id);

getUserMaxWeight

---Get player max weight| 1 param
---@param user_id int | required
--- return number (Int32)
exports.axr_inventory:getUserMaxWeight(user_id);

getUserWeight

---Get player current weight| 1 param
---@param user_id int | required
--- return number (Int32)
exports.axr_inventory:getUserWeight(user_id);

getVehicleItems

---Get vehicle items (trunk/glovebox) | 3 params
---@param user_id int | required
---@param category string | required, 'trunk' or 'glovebox'
---@param vehicle_code string | required
--- return array
exports.axr_inventory:getVehicleItems(user_id, category, vehicle_code);

getPlayerItemAmount

---Get player item amount | 2 params
---@param user_id int | required
---@param item_code string | required
--- return number (Int32)
exports.axr_inventory:getPlayerItemAmount(user_id, item_code); 

hasPlayerItem

---Has player item in inventory | 2 params
---@param user_id int | required
---@param item_code string | required
--- return boolean (true/false)
exports.axr_inventory:hasPlayerItem(user_id, item_code); 

removePlayerItem

---Remove player item from inventory | 5 params
---@param user_id int | required
---@param item_code string | required
---@param amount int | required
---@param notify boolean | required (true/false)
---@param from string | optional
--- return boolean (true/false) if item was removed
exports.axr_inventory:removePlayerItem(user_id, item_code, amount, notify, from);

givePlayerItem

---Give player item | 5 params
---@param user_id int | required
---@param item_code string | required
---@param amount int | required
---@param notify boolean | required (true/false)
---@param from string | optional
--- return boolean (true/false) if item was added in player inventory
exports.axr_inventory:givePlayerItem(user_id, item_code, amount, notify, from);

openChest

---Give player item | 3 params
---@param user_id int | required
---@param chestId string | required
---@param type string | required , need to match with Config.allowedChestType
--- return boolean (true/false) return true if chest is successful open by player
exports.axr_inventory:openChest(user_id,chestId,type);

createItem

---Create Inventory Item | 6 params
---@param item string | required
---@param item name | optional (if not is replaced with 'No item name')
---@param description string | optional (if not is replaced with 'No item description')
---@param weight float | optional (if not is replaced with 0.01)
---@param type string | optional (if not is replaced with 'all')
---@param onUse function | optional (if not item is not usable)
--- return boolean (true/false) return true if item was created
exports.axr_inventory:createItem(item, name, description, weight, itemType, onUse);

getItemWeight

---Get item weight | 1 param
---@param item_code string | required
--- return float/integer| return 0.0 if item_code is nil
exports.axr_inventory:getItemWeight(item_code);

getItemType

---Get item type | 1 param
---@param item_code string | required
--- return string | return nil if item_code is nil or 'all' if type is not setted in config/items.lua
exports.axr_inventory:getItemType(item_code);

getItemName

---Get item name | 1 param
---@param item_code string | required
--- return string | return nil if item_code is nil or 'No Name' if type is not setted in config/items.lua
exports.axr_inventory:getItemName(item_code);

Extra Events: (client)

axr_inventory:closeForceInventory