Hooks

Hooks are a way to modify the behavior of the inventory system. They are registered on the server and can be used to modify the behavior of the inventory system, for example to prevent players from moving items to a specific inventory. There are some examples of hooks in the jaksam_inventory/_hooks folder.

Best Practices

Use filters

Always use appropriate filters to avoid unnecessary hook executions

Early returns

Use early returns to exit hooks when conditions aren’t met

Performance

Keep hook logic lightweight to avoid impacting inventory performance

Use Case Examples

Prevent players from stealing items that have the sole_owner metadata field (e.g., VIP items)
Prevent players from moving police weapons into their personal inventory
Allow only one backpack per player inventory
Crafting items by dragging a specific item over another item (for example dragging bread on meat can make a sandwich)
Block item usage when player is handcuffed or in specific zones
Track item usage statistics and achievements
Prevent using certain items while in vehicles
Add starter items to new player inventories when they are created
Pre-populate dumpsters or stashes with random items on creation

API Functions

Register a Hook

exports['jaksam_inventory']:registerHook(eventName, callback, options, priority)

Parameters

Name	Data Type	Description
`eventName`	string	The name of the hook event to listen for (see Available Hook Events below)
`callback`	function	The function to execute when the hook is triggered
`options`	table	Filters and configuration options (see Options Parameter below)
`priority`	number	Execution priority (higher numbers execute first, default: 0)

Return value

Name	Data Type	Description
`hookId`	string	Unique identifier for the registered hook (used to unregister the hook)

Unregister a Hook

exports['jaksam_inventory']:unregisterHook(hookId)

Parameters

Name	Data Type	Description
`hookId`	string	The unique identifier returned when registering the hook

Unregister All Resource Hooks

exports['jaksam_inventory']:unregisterResourceHooks(resourceName)

Parameters

Name	Data Type	Description
`resourceName`	string	Name of the resource to unregister all hooks for

Options Parameter

The options parameter accepts a table with filters to optimize performance.

Common (all events)
Inventory filters
Transfer filters

    local options = {
        -- Debug: Print to console when hook triggers
        print = true,

        -- Only trigger for specific items
        itemNameFilter = {
            bread = true,
            weapon_pistol = true
        },

        -- Only trigger for specific item types
        itemTypeFilter = {
            weapon = true,
            currency = true
        }
    }

For onItemAdded, onItemRemoved, onInventoryCreated:

    local options = {
        -- Filter by inventory type (recommended)
        inventoryTypeFilter = {
            player = true,
            stash = true
        },

        -- Filter by specific inventory patterns (advanced)
        inventoryFilter = {
            "player:.*",      -- All players
            "stash_police"    -- Specific stash
        }
    }

For onItemTransferred only:

    local options = {
        -- Filter source inventory by type
        inventoryFromTypeFilter = { player = true },

        -- Filter source inventory by name pattern
        inventoryFromFilter = {
            "player:.*",      -- All players
            "vehicle:123"     -- Specific vehicle
        },

        -- Filter destination inventory by type
        inventoryToTypeFilter = { stash = true },

        -- Filter destination inventory by name pattern
        inventoryToFilter = {
            "stash_police",   -- Specific stash
            "container:.*"    -- All containers
        },

        -- Only intra-inventory moves (drag within same inventory)
        intraInventoryOnly = true
    }

Available Hook Events

Event	Description
Item added	Triggered when an item is added to an inventory
Item removed	Triggered when an item is removed from an inventory
Item transferred	Triggered when an item is transferred between inventories
Pre use item	Triggered before an item is used, can cancel usage
Post use item	Triggered after an item has been used, notification-only
Inventory created	Triggered when a new inventory is created

Hook Behavior

Priority

Higher numbers execute first (default: 0)

Return values

return nil or return true: allow the action to continue.return false, "message", "notifyType": prevents the action and stops further hook execution. The message and notifyType parameters are optional (notifyType can be "error", "success", "info")

General

Inventory

Jobs Creator

Drugs Creator

Doors Creator

Missions Creator

Blips Creator

Farming Creator

Shops Creator

Robberies Creator

Vehicles Keys

Dealerships Creator

Races Creator

Trackers Creator

Easy Allowlist

Billing UI

Luxury Clothes Theft

Best Practices

Use filters

Early returns

Performance

Use Case Examples

API Functions

Register a Hook

Parameters

Return value

Unregister a Hook

Parameters

Unregister All Resource Hooks

Parameters

Options Parameter

Available Hook Events

Hook Behavior

Priority

Return values

​Best Practices

Use filters

Early returns

Performance

​Use Case Examples

​API Functions

​Register a Hook

​Parameters

​Return value

​Unregister a Hook

​Parameters

​Unregister All Resource Hooks

​Parameters

​Options Parameter

​Available Hook Events

​Hook Behavior

Priority

Return values

Best Practices

Use Case Examples

API Functions

Register a Hook

Parameters

Return value

Unregister a Hook

Parameters

Unregister All Resource Hooks

Parameters

Options Parameter

Available Hook Events

Hook Behavior