Progress bar

The progress bar shows a timed action at the bottom center of the screen. It can play an animation or scenario, attach props that other players see, block controls, and split the bar into steps. The call waits until the bar ends and tells you whether it completed.

progressBarCopy Anchor Link

local completed = exports.lation_ui:progressBar(data)

The call waits for the bar, so run it from a thread, command or event handler. If another bar is already running, it waits for that one to end before it starts.

The bar is interrupted, and returns false, as soon as the player is dead, ragdolled, cuffed, falling or swimming, unless the matching option above allows it. If one of those is already true when you call it, it returns false without showing the bar.

While a bar runs, lation ui sets LocalPlayer.state.invBusy and LocalPlayer.state.inv_busy to true, and back to false when it ends, so inventories that read them stay closed during the action.

local done = exports.lation_ui:progressBar({
    label = 'Repairing engine',
    description = 'Hold still',
    duration = 8000,
    icon = 'fas fa-wrench',
    canCancel = true,
    disable = { move = true, car = true, combat = true },
    anim = { dict = 'mini@repair', clip = 'fixing_a_ped' }
})

if done then
    -- give the reward
else
    -- the player cancelled or was interrupted
end

With steps:

if exports.lation_ui:progressBar({
    label = 'Initializing hack',
    duration = 10000,
    icon = 'fas fa-crosshairs',
    iconColor = '#EF4444',
    color = '#EF4444',
    steps = {
        { description = 'Connecting to server...' },
        { description = 'Bypassing security protocols...' },
        { description = 'Establishing secure connection...' },
        { description = 'Hack in progress...' }
    }
}) then
    print('Success')
end

With a prop:

exports.lation_ui:progressBar({
    label = 'Drinking coffee',
    duration = 5000,
    anim = { dict = 'mp_player_intdrink', clip = 'loop_bottle' },
    prop = {
        model = 'p_amb_coffeecup_01',
        bone = 28422,
        pos = { x = 0.0, y = 0.0, z = 0.0 },
        rot = { x = 0.0, y = 0.0, z = 0.0 }
    }
})

animCopy Anchor Link

When the bar ends, an animation from dict is stopped; for a scenario, the ped's tasks are cleared.

propCopy Anchor Link

Pass a list of these tables to attach more than one; the lation_ui:progressPropLimit convar (default 2) caps how many. Props are removed when the bar ends.

Other players see the props too. The server checks each one before sharing it: model must be a string or number, and pos and rot plain tables with numeric x, y and z (not vector3). A prop that fails the check shows only for the player running the bar. Each new bar's props replace the last ones for everyone, and they go the moment the bar ends, even one cancelled as it starts. The server shares one set of props per player every 100 ms; a bar that starts sooner gets its props a moment later, so back-to-back bars both show theirs.

disableCopy Anchor Link

Set any of these to true to block it:

cancelProgressCopy Anchor Link

local cancelled = exports.lation_ui:cancelProgress()

Cancels the running bar from your script, even when its canCancel is false. Its progressBar call returns false.

-- Stop the repair if the vehicle explodes
if IsEntityDead(vehicle) then exports.lation_ui:cancelProgress() end

progressActiveCopy Anchor Link

local active = exports.lation_ui:progressActive()

if exports.lation_ui:progressActive() then return end -- busy, try again later