Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:47:37Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=PageWindow}}
Lays out a PageWindow's content across its pages and recounts the pages.

<pre>
PageWindowUpdatePages(pageWindowName)
</pre>

== Arguments ==
;pageWindowName : <code>string</code> – Name of the PageWindow.

== Returns ==
Nothing.

== Details ==
* Call this after changing the content of a PageWindow (text, shown windows, page breaks). The page count is not updated until you do.
* The child windows of the PageWindow's content are placed page by page, top to bottom:
** A window that starts on a page but runs past its bottom is moved to the top of the next page, together with everything below it. A window that already starts at the top of a page is left where it is, even if it is taller than the page.
** A window registered with [[API:PageWindowAddPageBreak|PageWindowAddPageBreak]] always starts a new page.
** A window registered with [[API:PageWindowAddSplitableWindow|PageWindowAddSplitableWindow]] is not moved; a copy named ''windowName''<code>_pgbrk</code> is created instead.
** Some Labels are split instead of moved: the lines that fit stay on the page, and the rest of the text goes into a new Label named ''labelName''<code>_pgbrk</code> at the top of the next page. That new Label is also added to the page-break list.
* After the layout, the page count is recalculated (see [[API:PageWindowGetNumPages|PageWindowGetNumPages]]) and the content is resized so that all pages sit side by side.
* The current page is then set again, which clamps it to the new page count (see [[API:PageWindowSetCurrentPage|PageWindowSetCurrentPage]]).

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

== Example ==
From <code>default/ea_tomeofknowledge/source/tomewindow_bestiary.lua</code>:
<pre>
PageWindowRemovePageBreak( "BestiarySpeciesInfoPageWindow", "BestiarySpeciesTaskAnchor" )
PageWindowUpdatePages( "BestiarySpeciesInfoPageWindow" )
...
PageWindowSetCurrentPage( "BestiarySpeciesInfoPageWindow", 1 )
</pre>

== See also ==
* [[API:PageWindowGetNumPages|PageWindowGetNumPages]]
* [[API:PageWindowSetCurrentPage|PageWindowSetCurrentPage]]
* [[API:PageWindowAddPageBreak|PageWindowAddPageBreak]]
* [[API:PageWindowAddSplitableWindow|PageWindowAddSplitableWindow]]

API:PageWindowUpdatePages - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)