https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3APageWindowAddPageBreakAPI:PageWindowAddPageBreak - Revision history2026-10-17T01:29:12ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:PageWindowAddPageBreak&diff=30620&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:47:28Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=PageWindow}}<br />
Marks a window inside a PageWindow as a page break, so that it always starts a new page.<br />
<br />
<pre><br />
PageWindowAddPageBreak(pageWindowName, breakWindowName)<br />
</pre><br />
<br />
== Arguments ==<br />
;pageWindowName : <code>string</code> – Name of the PageWindow.<br />
;breakWindowName : <code>string</code> – Name of the window that should start a new page. It is normally a window inside the PageWindow's content.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* The window is added to the PageWindow's list of page breaks. Nothing is laid out by this call; the list is used the next time the pages are laid out with [[API:PageWindowUpdatePages|PageWindowUpdatePages]].<br />
* During layout, a page-break window that is not already at the top of a page is moved to the top of the next page, together with everything below it.<br />
* If <code>breakWindowName</code> does not exist, the call does nothing. No error is raised for it.<br />
* A window that is already in the list is not added a second time, so calling the function again for the same window is harmless.<br />
* When [[API:PageWindowUpdatePages|PageWindowUpdatePages]] splits a Label across two pages, the client creates a Label named ''labelName''<code>_pgbrk</code> for the continued text and adds it to this list itself. The stock Tome of Knowledge checks for such a window with <code>DoesWindowExist( "BestiarySpeciesInfoText1_pgbrk" )</code>.<br />
* The function needs at least two arguments and only reads the last two. Any extra arguments placed in front of them are ignored.<br />
<br />
== Errors ==<br />
* <code>Error in function call 'PageWindowAddPageBreak': Window %s does not exist</code><br />
* <code>Error in function call 'PageWindowAddPageBreak': Window %s is not a PageWindow</code><br />
<br />
== Example ==<br />
From <code>default/ea_tomeofknowledge/source/tomewindow_bestiary.lua</code>: remove a break, re-lay out the pages, and add the break back only if the text was not split:<br />
<pre><br />
PageWindowRemovePageBreak( "BestiarySpeciesInfoPageWindow", "BestiarySpeciesTaskAnchor" )<br />
PageWindowUpdatePages( "BestiarySpeciesInfoPageWindow" )<br />
<br />
if( not DoesWindowExist( "BestiarySpeciesInfoText1_pgbrk" ) )<br />
then<br />
WindowSetShowing( "BestiarySpeciesDivider", false )<br />
PageWindowAddPageBreak( "BestiarySpeciesInfoPageWindow", "BestiarySpeciesTaskAnchor" )<br />
PageWindowUpdatePages( "BestiarySpeciesInfoPageWindow" )<br />
end<br />
</pre><br />
<br />
== See also ==<br />
* [[API:PageWindowRemovePageBreak|PageWindowRemovePageBreak]]<br />
* [[API:PageWindowClearPageBreaks|PageWindowClearPageBreaks]]<br />
* [[API:PageWindowUpdatePages|PageWindowUpdatePages]]</div>Maintenance script