API & EXPORTS GUIDE

This documentation covers all exports and API functions available for developers integrating Risk HUD V2 into their scripts.

🎯 Available Exports

1) Notify — Display Notifications

Display customizable notifications to players.

exports['risk-hudv2']:Notify(data)

Parameters:

• data (table) — Notification configuration

Data Structure:

{
    type = 'success',      -- 'success', 'error', 'info', 'warning'
    title = 'Title',       -- Notification title
    message = 'Message',   -- Notification content
    duration = 8000        -- Duration in milliseconds (default: 8000)
}

Examples:

Success notification:

exports['risk-hudv2']:Notify({
    type = 'success',
    title = 'Vehicle Parked',
    message = 'Your vehicle has been successfully stored in the garage.',
    duration = 5000
})

Error notification:

exports['risk-hudv2']:Notify({
    type = 'error',
    title = 'Insufficient Funds',
    message = 'You do not have enough money to complete this purchase.',
    duration = 6000
})

Info notification:

exports['risk-hudv2']:Notify({
    type = 'info',
    title = 'Server Restart',
    message = 'The server will restart in 10 minutes. Please save your progress.',
    duration = 10000
})

Warning notification:

exports['risk-hudv2']:Notify({
    type = 'warning',
    title = 'Low Health',
    message = 'Your health is critical. Seek medical attention immediately.',
    duration = 5000
})

Alternative: Event-based (from server):

TriggerClientEvent('risk-notify:notify', source, {
    type = 'success',
    title = 'Payment Received',
    message = 'You received $5000 from the government.',
    duration = 5000
})

Legacy format (also supported):

TriggerClientEvent('risk-notify:notify', source, 'success', 'Payment successful!', 'Bank Transfer', 5000)

---

2) HelpNotify — Display Help Prompts

Show interactive help text (e.g., "Press E to open door").

exports['risk-hudv2']:HelpNotify(key, message)

Parameters:

• key (string) — Key to display (e.g., "E", "F", "SPACE")

• message (string) — Help text to show

Auto-closes after 1 second of no calls — Perfect for loops!

Examples:

Basic door interaction:

CreateThread(function()
    while true do
        local playerCoords = GetEntityCoords(PlayerPedId())
        local distance = #(playerCoords - vector3(123.45, -678.90, 21.34))
        
        if distance < 2.0 then
            exports['risk-hudv2']:HelpNotify("E", "Open Door")
            
            if IsControlJustPressed(0, 38) then -- E key
                -- Open door logic
            end
        end
        
        Wait(0)
    end
end)

Vehicle interaction:

CreateThread(function()
    while true do
        local ped = PlayerPedId()
        local vehicle = GetVehiclePedIsIn(ped, false)
        
        if vehicle ~= 0 and GetPedInVehicleSeat(vehicle, -1) == ped then
            exports['risk-hudv2']:HelpNotify("H", "Toggle Engine")
            
            if IsControlJustPressed(0, 74) then -- H key
                -- Engine toggle logic
            end
        end
        
        Wait(0)
    end
end)

Item pickup:

CreateThread(function()
    while true do
        local playerCoords = GetEntityCoords(PlayerPedId())
        
        for k, item in pairs(itemLocations) do
            local distance = #(playerCoords - item.coords)
            
            if distance < 1.5 then
                exports['risk-hudv2']:HelpNotify("E", "Pick up " .. item.label)
                
                if IsControlJustPressed(0, 38) then
                    -- Pickup logic
                end
            end
        end
        
        Wait(0)
    end
end)

Multiple actions:

CreateThread(function()
    while true do
        local ped = PlayerPedId()
        local coords = GetEntityCoords(ped)
        local atm = GetClosestAtm(coords)
        
        if atm and #(coords - atm) < 2.0 then
            exports['risk-hudv2']:HelpNotify("E", "Access ATM")
            exports['risk-hudv2']:HelpNotify("G", "Rob ATM")
            
            if IsControlJustPressed(0, 38) then -- E
                -- Open ATM
            elseif IsControlJustPressed(0, 47) then -- G
                -- Rob ATM
            end
        end
        
        Wait(0)
    end
end)

