Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:37Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=ComboBox}}
Removes all items from a ComboBox's menu.

<pre>
ComboBoxClearMenuItems(comboBoxName)
</pre>

== Arguments ==
;comboBoxName : <code>string</code> – Name of the ComboBox.

== Returns ==
Nothing.

== Details ==
* The menu's item buttons are destroyed and the selection is cleared: the selected-item text becomes empty and [[API:ComboBoxGetSelectedMenuItem|ComboBoxGetSelectedMenuItem]] returns 0.
* If an item was selected before the call, the ComboBox's <code>OnSelChanged</code> handler runs with <code>0</code>. Unlike [[API:ComboBoxSetSelectedMenuItem|ComboBoxSetSelectedMenuItem]], this does trigger the handler, so guard your handler if it should ignore the reset.

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

== Example ==
From <code>default/ea_settingswindow/source/settingswindowtabinterface.lua</code>:
<pre>
ComboBoxClearMenuItems( settingsBarName.."Rows" )
...
ComboBoxAddMenuItem( settingsBarName.."Rows", towstring( j ) )
</pre>

== See also ==
* [[API:ComboBoxAddMenuItem|ComboBoxAddMenuItem]]
* [[API:ComboBoxSetSelectedMenuItem|ComboBoxSetSelectedMenuItem]]

API:ComboBoxClearMenuItems - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)