Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:39Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=ComboBox}}
Returns the number of the selected item of a ComboBox.

<pre>
index = ComboBoxGetSelectedMenuItem(comboBoxName)
</pre>

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

== Returns ==
;index : <code>number</code> – Number of the selected item, counted from 1. <code>0</code> when nothing is selected.

== Details ==
* Items are numbered in the order they were added with [[API:ComboBoxAddMenuItem|ComboBoxAddMenuItem]].

== Errors ==
The error messages use the name <code>ComboGetSelectedMenuItem</code>:
* <code>Error in function call 'ComboGetSelectedMenuItem': Window %s does not exist</code>
* <code>Error in function call 'ComboGetSelectedMenuItem': Window %s is not a ComboBoxCast</code>

== Example ==
From <code>default/ea_settingswindow/source/settingswindowtabgeneral.lua</code>:
<pre>
SystemData.Settings.GamePlay.combatLighting = ComboBoxGetSelectedMenuItem( SettingsWindowTabGeneral.contentsName.."SettingsGamePlayCombatLightingCombo" )
</pre>

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

API:ComboBoxGetSelectedMenuItem - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)