Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:24Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Game}}
Returns the player's macros.

<pre>
macros = GetMacrosData()
</pre>

== Arguments ==
None.

== Returns ==
;macros : <code>table</code> – Array of 48 macro tables, indexed by macro slot from 1 to 48.

Each macro table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>name</code> || <code>wstring</code> || Macro name.
|-
| <code>text</code> || <code>wstring</code> || Macro text (the commands it runs).
|-
| <code>iconNum</code> || <code>number</code> || Icon id for [[API:GetIconData|GetIconData]].
|}

== Details ==
* The table always has 48 entries, including empty macro slots.
* If the macro system is not loaded yet, or the Lua state is not available, the function returns nothing.
* A new table is built on every call. The stock UI caches it in <code>DataUtils.GetMacros()</code> (<code>easystem_utils/source/datautils.lua</code>) and rebuilds it only when <code>GameData.Macros.macrosDirty</code> is set.

== Errors ==
None.

== Example ==
From <code>easystem_utils/source/datautils.lua</code>:
<pre>
function DataUtils.GetMacros()
if( GameData.Macros.macrosDirty ) then
GameData.Macros.macrosDirty = false
DataUtilsData.macros = GetMacrosData()
end
return DataUtilsData.macros
end
</pre>

From <code>ea_macrowindow/source/macrowindow.lua</code>:
<pre>
local macros = DataUtils.GetMacros()
...
local texture, x, y = GetIconData( macros[slot].iconNum )
</pre>

== See also ==
* [[API:GetIconData|GetIconData]]

API:GetMacrosData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)