Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:36Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=ComboBox}}
Adds an item to the end of a ComboBox's menu.

<pre>
ComboBoxAddMenuItem(comboBoxName, text)
</pre>

== Arguments ==
;comboBoxName : <code>string</code> – Name of the ComboBox.
;text : <code>wstring</code> – Text of the new item. It must be a wide string: <code>L"Option"</code> or <code>towstring(3)</code> work, <code>"Option"</code> does not.

== Returns ==
Nothing.

== Details ==
* Items are numbered from 1 in the order they are added. Use that number with [[API:ComboBoxSetSelectedMenuItem|ComboBoxSetSelectedMenuItem]] and [[API:ComboBoxGetSelectedMenuItem|ComboBoxGetSelectedMenuItem]].
* Adding an item does not change the selection.
* Passing an ordinary Lua string raises an ''Invalid Parameters'' error.
* The function needs at least two arguments and only reads the last two. Any extra arguments placed in front of them are ignored.

== Errors ==
The type error says <code>ComboBoxCast</code>:
* <code>Error in function call 'ComboBoxAddMenuItem': Window %s does not exist</code>
* <code>Error in function call 'ComboBoxAddMenuItem': Window %s is not a ComboBoxCast</code>

== Example ==
Rebuilding a menu, from <code>default/ea_settingswindow/source/settingswindowtabinterface.lua</code>:
<pre>
ComboBoxClearMenuItems( settingsBarName.."Rows" )

local numMenuItems = 1
local halfButtons = math.floor( numButtons / 2 )
for j = 1, halfButtons
do
if( math.fmod( numButtons, j ) == 0 )
then
ComboBoxAddMenuItem( settingsBarName.."Rows", towstring( j ) )

if( rows == j )
then
ComboBoxSetSelectedMenuItem( settingsBarName.."Rows", numMenuItems )
end
...
</pre>

== See also ==
* [[API:ComboBoxClearMenuItems|ComboBoxClearMenuItems]]
* [[API:ComboBoxSetSelectedMenuItem|ComboBoxSetSelectedMenuItem]]
* [[API:ComboBoxGetSelectedText|ComboBoxGetSelectedText]]

API:ComboBoxAddMenuItem - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)