Grid Inventory

Server events

Listen for inventory activity, item changes and observer updates on the server.

Event reference

Server events

Subscribe to changes emitted by the inventory system.

7 events

NameDescriptionParameters

avp_grid_inventory:onInventoryOpen

Triggered when a player opens their inventory.

None

avp_grid_inventory:onInventoryClose

Triggered when a player closes their inventory.

None

avp_grid_inventory:onItemAdded

Triggered when an inventory receives a new item.

inventoryUniqueIDstringitemInventoryItemaddedItemNamestringaddedQuantitynumber

avp_grid_inventory:onItemRemoved

Triggered when an entire item stack is removed and its itemHash is destroyed.

inventoryUniqueIDstringitemInventoryItem

avp_grid_inventory:onItemUpdated

Triggered when an item is updated.

inventoryUniqueIDstringitemInventoryItem

avp_grid_inventory:onObserverAdded

Triggered when a player is added to the inventory observers.

inventoryUniqueIDstringsourcenumber

avp_grid_inventory:onObserverRemoved

Triggered when a player is removed from the inventory observers.

inventoryUniqueIDstringsourcenumber

Item removal

onItemRemoved is only emitted when a complete stack is removed and its itemHash is destroyed. Reducing the quantity of an existing stack does not trigger it.

Configuration

Inventory lifecycle

Read the player inventory weight when it is opened or closed.

RegisterNetEvent("avp_grid_inventory:onInventoryOpen", function()
    local playerId = source
    local weight = exports["avp_grid_inventory"]:GetWeight(playerId)
end)

RegisterNetEvent("avp_grid_inventory:onInventoryClose", function()
    local playerId = source
    local weight = exports["avp_grid_inventory"]:GetWeight(playerId)
end)

Configuration

Item changes

Handle item additions, removals and updates.

AddEventHandler("avp_grid_inventory:onItemAdded", function(inventoryUniqueID, item, addedItemName, addedQuantity)
    print(item.itemHash)
end)

AddEventHandler("avp_grid_inventory:onItemRemoved", function(inventoryUniqueID, item)
    print(item.itemHash)
end)

AddEventHandler("avp_grid_inventory:onItemUpdated", function(inventoryUniqueID, item)
    print(item.itemHash)
end)

Configuration

Observer changes

Read the inventory weight when observers are added or removed.

AddEventHandler("avp_grid_inventory:onObserverAdded", function(inventoryUniqueID, source)
    local weight = exports["avp_grid_inventory"]:GetWeight(inventoryUniqueID)
    print(weight)
end)

AddEventHandler("avp_grid_inventory:onObserverRemoved", function(inventoryUniqueID, source)
    local weight = exports["avp_grid_inventory"]:GetWeight(inventoryUniqueID)
    print(weight)
end)