Client

progressBar

fjsf.progressBar(data)

Displays a blocking progress bar on the screen and waits until it finishes or is canceled.

The function is promise-based and pauses execution until the progress completes or is interrupted.

---

Parameters

• data table Progress bar configuration object.

  Supported fields:

  • duration number Duration of the progress in milliseconds.

  • text string Main text displayed on the progress bar.

  • description string | nil Optional description text displayed below the main text.

  • canCancel boolean | nil Whether the progress can be canceled by the player. Defaults to true.

---

Player state conditions

• useWhileDead boolean | nil Allow progress while the player is dead.

• allowRagdoll boolean | nil Allow progress while ragdolled.

• allowSwimming boolean | nil Allow progress while swimming.

• allowCuffed boolean | nil Allow progress while cuffed.

• allowFalling boolean | nil Allow progress while falling.

Runtime state conditions

• disableMove boolean | nil Cancel progress if the player moves or walks.

• disableCarMovement boolean | nil Cancel progress if the vehicle starts moving.

• checkFalling boolean | nil Cancel progress if the player begins falling.

• disableWeapons boolean | nil Cancel progress if the player equips a weapon.

• disableMouse boolean | nil Cancel progress if the player moves the camera.

• checkAlive boolean | nil Cancel progress if the player dies.

• checkRagdoll boolean | nil Cancel progress if the player becomes ragdolled.

• checkSwimming boolean | nil Cancel progress if the player starts swimming.

• checkCuffed boolean | nil Cancel progress if the player gets cuffed.

• checkVehicle boolean | nil Cancel progress if the player enters or exits a vehicle.

---

Visual configuration

• icon string | nil FontAwesome icon class.

• iconAnim string | nil Icon animation class (default: spin).

• color string | nil Progress accent color (CSS value).

• background string | nil Background color (CSS value).

• size string | nil Progress bar size.

  Allowed values:

  • small

  • medium

  • large

• position string | nil Screen position.

  Supported values:

  • right-up

  • right-middle

  • right-down

  • center-up

  • center-middle

  • center-down

  • left-up

  • left-middle

  • left-down

• sounds boolean | nil Enables sound effect when the progress starts.

---

Animation

• anim table | nil Animation configuration.

  • dict string Animation dictionary.

  • clip string Animation clip name.

  • blendIn number | nil Blend-in speed.

  • blendOut number | nil Blend-out speed.

  • duration number | nil Animation duration.

  • flag number | nil Animation flags.

  • playbackRate number | nil Animation playback rate.

---

Scenario

• scenario string | nil GTA scenario name. Used only if anim is not provided.

---

Prop

• prop table | nil Prop configuration.

  • model number Model hash of the prop.

  • bone number | nil Ped bone index (default: 60309).

  • pos vector3 | nil Position offset.

  • rot vector3 | nil Rotation offset.

  • rotOrder number | nil Rotation order.

---

Returns

• boolean

  • true – Progress finished successfully

  • false – Progress was canceled or could not be started

---

Example

local success = fjsf.progressBar({
    duration = 5000,
    text = 'Lockpicking',
    description = 'Do not move',
    canCancel = true,
    position = 'center-down',
    icon = 'fa-solid fa-lock',
    anim = {
        dict = 'missheistfbisetup1',
        clip = 'unlock_loop'
    }
})

if success then
    print('Progress finished')
else
    print('Progress canceled')
end

---

cancelProgressBar

fjsf.cancelProgressBar()

Cancels the currently active progress bar.

This immediately stops the progress, clears animations and props, and resolves the progress as canceled.

---

Returns

This function does not return anything.

---

Example

fjsf.cancelProgressBar()