Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:51:31Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Returns the number stored on a window as its id.

<pre>
id = WindowGetId(windowName)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the window.

== Returns ==
;id : <code>number</code> – The window's id, a whole number.

== Details ==
* The id is a free number for the UI's own use. It is set with [[API:WindowSetId|WindowSetId]].
* A common use is to find out which of several similar windows triggered an event handler, by reading the id of <code>SystemData.ActiveWindow.name</code> or one of its parents.

== Errors ==
* <code>Error in function call 'WindowGetId': Window %s does not exist</code>

== Example ==
Finding the dialog that a clicked button belongs to, from <code>easystem_dialogmanager/source/dialogmanager.lua</code>:
<pre>
function DialogManager.OnOneButtonDlgButton1()
local dlgIndex = WindowGetId( WindowGetParent( WindowGetParent(SystemData.ActiveWindow.name) ) )
-- ...
end
</pre>

== See also ==
* [[API:WindowSetId|WindowSetId]]
* [[API:WindowGetParent|WindowGetParent]]

API:WindowGetId - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)