Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:43Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=ComboBox}}
Selects an item of a ComboBox.

<pre>
ComboBoxSetSelectedMenuItem(comboBoxName, index)
</pre>

== Arguments ==
;comboBoxName : <code>string</code> – Name of the ComboBox.
;index : <code>number</code> – Number of the item to select, counted from 1 in the order the items were added. Use 0 to clear the selection.

== Returns ==
Nothing.

== Details ==
* <code>index</code> is converted to a whole number.
* The ComboBox's selected-item button shows the text of the chosen item.
* An index that does not match an item (0, a negative number, or a number above the item count) clears the selection, and the selected-item text becomes empty.
* The ComboBox's <code>OnSelChanged</code> handler is '''not''' run by this function. It runs only when the user picks an item, or when [[API:ComboBoxClearMenuItems|ComboBoxClearMenuItems]] clears a selection.
* If the item is already selected, nothing happens.
* 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 'ComboBoxSetSelectedMenuItem': Window %s does not exist</code>
* <code>Error in function call 'ComboBoxSetSelectedMenuItem': Window %s is not a ComboBoxCast</code>

== Example ==
From <code>default/ea_settingswindow/source/settingswindowtabinterface.lua</code>:
<pre>
ComboBoxSetSelectedMenuItem( settingsBarName.."NumberButtons", barSettings.buttonCount )
</pre>

== See also ==
* [[API:ComboBoxGetSelectedMenuItem|ComboBoxGetSelectedMenuItem]]
* [[API:ComboBoxGetSelectedText|ComboBoxGetSelectedText]]
* [[API:ComboBoxAddMenuItem|ComboBoxAddMenuItem]]

API:ComboBoxSetSelectedMenuItem - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)