Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:38Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=ComboBox}}
Opens a ComboBox's drop-down menu from script, as if the user had clicked it.

<pre>
opened = ComboBoxExternalOpenMenu(comboBoxName)
</pre>

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

== Returns ==
;opened : <code>boolean</code> – <code>false</code> if the menu was already open; <code>true</code> otherwise.

== Details ==
* If the menu is already open, nothing happens and the function returns <code>false</code>.
* A disabled ComboBox (see [[API:ComboBoxSetDisabledFlag|ComboBoxSetDisabledFlag]]) does not open, but the function still returns <code>true</code>. Use [[API:ComboBoxIsMenuOpen|ComboBoxIsMenuOpen]] afterwards if you need to know whether the menu really opened.

== Errors ==
* <code>Error in function call 'ComboBoxExternalOpenMenu': Window %s does not exist</code>
* <code>Error in function call 'ComboBoxExternalOpenMenu': Window %s is not a ComboBox</code>

== Example ==
From <code>default/ea_tacticswindow/source/tacticswindow.lua</code>:
<pre>
-- If we just open every time an empty slot is clicked, then the menu closes on the L button down event (due to C++ code)
-- and then opens on the LButtonUp, which is probably not what the user is expecting to see.
if (button:GetId() == 0) and (TacticsEditor.openMenuOnNextClick) then
ComboBoxExternalOpenMenu("EA_TacticsEditorContentsSetMenu");
end
</pre>

== See also ==
* [[API:ComboBoxIsMenuOpen|ComboBoxIsMenuOpen]]
* [[API:ComboBoxSetDisabledFlag|ComboBoxSetDisabledFlag]]

API:ComboBoxExternalOpenMenu - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)