Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:40:01Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=ActionButtonGroup}}
Returns the icon number shown on one button of an ActionButtonGroup.

<pre>
iconId = ActionButtonGroupGetIcon(groupName, buttonIndex)
</pre>

== Arguments ==
;groupName : <code>string</code> – Name of an ActionButtonGroup window.
;buttonIndex : <code>number</code> – Button number, starting at 1. Fractions are dropped.

== Returns ==
;iconId : <code>number</code> – The icon number stored by [[API:ActionButtonGroupSetIcon|ActionButtonGroupSetIcon]]; 0 after the icon was cleared with it.

== Details ==
* <code>buttonIndex</code> must be between 1 and the number of buttons; otherwise the ''not a valid ButtonIndex'' error is logged and nothing is returned.
* If the window does not exist or is not an ActionButtonGroup, the error is logged and nothing is returned.
* The argument check is shared with [[API:ActionButtonGroupGetId|ActionButtonGroupGetId]]: if an argument is missing or has the wrong type, the ''Invalid Parameters'' message names that function.
* The function needs at least two arguments and only reads the last two.
* The stock UI never calls <code>ActionButtonGroupGetIcon</code>.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>Error in function call 'ActionButtonGroupGetIcon': Window %s does not exist</code>
* <code>Error in function call 'ActionButtonGroupGetIcon': Window %s is not a ActionButtonGroup</code>
* <code>Error in function call 'ActionButtonGroupGetIcon': '%d' is not a valid ButtonIndex. (NumButtons = '%d')</code>

== Example ==
A minimal example built from the signature above:
<pre>
local iconId = ActionButtonGroupGetIcon( "MyButtonGroup", 1 )
</pre>

== See also ==
* [[API:ActionButtonGroupSetIcon|ActionButtonGroupSetIcon]]
* [[API:ActionButtonGroupGetId|ActionButtonGroupGetId]]

API:ActionButtonGroupGetIcon - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)