Client

Progress bar (client). Client-only progress bars. No server implementation.

Progress bar (client)

Client-only progress bars. No server implementation.

openprogressbar(data)

openProgressBar is the same function (alias on every provider).

openprogressbar(data)
ParamType
dataOxProgressBar

| Returns | boolean? — true completed, false cancelled |

Usage Example

local finished = bridge.progressbar.openprogressbar({
    duration = 5000,
    label = 'Harvesting honey...',
    canCancel = true,
    disable = { move = true, combat = true },
    anim = {
        dict = 'amb@world_human_gardener_plant@male@base',
        clip = 'base',
    },
})

if finished then
    TriggerServerEvent('myresource:finishHarvest')
end

progressActive() (optional)

if bridge.progressbar.progressActive() then return end

| Providers | Real on ox_lib and lation_ui. zsx_uiv2 tracks its own callback. wasabi_uikit / progressbar always return false. | | Returns | boolean |

cancelProgress() (optional)

bridge.progressbar.cancelProgress()

| Providers | Real on ox_lib and lation_ui. Other adapters are no-ops (zsx_uiv2 has no cancel export). | | Description | Cancels the active progress bar |

Types

OxProgressBar

FieldType
durationnumber ms
labelstring
canCancelboolean?
useWhileDeadboolean?
allowRagdollboolean?
allowSwimmingboolean?
allowCuffedboolean?
allowFallingboolean?
animOxProgressAnim?
disableOxProgressDisable?
propOxProgressProp | OxProgressProp[]?
position'middle' | 'bottom' ox_lib

OxProgressAnim

FieldType
dictstring?
clipstring?
flagnumber?
scenariostring?

OxProgressDisable

FieldType
moveboolean?
sprintboolean?
carboolean?
combatboolean?
mouseboolean?

On this page