Skip to main content

Quick Start

Functions

Show a progress bar to the player.
Parameters:
  • data (table) - Progress bar configuration object (see Options)
Returns:
  • success (boolean) - true if completed, false if cancelled/failed
Check if a progress bar is currently active.
Returns:
  • isActive (boolean) - true if progress is active, false otherwise
Cancel the currently active progress bar.

Configuration

Options

string
required
Progress bar label text
string
Progress description text
Overridden by steps if multi-step feature is used
number
required
Duration in milliseconds
string
FontAwesome icon class
string
default:"#71717A"
Icon color (hex or CSS color name)
string
Icon animation typeAvailable options: 'spin', 'spinPulse', 'spinReverse', 'pulse', 'beat', 'fade', 'beatFade', 'bounce', 'shake'
string
default:"#3B82F6"
Progress bar color (hex or CSS color name)
table
Array of step objects with descriptions for multi-step progress (see Steps)
boolean
default:"true"
Whether progress can be cancelled with X key
boolean
default:"false"
Allow progress while player is dead
boolean
default:"false"
Allow progress while player is ragdolled
boolean
default:"false"
Allow progress while player is cuffed
boolean
default:"false"
Allow progress while player is falling
boolean
default:"false"
Allow progress while player is swimming
table
Animation configuration (see Animations)
table
Prop configuration (see Props)
table
Controls to disable during progress (see Disable)

Steps

Each step object in the steps array supports:
string
required
Description text for this step
Example:

Animations

string
Animation dictionary
Either dict or scenario is required if using animations
string
required
Animation clip name
number
default:"49"
Animation flags
number
default:"3.0"
Blend in speed
number
default:"1.0"
Blend out speed
number
default:"-1"
Animation duration (-1 for loop)
number
default:"0"
Playback rate
boolean
default:"false"
Lock X axis
boolean
default:"false"
Lock Y axis
boolean
default:"false"
Lock Z axis
string
Scenario name (alternative to dict/clip)
Either dict or scenario is required if using animations
boolean
default:"true"
Play enter animation for scenarios

Props

string
required
Prop model hash
number
default:"60309"
Bone index to attach prop to
table
required
Position offset as table: {x, y, z}
table
required
Rotation offset as table: {x, y, z}
number
default:"0"
Rotation order

Disable

boolean
default:"false"
Disable player movement
boolean
default:"false"
Disable sprinting only
boolean
default:"false"
Disable vehicle controls
boolean
default:"false"
Disable combat actions
boolean
default:"false"
Disable mouse look

Preview

Progress Bar Preview