Skip to content

README.md

Latest commit

 

History

History
65 lines (53 loc) · 2.01 KB

README.md

File metadata and controls

65 lines (53 loc) · 2.01 KB
Raw

VORP ProgressBar

A Client side UI progressbar for VORP Resources

How to install

  • Download this repo
  • Copy and paste vorp_progressbar folder to resources/vorp_progressbar
  • Add ensure vorp_progressbar to your server.cfg file
  • Now you are ready to get coding!

How can I use this within my script?

Initiate the progress bar globally (Client side)

   progressbar = exports.vorp_progressbar:initiate()

Start your progress UI

Start Inputs

Input Info
message What you want the progress to display
time how long the progress should display (in milliseconds)
callback function that will get called when the progress is done
theme What you want the progress bar/circle to look like
color What color (hex or rgb) do you want the progress loader to be. Defaults to a dark red.
width What width you want the linear progressbar to be. Default: 20vw
Theme Options
Option Info
linear Shows a linear progress flat bar
circle Shows a circle progress bar
innercircle Shows a circle progress bar with a seconds countdown in the middle

Examples:

       progressbar.start('Loading...', 20000, function ()
           print('DONE!!!!')
       end, 'linear', '#ff0000', '20vw')
       progressbar.start('Loading...', 20000, function ()
           print('DONE!!!!')
       end)

Screenshots

image image

Exports to cancel progress bars (Client side)

   result = exports.vorp_progressbar:CancelNext()
   result = exports.vorp_progressbar:CancelAll()

Need More Support?

Requirements