Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:49:34Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=StatusBar}}
Sets the current value of a StatusBar.

<pre>
StatusBarSetCurrentValue(barName, value)
</pre>

== Arguments ==
;barName : <code>string</code> – Name of a StatusBar window.
;value : <code>number</code> – The new value.

== Returns ==
Nothing.

== Details ==
* The bar's fill is <code>value / maximum</code> of its width (see [[API:StatusBarSetMaximumValue|StatusBarSetMaximumValue]]). For drawing, the value is limited to the range 0 to maximum; the stored value is not changed.
* If the bar has <code>interpolate="true"</code> in XML, the fill moves towards the new value over the following frames instead of jumping. [[API:StatusBarStopInterpolating|StatusBarStopInterpolating]] makes it jump at once.
* With a maximum of 0 the fill is empty.
* The function needs at least two arguments and only reads the last two.
* The error is the same when the window does not exist and when it is not a StatusBar.

== Errors ==
* <code>Error in function call 'StatusBarSetCurrentValue': StatusBar %s does not exist.</code>

== Example ==
Using a 0–1 bar, from <code>easystem_utils/source/datautils.lua</code>:
<pre>
StatusBarSetMaximumValue( barName, 1.0 )
StatusBarSetCurrentValue( barName, statusBarPercent )
</pre>

== See also ==
* [[API:StatusBarGetCurrentValue|StatusBarGetCurrentValue]]
* [[API:StatusBarSetMaximumValue|StatusBarSetMaximumValue]]
* [[API:StatusBarStopInterpolating|StatusBarStopInterpolating]]

API:StatusBarSetCurrentValue - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)