Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:46:09Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=LCD}}
Returns the value of an LCD progress bar.

<pre>
value = LCDProgressBarGetProgress(pageName, barName)
</pre>

== Arguments ==
;pageName : <code>string</code> – Name of the page.
;barName : <code>string</code> – Name of a progress bar created with [[API:LCDCreateProgressBar|LCDCreateProgressBar]].

== Returns ==
;value : <code>number</code> – The bar's current value.

== Details ==
* If the page or element does not exist, or the element is not a progress bar, an error below is logged and nothing is returned.
* The function needs at least two arguments and only reads the last two.
* The stock UI never calls this function.

== Errors ==
* <code>Error in function call 'LCDProgressBarGetProgress': Page '%s' does not exist.</code>
* <code>Error in function call 'LCDProgressBarGetProgress': Page '%s' does not have a child named '%s'.</code>
* <code>Error in function call 'LCDProgressBarGetProgress': '%s' on page '%s' is not a/an ProgressBar.</code>

== Example ==
A minimal example built from the signature:
<pre>
local hp = LCDProgressBarGetProgress( "MyPage", "HP" )
</pre>

== See also ==
* [[API:LCDProgressBarSetProgress|LCDProgressBarSetProgress]]
* [[API:LCDCreateProgressBar|LCDCreateProgressBar]]

API:LCDProgressBarGetProgress - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)