Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:47:28Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=PageWindow}}
Adds a window to a PageWindow's list of splitable windows.

<pre>
PageWindowAddSplitableWindow(pageWindowName, windowName)
</pre>

== Arguments ==
;pageWindowName : <code>string</code> – Name of the PageWindow.
;windowName : <code>string</code> – Name of a window inside the PageWindow's content.

== Returns ==
Nothing.

== Details ==
* The window is added to the PageWindow's splitable-window list. Nothing is laid out by this call; the list is used by [[API:PageWindowUpdatePages|PageWindowUpdatePages]].
* During layout, a window that starts on a page but runs past its bottom is normally moved to the next page. A window in this list is not moved. Instead the client creates a second window named ''windowName''<code>_pgbrk</code> from the same definition and with the same size, and lays it out as well.
* If <code>windowName</code> does not exist, the call does nothing. No error is raised for it.
* A window that is already in the list is not added a second time.
* The stock UI never calls this function.
* The function needs at least two arguments and only reads the last two. Any extra arguments placed in front of them are ignored.

== Errors ==
* <code>Error in function call 'PageWindowAddSplitableWindow': Window %s does not exist</code>
* <code>Error in function call 'PageWindowAddSplitableWindow': Window %s is not a PageWindow</code>

== Example ==
A minimal example built from the signature:
<pre>
PageWindowAddSplitableWindow( "MyBookPageWindow", "MyBookBigImage" )
PageWindowUpdatePages( "MyBookPageWindow" )
</pre>

== See also ==
* [[API:PageWindowRemoveSplitableWindow|PageWindowRemoveSplitableWindow]]
* [[API:PageWindowClearSplitableWindows|PageWindowClearSplitableWindows]]
* [[API:PageWindowUpdatePages|PageWindowUpdatePages]]

API:PageWindowAddSplitableWindow - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)