Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:53Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Interface}}
Creates a new window from a window template and puts it under a parent window.

<pre>
created = CreateWindowFromTemplate(windowName, templateName, parentName)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the new window. Child windows named <code>$parent...</code> in the template get their names from it.
;templateName : <code>string</code> – Name of a window template defined in a loaded XML file.
;parentName : <code>string</code> – Name of an existing window that becomes the parent. Use <code>"Root"</code> for a top-level window.

== Returns ==
;created : <code>boolean</code> – <code>true</code> if the window was created (or reused, see below), <code>false</code> otherwise.

== Details ==
* The parent is checked first. If it does not exist, nothing is created and an error is logged.
* If a window called <code>windowName</code> already exists, nothing is created and an error is logged. The exception is a window that is waiting for a deferred [[API:DestroyWindow|DestroyWindow]]: it is taken off the destroy list and kept as it is.
* If the template cannot be found or built, an error is logged and <code>false</code> is returned.
* When argument checking fails, nothing is returned.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>ERROR: Unable to create window: %s, parent window %s is invalid</code>
* <code>ERROR: Unable to create window: %s, from template %s</code>
* <code>ERROR: Window with this name already exists: %s</code>

== Example ==
From <code>easystem_glyphdisplay/source/glyphdisplay.lua</code>:
<pre>
CreateWindowFromTemplate( glyphWindowName, "WorldMapGlyph", self.windowName )
</pre>

Creating a list row on demand, from <code>ea_tomeofknowledge/source/tomewindow_bestiary.lua</code>:
<pre>
CreateWindowFromTemplate( taskWindowName, "BestiarySpeciesTaskWindow", parentWindow )
WindowAddAnchor( taskWindowName, "bottomleft", anchorWindow, "topleft", xOffset, yOffset )
</pre>

== See also ==
* [[API:CreateWindow|CreateWindow]]
* [[API:DestroyWindow|DestroyWindow]]
* [[API:WindowSetParent|WindowSetParent]]

API:CreateWindowFromTemplate - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)