Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:47:34Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=PageWindow}}
Removes a window from a PageWindow's list of page breaks.

<pre>
PageWindowRemovePageBreak(pageWindowName, breakWindowName)
</pre>

== Arguments ==
;pageWindowName : <code>string</code> – Name of the PageWindow.
;breakWindowName : <code>string</code> – Name of the window to remove from the page-break list.

== Returns ==
Nothing.

== Details ==
* This undoes [[API:PageWindowAddPageBreak|PageWindowAddPageBreak]] for one window. The pages are not laid out again; call [[API:PageWindowUpdatePages|PageWindowUpdatePages]] afterwards.
* If <code>breakWindowName</code> does not exist or is not in the list, the call does nothing. No error is raised for it.
* 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 'PageWindowRemovePageBreak': Window %s does not exist</code>
* <code>Error in function call 'PageWindowRemovePageBreak': Window %s is not a PageWindow</code>

== Example ==
From <code>default/ea_tomeofknowledge/source/tomewindow_warjournal.lua</code>:
<pre>
if( TomeWindow.WarJournal.CurEntryData.glyphActivities[1] == nil and TomeWindow.WarJournal.CurEntryData.activities[1] == nil ) then
WindowSetShowing( "WarJournalEntryTextButton", false )
PageWindowAddPageBreak( "WarJournalEntryInfoPageWindow", parentWindow.."VertScrollAnchor" )
return
else
WindowSetShowing("WarJournalEntryTextButton", true)
PageWindowRemovePageBreak( "WarJournalEntryInfoPageWindow", parentWindow.."VertScrollAnchor" )
end
</pre>

== See also ==
* [[API:PageWindowAddPageBreak|PageWindowAddPageBreak]]
* [[API:PageWindowClearPageBreaks|PageWindowClearPageBreaks]]
* [[API:PageWindowUpdatePages|PageWindowUpdatePages]]

API:PageWindowRemovePageBreak - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)