Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:47:36Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=PageWindow}}
Turns a PageWindow to the given page.

<pre>
PageWindowSetCurrentPage(pageWindowName, page)
</pre>

== Arguments ==
;pageWindowName : <code>string</code> – Name of the PageWindow.
;page : <code>number</code> – Page to show, counted from 1. For a PageWindow that shows several pages side by side, this becomes the first (leftmost) page shown.

== Returns ==
Nothing.

== Details ==
* <code>page</code> is converted to a whole number.
* The page is clamped:
** It is never higher than the page count from [[API:PageWindowGetNumPages|PageWindowGetNumPages]] (or 1 if that is lower).
** It is never lower than 2 minus [[API:PageWindowGetNumPagesDisplayed|PageWindowGetNumPagesDisplayed]]. For a single-page window that is 1; for a two-page window, page 0 is accepted.
* The PageWindow's content is moved so that the page is the first one shown.
* No event or script handler is triggered.
* 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 'PageWindowSetCurrentPage': Window %s does not exist</code>
* <code>Error in function call 'PageWindowSetCurrentPage': Window %s is not a PageWindow</code>

== Example ==
From <code>TomeWindow.FlipPageWindowForward</code> in <code>default/ea_tomeofknowledge/source/tomewindow.lua</code>:
<pre>
PageWindowSetCurrentPage( pageWindow, curPage + flipPages )
TomeWindow.PlayFlipAnim( TomeWindow.FLIP_FORWARD_SINGLE )
</pre>

== See also ==
* [[API:PageWindowGetCurrentPage|PageWindowGetCurrentPage]]
* [[API:PageWindowGetNumPages|PageWindowGetNumPages]]
* [[API:PageWindowGetNumPagesDisplayed|PageWindowGetNumPagesDisplayed]]

API:PageWindowSetCurrentPage - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)