======Progress Bar======
----

A **progress bar** is a [[widget]] element for visualizing the progression of a value relative to a maximum value (for example, a traditional HP bar to show the player's current health compared to their maximum health). The tracked value and its maximum value are currently set using [[variable_expression_builder|variable expressions]].

=====Element Properties=====
^Icon^Property^Description^
|{{:wiki:tag_id.png?nolink|}}|Element ID|ID for the progress bar. This ID must be unique amongst other elements within the same [[widget]]. It is currently auto-generated but will be editable in a future update.|
|{{:wiki:progress_bar.png?nolink|}}|Fill Mode|Determines the direction in which the progress bar will be filled as the current value increases towards the maximum value.|
|{{:wiki:variable.png?nolink|}}|Current Value|Expression that will be used in determining the current amount of progress (i.e. how much of the progress bar is filled). See [[Variable Expression Builder]].|
|{{:wiki:variable.png?nolink|}}|Maximum Value|Expression that will determine the progress bar's maximum value. When the current value is equal to the maximum value, the progress bar will be completely filled. See [[Variable Expression Builder]].|

=====Scripting=====
You can access and change certain properties of a progress bar from within a [[script]] by simply referencing the parent [[widget]] and the element by their unique IDs. See below for examples of changing the current value and maximum value. In this case, the [[widget]] has an ID of "test" and the progress bar has an ID of "0001".

**Changing a progress bar's current value:**
<code bauxite>
widget["test"].element["0001"].value = 10;
</code>

**Changing a progress bar's maximum value:**
<code bauxite>
widget["test"].element["0001"].max_value = 100;
</code>

~~NOTOC~~