QBCore Frameworkqbcore.netCommunity docs
On this page

Updated 2026-10-11 · 2 min read

QBCore progressbar: client API and cancellation

The official progressbar resource provides a client-side timed UI, optional animation/props and cancel/finish handlers. This guide is pinned to commit 6e9381d.

Installation

Start progressbar before resources that call its exports. In QBCore scripts, prefer the wrapper QBCore.Functions.Progressbar. The client resource sets LocalPlayer.state.inv_busy while a progress action is running. Do not rely on an animation finishing as proof of a legitimate server-side action.

local QBCore = exports['qb-core']:GetCoreObject({ 'Functions' })

QBCore.Functions.Progressbar(
    'repair_vehicle',
    'Repairing vehicle',
    5000,
    false,
    true,
    {
        disableMovement = true,
        disableCarMovement = true,
        disableMouse = false,
        disableCombat = true,
    },
    { animDict = 'mini@repair', anim = 'fixing_a_player', flags = 16 },
    {}, {},
    function()
        print('Progress completed')
        -- Request a SERVER-VALIDATED action; do not award items on the client.
    end,
    function()
        print('Progress cancelled')
    end
)

Duration is in milliseconds. onFinish is not a server-side authorization decision.

Direct client exports

client.lua exports:

ExportPurpose
Progress(data, handler)Starts progress with a completion callback receiving cancellation state
ProgressWithStartEvent(data, onStart, onFinish)Adds a start callback
ProgressWithTickEvent(data, onTick, onFinish)Adds a per-tick callback
ProgressWithStartAndTick(data, onStart, onTick, onFinish)Combines both
isDoingSomething()Returns whether a progress action is active

The source also registers client events such as progressbar:client:cancel and progressbar:client:progress; prefer the wrapper or exports over inventing a server-side progress API.

Troubleshooting

SymptomCheck
No such export ProgressCaller executes on client, resource starts first
Progress fails while another is activeisDoingSomething() and overlapping UI actions
Animation not playinganimDict/anim and ped state
Action succeeds even after cancellationEnsure the server does not trust a client completion event
Inventory stays busyState cleanup after cancellation and interfering resources

Update checklist

  1. Compare qb-core wrapper signature and progressbar client export on the deployed versions.
  2. Test finish, cancel, death, reconnect and simultaneous requests.
  3. Verify rewards and purchases are validated server-side, independent of the UI.

Sources

Repository · Client implementation · Upstream usage

Found an issue in this guide?

Send the page URL, the affected example, and a source or reproduction to the site maintainer. For a server or resource problem, use the support guide.

On this page

Leonida RP server website built with RPWebsite
RPWebsite

Advertisement · RPWebsite

Want a website for your server?

Launch a site with live player status, rules, and a join button in minutes.

Build your website