Skip to main content

​
Quick Start

local success = exports.lation_ui:progressBar({
    label = 'Processing',
    description = 'Please wait...',
    duration = 5000,
    icon = 'fas fa-spinner'
})

if success then
    print('Progress completed')
else
    print('Progress cancelled')
end

​
Functions

Show a progress bar to the player.
local success = exports.lation_ui:progressBar(data)
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.
local isActive = exports.lation_ui:progressActive()
Returns:
  • isActive (boolean) - true if progress is active, false otherwise
Cancel the currently active progress bar.
exports.lation_ui:cancelProgress()

​
Configuration

​
Options

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

​
Steps

Each step object in the steps array supports:
​
description
string
required
Description text for this step
Example: 
steps = {
    { description = 'Connecting to server...' },
    { description = 'Bypassing security protocols...' },
    { description = 'Establishing secure connection...' },
    { description = 'Hack in progress...' }
}

​
Animations

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

​
Props

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

​
Disable

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

​
Preview

Progress Bar Preview