Progress - Atlas Scripts

Bridge.Progress shows a timed progress bar and blocks until it fills or is cancelled. Use it for any timed action — reeling in a fish, picking a lock, washing a car. It can attach a prop, play an animation or scenario, and lock movement for the duration, then tear all of that down for you when the bar ends.

Availability

Client only. Call it inside a thread, command, or event callback — it yields.

local completed = Bridge.Progress(opts)   -- boolean
Bridge.Progress.Cancel()                   -- force-cancel from elsewhere
Bridge.Progress.IsActive()                 -- boolean (always false on the own renderer)

Signature

Bridge.Progress(opts) — the call blocks and returns whether the bar completed.

number

required

How long the bar takes to fill, in milliseconds.

string

The text shown beside the bar.

string

An optional leading icon.

boolean

default:"false"

When true, the player can cancel (a close button appears); the call then returns false.

boolean

default:"false"

Locks movement, sprint, jump, and attack for the duration.

table

A single prop to attach for the duration: { model, bone?, pos?, rot? }. bone defaults to 60309 (right hand); pos/rot are { x, y, z } offsets.

table[]

Multiple props, each shaped like prop above. Use instead of prop when you need more than one.

table

An animation to play: { dict, clip, flag?, blendIn?, blendOut?, duration? }. flag defaults to 49.

string

A scenario to play instead of anim, e.g. 'WORLD_HUMAN_STAND_FISHING'.

Returns

boolean

true if the bar filled to 100%, false if the player (or a Bridge.Progress.Cancel() call) cancelled it.

The props, animation/scenario, and control lock are cleaned up automatically whether the bar completes or cancels.

Examples

CreateThread(function()
    local ok = Bridge.Progress({ label = 'Searching…', duration = 3000, canCancel = true })
    if ok then findLoot() end
end)

local ok = Bridge.Progress({
    label           = 'Reeling in…',
    duration        = 4000,
    canCancel       = true,
    disableControls = true,
    prop = {
        model = 'prop_fishing_rod_01',
        bone  = 18905,
        pos   = { x = 0.1, y = 0.0, z = 0.0 },
        rot   = { x = 80.0, y = 0.0, z = 0.0 },
    },
    anim = { dict = 'amb@world_human_stand_fishing@idle_a', clip = 'idle_c', flag = 49 },
})
if ok then catchFish() end

Bridge.Progress({
    label    = 'Fixing the engine…',
    duration = 6000,
    scenario = 'WORLD_HUMAN_VEHICLE_MECHANIC',
})

Bridge.Progress yields. Always call it inside a CreateThread, command, or event callback — never at file top level.

The bar fill uses the player’s theme accent automatically. Set atlas:ui "ox" (or atlas:ui:progress "ox") to render the same call through ox_lib’s progress bar instead.

​Availability

​Signature

​Returns

​Examples

Availability

Signature

Returns

Examples