Skip to content

Progress Module โ€‹

A simple progress bar system for RedM that displays a visual progress indicator with text.

Usage โ€‹

lua
exports.bln_lib:progress(time, description, callback)

Parameters

  • time (number): Duration in milliseconds
  • description (string): Text to display below the progress bar
  • callback (function, optional): Function to run while progress bar is active

Examples โ€‹

Basic Usage โ€‹

lua
-- Show a 5 second progress bar
exports.bln_lib:progress(5000, "Searching...")

With Callback โ€‹

lua
exports.bln_lib:progress(
    3000,                -- 3 seconds
    "Crafting Item...",  -- Description
    function()           -- Callback
        -- Do something while progress bar is running
        -- Like playing an animation
        PlayAnimation('crafting')
    end
)

Common Use Cases โ€‹

lua
-- Searching container
exports.bln_lib:progress(2000, "Searching Box...")

-- Crafting item
exports.bln_lib:progress(5000, "Crafting Bandage...")

-- Loading area
exports.bln_lib:progress(3000, "Opening Door...")

Visual Elements โ€‹

The progress bar appears at the bottom of the screen and includes:

  • Progress bar with percentage
  • Description text below
  • Background frame

Required textures are loaded automatically:

  • rpg_meter
  • rpg_meter_track
  • generic_textures