Learn / Documentation / Progressor
Scripting

Description

The Progressor animates a value between a minimum and a maximum interval. It also calculates the progress value (from 0 to 1) and the inverse progress (from 1 to 0).

This component is meant to help visualize a progression of an operation (e.g. a scene load progress).

It can be used to update visual elements of an energy bar, a health bar or any type of progress indicator.

It can be linked to anything that takes a value (from min to max) or a progress value (from 0 to 1 or from 0% to 100%).

Component Details

Gesture Listener
Gesture Listener
Gesture Listener
  • Manual – Link to the manual page for this component

  • YouTube – Link to the quick video tutorial for this component

  • DebugMode – Enables relevant debug messages to be printed to the console

  • Progress Targets – Progress targets that will get updated every time the current Value or Progress value change

  • Min Value – The minimum value that the current Value can have

  • Max Value – The maximum value that the current Value can have

  • Simulate – Simulates a progress with the set Duration and Ease (values used for simulation purposes only)

  • Simulate Duration – Simulation duration (value used for simulation purposes only)

  • Simulate Ease – Simulation ease (value used for simulation purposes only)

  • Set Value – Updates the current Value to the set value

  • Animate Value – If TRUE, when the current Value or Progress value get updated, the change will be animated

  • Duration – Duration for the current Value to reach the target value when Animate Value is enabled (used at runtime)

  • Ease – The ease used by the value animator when Animate Value is enabled (used at runtime)

  • Ignore Timescale – Determines if the value animator should respect Unity’s Timescale, when Animate Value is enabled (used at runtime)

  • Whole Numbers – Should the current Value get rounded to the nearest integer?

  • Reset Value OnEnable – Reset behavior for the current Value that happens OnEnable (Disabled / ToMinValue / ToMaxValue / ToCustomValue)

  • Reset Value OnDisable – Reset behavior for the current Value that happens OnDisable (Disabled / ToMinValue / ToMaxValue / ToCustomValue)

  • Custom Reset Value – Custom reset value for the current Value, if either Reset Value OnEnable or Reset Value OnDisable are set to ToCustomValue

  • OnValueChanged – Callback executed when the current Value has changed. Passes the current Value (float between Min Value and Max Value).

  • OnProgressChanged – Callback executed when the current Value has changed and the Progress has been updated. Passes the Progress value (float between 0 and 1).

  • OnInverseProgressChanged – Callback executed when the current Value has changed and the Progress has been updated. Passes the InverseProgress value (float between 1 and 0). InverseProgress = 1 – Progress