Progress Bar

A progress bar with optional animation and input blocking.

---

startProgressbar

startProgressbar(data, callback)

Also available as an export:

exports['koja-lib']:startProgressbar(data, callback)

Parameters

Field	Type	Default	Description
label	string	"Loading..."	Title text (alias: title)
description	string	"Please wait..."	Body text (alias: text)
duration	number	5000	Duration in milliseconds (alias: time)
cancelable	boolean	false	Player can press X to cancel
animation	table?	—	Ped animation to play
animation.dict	string	—	Animation dictionary
animation.name	string	—	Animation name
animation.flag	number	1	Animation flag
inputBlock	table?	—	Keys to block during the progress bar
inputBlock.keys	string[]	—	Key names to disable (e.g. {"E", "SPACE"})

Callback

callback(success: boolean) — called when the bar finishes (true) or is cancelled (false).

---

cancelProgressbar

Cancel and hide the active progress bar immediately.

cancelProgressbar()

-- or via export:
exports['koja-lib']:cancelProgressbar()

---

Theme

Appearance is controlled by Config.UI.ProgressBar in the config file:

Config.UI.ProgressBar = {
    theme        = "darkBlack",  -- orange | darkGray | darkBlack | navy | green | purple | red
    bottomOffset = 1,
}

---

Examples

Basic progress bar

startProgressbar({
    label    = 'Searching...',
    duration = 5000,
}, function(success)
    if not success then return end
    -- action after completion
    print('Done')
end)

With animation and cancelable

startProgressbar({
    label       = 'Hotwiring',
    description = 'Hold still...',
    duration    = 8000,
    cancelable  = true,
    animation   = {
        dict = 'anim@amb@clubhouse@tutorial@bkr_tut_ig3@',
        name = 'machinic_loop_mechandplayer',
        flag = 1,
    },
    inputBlock = {
        keys = { 'SPACE', 'W', 'A', 'S', 'D' },
    },
}, function(success)
    if success then
        TriggerServerEvent('myScript:hotwireComplete')
    end
end)

---

Key Names Reference

Common keys you can use in inputBlock.keys:

ESC, F1–F10, TAB, ENTER, SPACE, BACKSPACE A–Z, 0–9 LEFT, RIGHT, TOP, DOWN LEFTSHIFT, LEFTCTRL, LEFTALT HOME, PAGEUP, PAGEDOWN, DELETE