Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:46:03Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=LCD}}
Adds a progress bar element to an LCD page.

<pre>
LCDCreateProgressBar(pageName, barName, style, minimum, maximum)
</pre>

== Arguments ==
;pageName : <code>string</code> – Name of the page.
;barName : <code>string</code> – Name of the new element.
;style : <code>string</code> – Bar style. The client compares it, ignoring case, with <code>"filled"</code>, <code>"cursor"</code> and <code>"dashed"</code>.
;minimum : <code>number</code> – Lowest value of the bar's range.
;maximum : <code>number</code> – Highest value of the bar's range.

== Returns ==
Nothing.

== Details ==
* <code>minimum</code> and <code>maximum</code> are converted to integers.
* The new bar starts at <code>minimum</code> and is 160 × 5 pixels. Change the size with [[API:LCDSetSize|LCDSetSize]] and the value with [[API:LCDProgressBarSetProgress|LCDProgressBarSetProgress]].
* If the page already has an element with this name, nothing is created.
* If the page does not exist, the error below is logged and nothing is created.
* The function needs at least five arguments and only reads the last five.

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

== Example ==
From <code>ea_lcdkeyboard/source/g15test.lua</code>:
<pre>
LCDCreateProgressBar( EA_LCDKeyboard.Page1, "HP", "filled", 0, 100 )
LCDSetLocation( EA_LCDKeyboard.Page1, "HP", 30, 0 )
LCDSetSize( EA_LCDKeyboard.Page1, "HP", 130, 9 )
</pre>

== See also ==
* [[API:LCDProgressBarSetProgress|LCDProgressBarSetProgress]]
* [[API:LCDProgressBarGetProgress|LCDProgressBarGetProgress]]
* [[API:LCDSetSize|LCDSetSize]]

API:LCDCreateProgressBar - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)