Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:40:02Z

UI Lua API import (WAR 1.4.8)

New page

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

<pre>
id = ActionButtonGroupGetId(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 ==
;id : <code>number</code> – The value set with [[API:ActionButtonGroupSetId|ActionButtonGroupSetId]].

== 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 function needs at least two arguments and only reads the last two.

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

== Example ==
A career icon's tooltip, from <code>easystem_tooltips/source/careertooltips.lua</code>:
<pre>
function Tooltips.OnMouseOverActionButtonGroupCareerIcon( buttonId, flags )

local careerLineId = ActionButtonGroupGetId( SystemData.ActiveWindow.name, buttonId )

local text = GetCareerLine(careerLineId)
</pre>

== See also ==
* [[API:ActionButtonGroupSetId|ActionButtonGroupSetId]]
* [[API:ActionButtonGroupGetIcon|ActionButtonGroupGetIcon]]

API:ActionButtonGroupGetId - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)