🗝️ Exports

🚀 Export Functions

1. Start a Progress Bar

exports['ks-progressbar']:start{
    name = "repair_vehicle",
    duration = 8000, -- time in ms (8 seconds)
    label = "Repairing Vehicle...",
    sublabel = "Please wait while the repairs are completed.",
    canCancel = true, -- allow player to cancel with ESC
    controlDisables = {
        disableMovement = true
    },
    animation = {
        animDict = "mini@repair",
        anim = "fixing_a_ped",
        flags = 49
    },
    icon = "fas fa-wrench" -- FontAwesome icon class
}

Parameters:

Field	Type	Description
`name`	string	Unique identifier for this progress bar.
`duration`	number	Duration in milliseconds. Example: `8000` = 8 seconds.
`label`	string	Main text displayed on the progress bar.
`sublabel`	string	Secondary text displayed below the main label.
`canCancel`	boolean	Allows the player to cancel with ESC if true.
`controlDisables`	table	Disable player controls while progress bar is active.
`animation`	table	Optional animation to play during progress.
`icon`	string	FontAwesome icon class displayed on the progress bar.

Animation Table:

Field	Type	Description
`animDict`	string	The animation dictionary.
`anim`	string	The animation name within the dictionary.
`flags`	number	Animation flags.

2. Cancel a Progress Bar

exports['ks-progressbar']:cancelprogress()

Cancels the currently running progress bar immediately.

🖱️ How to Move the Progress Bar

Open the Settings Menu with the command:

/progresssettings

Move the progress bar using the mouse.
Adjust the 3D angle by holding SHIFT while moving the mouse.

🚀 Export Functions

1. Start a Progress Bar

exports['ks-progressbar']:start{ name = "repair_vehicle", duration = 8000, -- time in ms (8 seconds) label = "Repairing Vehicle...", sublabel = "Please wait while the repairs are completed.", canCancel = true, -- allow player to cancel with ESC controlDisables = { disableMovement = true }, animation = { animDict = "mini@repair", anim = "fixing_a_ped", flags = 49 }, icon = "fas fa-wrench" -- FontAwesome icon class }

Parameters:

Field

Type

Description

name

string

Unique identifier for this progress bar.

duration

number

Duration in milliseconds. Example: 8000 = 8 seconds.

label

string

Main text displayed on the progress bar.

sublabel

string

Secondary text displayed below the main label.

canCancel

boolean

Allows the player to cancel with ESC if true.

controlDisables

table

Disable player controls while progress bar is active.

animation

table

Optional animation to play during progress.

icon

string

FontAwesome icon class displayed on the progress bar.

Animation Table:

Field

Type

Description

animDict

string

The animation dictionary.

anim

string

The animation name within the dictionary.

flags

number

Animation flags.

2. Cancel a Progress Bar

exports['ks-progressbar']:cancelprogress()

Cancels the currently running progress bar immediately.