❗First Time Setup

IF YOU ARE USING OX, TGIANN, OR QS INVENTORY THEN SKIP THIS!!

ox_inventory, or tgiann-inventory users will automatically get this functionality without additional changes due to the hooks or events that these inventories provide upon use of an item. If you use any of the above inventories and also follow these steps, then your addiction value changes will get doubled, since each item use will trigger two addiction updates

Update to your core script

For anyone not using ox_inventory you'll need to update the UseItem function in your core script to add an extra export. This is so envi-addictions knows when an item has been used and will be able to run the addiction checks upon use. If you do not do this, your addictions will not work!

Navigate to qb-core/server/functions.lua
Find the QBCore.Functions.UseItem function
1. This should be around line 504, but could differ depending on your version

Add the following export to the bottom of the function:

exports['envi-addictions']:UsedItem(source, item)

For example, if you're using qb-inventory then your updated function should look like this:

function QBCore.Functions.UseItem(source, item)
    if GetResourceState('qb-inventory') == 'missing' then return end
    exports['qb-inventory']:UseItem(source, item) -- This might differ depending on what inventory you're using
    exports['envi-addictions']:UsedItem(source, item) -- MAKE SURE YOU ADD THIS LINE
end

qb-inventory V2 item usage does not go through the function used in the qb-core integration to enable item listening for qb-inventory v2 find this function add add the the envi-addictions export where shown below:

RegisterNetEvent('qb-inventory:server:useItem', function(item)
    local src = source
    local itemData = GetItemBySlot(src, item.slot)
    if not itemData then return end
    local itemInfo = QBCore.Shared.Items[itemData.name]
    if itemData.type == 'weapon' then
        TriggerClientEvent('qb-weapons:client:UseWeapon', src, itemData, itemData.info.quality and itemData.info.quality > 0)
        TriggerClientEvent('qb-inventory:client:ItemBox', src, itemInfo, 'use')
    elseif itemData.name == 'id_card' then
        UseItem(itemData.name, src, itemData)
        TriggerClientEvent('qb-inventory:client:ItemBox', source, itemInfo, 'use')
        local playerPed = GetPlayerPed(src)
        local playerCoords = GetEntityCoords(playerPed)
        local players = QBCore.Functions.GetPlayers()
        local gender = item.info.gender == 0 and 'Male' or 'Female'
        for _, v in pairs(players) do
            local targetPed = GetPlayerPed(v)
            local dist = #(playerCoords - GetEntityCoords(targetPed))
            if dist < 3.0 then
                TriggerClientEvent('chat:addMessage', v, {
                    template = '<div class="chat-message advert" style="background: linear-gradient(to right, rgba(5, 5, 5, 0.6), #74807c); display: flex;"><div style="margin-right: 10px;"><i class="far fa-id-card" style="height: 100%;"></i><strong> {0}</strong><br> <strong>Civ ID:</strong> {1} <br><strong>First Name:</strong> {2} <br><strong>Last Name:</strong> {3} <br><strong>Birthdate:</strong> {4} <br><strong>Gender:</strong> {5} <br><strong>Nationality:</strong> {6}</div></div>',
                    args = {
                        'ID Card',
                        item.info.citizenid,
                        item.info.firstname,
                        item.info.lastname,
                        item.info.birthdate,
                        gender,
                        item.info.nationality
                    }
                })
            end
        end
    elseif itemData.name == 'driver_license' then
        UseItem(itemData.name, src, itemData)
        TriggerClientEvent('qb-inventory:client:ItemBox', src, itemInfo, 'use')
        local playerPed = GetPlayerPed(src)
        local playerCoords = GetEntityCoords(playerPed)
        local players = QBCore.Functions.GetPlayers()
        for _, v in pairs(players) do
            local targetPed = GetPlayerPed(v)
            local dist = #(playerCoords - GetEntityCoords(targetPed))
            if dist < 3.0 then
                TriggerClientEvent('chat:addMessage', v, {
                    template = '<div class="chat-message advert" style="background: linear-gradient(to right, rgba(5, 5, 5, 0.6), #657175); display: flex;"><div style="margin-right: 10px;"><i class="far fa-id-card" style="height: 100%;"></i><strong> {0}</strong><br> <strong>First Name:</strong> {1} <br><strong>Last Name:</strong> {2} <br><strong>Birth Date:</strong> {3} <br><strong>Licenses:</strong> {4}</div></div>',
                    args = {
                        'Drivers License',
                        item.info.firstname,
                        item.info.lastname,
                        item.info.birthdate,
                        item.info.type
                    }
                }
                )
            end
        end
    else
        -- Added for Envi-Addictions --
        exports['envi-addictions']:UsedItem(src, itemData.name)
        --------------------------------------------------------
        UseItem(itemData.name, src, itemData)
        TriggerClientEvent('qb-inventory:client:ItemBox', src, itemInfo, 'use')
    end
end)

Only do this if you are NOT using ox_inventory

Navigate to [core]/es_extended/server/functions.lua
Find the ESX.UseItem function
1. Should be around line 515

Replace that function with the following:

function ESX.UseItem(source, item, ...)
    if ESX.Items[item] then
        local itemCallback = Core.UsableItemsCallbacks[item]

        if itemCallback then
            local success, result = pcall(itemCallback, source, item, ...)

            if not success then
                return result and print(result) or print(('[^3WARNING^7] An error occured when using item ^5"%s"^7! This was not caused by ESX.'):format(item))
            end
            
            exports['envi-addictions']:UsedItem(source, item) -- NEWLY ADDED LINE
        end
    else
        print(('[^3WARNING^7] Item ^5"%s"^7 was used but does not exist!'):format(item))
    end
end

PreviousEnvi-Addictions NextInventory Setup

Last updated 5 days ago

hashtagIF YOU ARE USING OX, TGIANN, OR QS INVENTORY THEN SKIP THIS!!

hashtagUpdate to your core script

IF YOU ARE USING OX, TGIANN, OR QS INVENTORY THEN SKIP THIS!!

Update to your core script