---

3) startProgress — Progress Bar

Display an animated progress bar with optional player freeze, animation, and props.

exports['risk-hudv2']:startProgress(duration, label, options)

Parameters:

• duration (number) — Duration in milliseconds

• label (string) — Text shown on progress bar

• options (table) — Configuration options

Options Structure:

{
    freeze = false,        -- Freeze player during progress
    prop = nil,            -- Prop model to attach (optional)
    anim = {               -- Animation to play (optional)
        dict = "anim_dict",
        lib = "anim_name"
    },
    onFinish = function()  -- Called when progress completes
        -- Success logic
    end,
    onCancel = function()  -- Called when progress is cancelled
        -- Cancel logic
    end
}

Progress can be cancelled by:

• Pressing BACKSPACE (key 202)

• Pressing X (key 73)

• Calling cancelProgress() export

Examples:

Vehicle repair:

exports['risk-hudv2']:startProgress(15000, 'Repairing Vehicle...', {
    freeze = true,
    anim = {
        dict = "mini@repair",
        lib = "fixing_a_player"
    },
    onFinish = function()
        SetVehicleFixed(vehicle)
        exports['risk-hudv2']:Notify({
            type = 'success',
            title = 'Repair Complete',
            message = 'Your vehicle has been repaired.',
            duration = 5000
        })
    end,
    onCancel = function()
        exports['risk-hudv2']:Notify({
            type = 'error',
            title = 'Repair Cancelled',
            message = 'You stopped repairing the vehicle.',
            duration = 3000
        })
    end
})

Lockpicking:

exports['risk-hudv2']:startProgress(10000, 'Lockpicking...', {
    freeze = true,
    prop = "prop_tool_screwdriver",
    anim = {
        dict = "anim@amb@clubhouse@tutorial@bkr_tut_ig3@",
        lib = "machinic_loop_mechandplayer"
    },
    onFinish = function()
        SetVehicleDoorsLocked(vehicle, 1)
        exports['risk-hudv2']:Notify({
            type = 'success',
            title = 'Success',
            message = 'Vehicle unlocked!',
            duration = 3000
        })
    end,
    onCancel = function()
        TriggerServerEvent('myScript:lockpickFailed')
    end
})

Gathering resources:

exports['risk-hudv2']:startProgress(8000, 'Gathering Wood...', {
    freeze = true,
    anim = {
        dict = "melee@hatchet@streamed_core",
        lib = "plyr_rear_takedown_b"
    },
    onFinish = function()
        TriggerServerEvent('myScript:giveWood', 5)
    end,
    onCancel = function()
        -- Nothing happens on cancel
    end
})

Simple progress (no animation):

exports['risk-hudv2']:startProgress(5000, 'Processing...', {
    freeze = false,
    onFinish = function()
        print('Done!')
    end,
    onCancel = function()
        print('Cancelled')
    end
})

Crafting with prop:

exports['risk-hudv2']:startProgress(12000, 'Crafting Item...', {
    freeze = true,
    prop = "prop_cs_tablet",
    onFinish = function()
        TriggerServerEvent('crafting:complete', itemName)
    end,
    onCancel = function()
        TriggerServerEvent('crafting:refundMaterials')
    end
})

---

4) cancelProgress — Cancel Progress Bar

Manually cancel an active progress bar.

exports['risk-hudv2']:cancelProgress()

Examples:

Cancel on player damage:

exports['risk-hudv2']:startProgress(20000, 'Robbing Safe...', {
    freeze = true,
    onFinish = function()
        TriggerServerEvent('robbery:success')
    end,
    onCancel = function()
        exports['risk-hudv2']:Notify({
            type = 'error',
            title = 'Robbery Failed',
            message = 'You were interrupted!',
            duration = 3000
        })
    end
})

-- Cancel if player takes damage
CreateThread(function()
    local initialHealth = GetEntityHealth(PlayerPedId())
    while progressActive do
        Wait(100)
        local currentHealth = GetEntityHealth(PlayerPedId())
        if currentHealth < initialHealth then
            exports['risk-hudv2']:cancelProgress()
            break
        end
    end
end)

