Progress Bars guide

The progress bars package contains a simple UI progress bar that can be updated via lua. This can either be used in world or on screen.

How to use - in world

  1. Download the Progress Bars package
  2. Add a locator in world
  3. Add the progressBarUI widget and the progressBarUIScript to the locator
  4. Switch the widget type to world (Note you may need to rotate the locator in order to see the widget)
  5. Tick the property on the script isInWorld (This tells the script to update the progress bar for every client)
  6. Now to use the progress bar you can get the locator entity and call SendToScripts(“UpdateProgress”, progress) where progress is a number between 0-100

How to use - on screen

  1. Download the Progress Bars package
  2. Add the progressBarUI widget and the progressBarUIScript to the player/user template
  3. Switch the widget type to screen
  4. Now to use the progress bar you can get the player/user entity and call SendToScripts(“UpdateProgress”, progress) where progress is a number between 0-100

Threshold
The progress bar script comes with a threshold property which will determine at which % the bar changes from red to green. These colours can be customised in the widget.

Debug script
The package also comes with a progressBarChanger which can be used to test the progress bar and show you how it is updated. The example comes with a property for the time it takes for the bar to increase and then decrease in a loop. To use just place the script in game somewhere and assign your progress bar entity to the property on the script. Then, on previewing, you will see the progress bar move up and down.