esx_progressbar

esx_progressbar shows a timed progress bar at the bottom of the screen, with an optional animation or scenario and an optional player freeze. Use it for actions that take time, such as lockpicking, crafting or searching a trash bin. Call it from client code with ESX.Progressbar.

OverviewCopy Anchor Link

FunctionsCopy Anchor Link

ESX.ProgressbarCopy Anchor Link

local started = ESX.Progressbar(message, length, options)

Returns boolean: true when the bar started, false when another bar is already running.

OptionsCopy Anchor Link

animation has two forms:

local function searchTrash()
    local started = ESX.Progressbar("Searching the trash...", 5000, {
        FreezePlayer = true,
        animation = {
            type = "Scenario",
            Scenario = "PROP_HUMAN_BUM_BIN",
        },
        onFinish = function()
            TriggerServerEvent("my_trash:searched")
        end,
        onCancel = function()
            ESX.ShowNotification("You stopped searching.", "info")
        end,
    })

    if not started then
        ESX.ShowNotification("You are already busy.", "error")
    end
end

Animation example:

ESX.Progressbar("Unlocking storage", 3000, {
    FreezePlayer = true,
    animation = {
        type = "anim",
        dict = "anim@mp_player_intmenu@key_fob@",
        lib = "fob_click",
    },
    onFinish = function()
        TriggerServerEvent("my_storage:open")
    end,
})

ESX.CancelProgressbarCopy Anchor Link

Cancels the active bar: closes the UI, clears the ped tasks, unfreezes the player and calls onCancel. Does nothing when no bar is active.

ESX.CancelProgressbar()

Use it when the player dies, gets into a vehicle or leaves the area:

AddEventHandler("esx:onPlayerDeath", function()
    ESX.CancelProgressbar()
end)

ExportsCopy Anchor Link

The ESX functions are thin wrappers around these exports.

ControlsCopy Anchor Link

Players can rebind it in Settings → Key Bindings → FiveM. The key is registered with xLib.addKeybind.

Common issuesCopy Anchor Link

• Animation stops before the bar ends. The animation plays with the bar length as its duration and flag 1 (loop). If your animation still stops, another script is clearing the ped tasks.
• Players skip timed actions. Every bar can be canceled with Backspace, and a modified client can call onFinish early. Never rely on the bar for timing on the server; check elapsed time server-side.
• Scenario does not play. Use type = "Scenario" and the key Scenario with a capital S. "scenario" in lowercase is ignored.
• ESX.Progressbar returns false. A bar is still running. Check the return value and tell the player they are busy, or cancel the old bar first.

RelatedCopy Anchor Link

• Core resources overview
• Client functions
• esx_notify
• esx_lib

Frequently asked questions