Cancel from server:

-- Server-side
TriggerClientEvent('risk-notify:cancelProgress', source)

Cancel on player movement:

local startCoords = GetEntityCoords(PlayerPedId())

exports['risk-hudv2']:startProgress(10000, 'Picking Lock...', {
    freeze = false,
    onFinish = function()
        -- Success
    end,
    onCancel = function()
        -- Cancelled
    end
})

CreateThread(function()
    while progressActive do
        Wait(500)
        local currentCoords = GetEntityCoords(PlayerPedId())
        local distance = #(startCoords - currentCoords)
        
        if distance > 2.0 then
            exports['risk-hudv2']:cancelProgress()
            exports['risk-hudv2']:Notify({
                type = 'error',
                title = 'Cancelled',
                message = 'You moved too far away!',
                duration = 3000
            })
            break
        end
    end
end)

---

📢 Announcements System

Server Export: SendAnnouncement

Send server-wide announcements to all players.

exports['risk-hudv2']:SendAnnouncement(duration, message, name, title)

Parameters:

• duration (number) — Duration in milliseconds

• message (string) — Announcement text

• name (string) — Sender name (optional, uses config default)

• title (string) — Announcement title (optional, uses config default)

Examples:

Simple announcement:

exports['risk-hudv2']:SendAnnouncement(10000, "Double XP event starts now!")

Custom sender and title:

exports['risk-hudv2']:SendAnnouncement(
    15000,
    "The bank heist is now available. Head to the city center!",
    "Event Manager",
    "New Event"
)

Restart warning:

exports['risk-hudv2']:SendAnnouncement(
    30000,
    "Server will restart in 5 minutes. Please finish your activities and store your vehicles.",
    "System",
    "Server Restart"
)

---

Client Command: /announcement

Usage:

/announcement <duration_seconds> <message>

Examples:

/announcement 10 Welcome to the server!
/announcement 30 Double rewards this weekend! Enjoy!

---

Server Event: Announcement

From client to server:

TriggerServerEvent('risk-notify:announcement', duration, message)

Example:

RegisterCommand('customannounce', function()
    TriggerServerEvent('risk-notify:announcement', 15000, "Custom announcement from script!")
end)

---

Targeted Announcement (Single Player)

Command:

/announcementto <serverId> <duration_seconds> <message>

Server Event:

TriggerServerEvent('risk-notify:announcementto', playerId, duration, message)

Example:

-- Send announcement only to player with ID 5
TriggerServerEvent('risk-notify:announcementto', 5, 10000, "You have been selected for a special event!")

---

🎨 Complete Integration Examples

Example 1: Vehicle Shop System

-- Vehicle purchase with progress and notifications
RegisterNetEvent('vehicleshop:purchase')
AddEventHandler('vehicleshop:purchase', function(vehicleData)
    exports['risk-hudv2']:Notify({
        type = 'info',
        title = 'Processing Payment',
        message = 'Please wait while we process your purchase...',
        duration = 3000
    })
    
    exports['risk-hudv2']:startProgress(5000, 'Preparing Vehicle...', {
        freeze = true,
        onFinish = function()
            TriggerServerEvent('vehicleshop:completePurchase', vehicleData)
            
            exports['risk-hudv2']:Notify({
                type = 'success',
                title = 'Purchase Complete',
                message = 'Your ' .. vehicleData.name .. ' is ready!',
                duration = 8000
            })
        end,
        onCancel = function()
            exports['risk-hudv2']:Notify({
                type = 'error',
                title = 'Purchase Cancelled',
                message = 'Vehicle purchase was cancelled.',
                duration = 5000
            })
        end
    })
end)

Example 2: Robbery System

local robbing = false

