Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:49:29Z

UI Lua API import (WAR 1.4.8)

New page

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

<pre>
value = StatusBarGetCurrentValue(barName)
</pre>

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

== Returns ==
;value : <code>number</code> – The value last set with [[API:StatusBarSetCurrentValue|StatusBarSetCurrentValue]].

== Details ==
* This is the stored value. While an interpolating bar is still moving towards it, the fill on screen shows a different value.
* The value is returned as stored, without limiting it to the range 0 to maximum.
* The error is the same when the window does not exist and when it is not a StatusBar.

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

== Example ==
From <code>ea_battlegrouphud/source/battlegrouphud.lua</code>:
<pre>
elseif( StatusBarGetCurrentValue(memberWindow.."HPBar") == 0 )
</pre>

== See also ==
* [[API:StatusBarSetCurrentValue|StatusBarSetCurrentValue]]
* [[API:StatusBarGetMaximumValue|StatusBarGetMaximumValue]]

API:StatusBarGetCurrentValue - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)