Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:51:46Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Resizes a window so that its right and bottom edges enclose its child windows.

<pre>
WindowResizeOnChildren(windowName, recurse, borderSpacing)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the window to resize.
;recurse : <code>boolean</code> – <code>true</code> to also look at the children of the children, all the way down.
;borderSpacing : <code>number</code> – Extra space added to the right and bottom.

== Returns ==
Nothing.

== Details ==
* The client finds the right-most and bottom-most edge of the child windows, adds <code>borderSpacing</code>, and sets the window's width and height so that its right and bottom edges are there. The window's top-left corner does not move.
* The window can grow or shrink.
* Only child windows whose showing flag is set and which have fewer than two anchors are measured. Children with two or more anchors (for example ones stretched across the window) are ignored.
* With <code>recurse = true</code>, the children of measured children are measured as well.
* The new size is set as with [[API:WindowSetDimensions|WindowSetDimensions]], so the same limits and side effects apply. The window's own anchors are processed afterwards.
* The stock UI shows a dialog before calling this function on it. Its comment says that it does not work otherwise.
* The ''No window specified'' error exists in the client but cannot be raised: a missing name is replaced by an empty string first, which gives the ''does not exist'' error.

== Errors ==
* <code>Error in function call 'WindowResizeOnChildren': Window %s does not exist.</code>
* <code>Error in function call 'WindowResizeOnChildren': Window %s is currently locked and may not be modified from lua. ...</code><br/>This check never triggers in the current client. See [[API:WindowSetShowing|WindowSetShowing]].

== Example ==
From <code>easystem_dialogmanager/source/dialogmanager.lua</code>:
<pre>
-- Show the Dialog.
-- This must be done before WindowResizeOnChildren -- it doesn't work otherwise.
WindowSetShowing( "OneButtonDlg"..dlgIndex, true )

WindowResizeOnChildren( "OneButtonDlg"..dlgIndex.."Box", false, 10 )
</pre>

== See also ==
* [[API:WindowSetDimensions|WindowSetDimensions]]
* [[API:WindowGetDimensions|WindowGetDimensions]]

API:WindowResizeOnChildren - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)