CreateThread(function()
    while true do
        local ped = PlayerPedId()
        local coords = GetEntityCoords(ped)
        local safe = GetClosestSafe(coords)
        
        if safe and #(coords - safe.coords) < 2.0 and not robbing then
            exports['risk-hudv2']:HelpNotify("E", "Rob Safe ($" .. safe.reward .. ")")
            
            if IsControlJustPressed(0, 38) then
                robbing = true
                
                exports['risk-hudv2']:startProgress(30000, 'Cracking Safe...', {
                    freeze = true,
                    prop = "prop_tool_drill",
                    anim = {
                        dict = "anim@heists@fleeca_bank@drilling",
                        lib = "drill_straight_idle"
                    },
                    onFinish = function()
                        TriggerServerEvent('robbery:success', safe.id)
                        robbing = false
                        
                        exports['risk-hudv2']:Notify({
                            type = 'success',
                            title = 'Robbery Success',
                            message = 'You stole $' .. safe.reward .. ' from the safe!',
                            duration = 8000
                        })
                    end,
                    onCancel = function()
                        TriggerServerEvent('robbery:failed', safe.id)
                        robbing = false
                        
                        exports['risk-hudv2']:Notify({
                            type = 'error',
                            title = 'Robbery Failed',
                            message = 'You failed to crack the safe!',
                            duration = 5000
                        })
                    end
                })
                
                -- Cancel if police arrive
                CreateThread(function()
                    while robbing do
                        Wait(1000)
                        local policeNearby = GetNearbyPolice()
                        if policeNearby > 0 then
                            exports['risk-hudv2']:cancelProgress()
                            exports['risk-hudv2']:Notify({
                                type = 'warning',
                                title = 'Police Nearby',
                                message = 'The police interrupted your robbery!',
                                duration = 5000
                            })
                            break
                        end
                    end
                end)
            end
        end
        
        Wait(0)
    end
end)

Example 3: Crafting System

RegisterNetEvent('crafting:start')
AddEventHandler('crafting:start', function(recipe)
    exports['risk-hudv2']:startProgress(recipe.time, 'Crafting ' .. recipe.label .. '...', {
        freeze = true,
        prop = "prop_cs_tablet",
        anim = {
            dict = "amb@world_human_clipboard@male@idle_a",
            lib = "idle_c"
        },
        onFinish = function()
            TriggerServerEvent('crafting:complete', recipe.id)
        end,
        onCancel = function()
            exports['risk-hudv2']:Notify({
                type = 'error',
                title = 'Crafting Cancelled',
                message = 'Materials have been returned.',
                duration = 3000
            })
            TriggerServerEvent('crafting:refund', recipe.id)
        end
    })
end)

RegisterNetEvent('crafting:success')
AddEventHandler('crafting:success', function(itemName, amount)
    exports['risk-hudv2']:Notify({
        type = 'success',
        title = 'Crafting Complete',
        message = 'You crafted ' .. amount .. 'x ' .. itemName,
        duration = 5000
    })
end)

Example 4: Drug Processing

local processing = false

CreateThread(function()
    while true do
        local ped = PlayerPedId()
        local coords = GetEntityCoords(ped)
        
        for k, processor in pairs(Config.Processors) do
            local distance = #(coords - processor.coords)
            
            if distance < 2.0 and not processing then
                exports['risk-hudv2']:HelpNotify("E", "Process " .. processor.input.label)
                
                if IsControlJustPressed(0, 38) then
                    TriggerServerEvent('drugs:checkIngredients', processor.id)
                end
            end
        end
        
        Wait(0)
    end
end)

RegisterNetEvent('drugs:startProcessing')
AddEventHandler('drugs:startProcessing', function(data)
    processing = true
    
    exports['risk-hudv2']:startProgress(data.time, 'Processing ' .. data.output.label .. '...', {
        freeze = true,
        anim = {
            dict = "mini@repair",
            lib = "fixing_a_player"
        },
        onFinish = function()
            processing = false
            TriggerServerEvent('drugs:finishProcessing', data.id)
            
            exports['risk-hudv2']:Notify({
                type = 'success',
                title = 'Processing Complete',
                message = 'You received ' .. data.output.amount .. 'x ' .. data.output.label,
                duration = 6000
            })
        end,
        onCancel = function()
            processing = false
            
            exports['risk-hudv2']:Notify({
                type = 'error',
                title = 'Processing Cancelled',
                message = 'Ingredients lost!',
                duration = 4000
            })
        end
    })
end)