Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:47:42Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Pregame}}
Returns which page of character slots the character select screen shows.

<pre>
realm, page = PregameGetCharacterSelectPage()
</pre>

== Arguments ==
None.

== Returns ==
;realm : <code>number</code> – The realm of the shown page, 1 or 2.
;page : <code>number</code> – The page within that realm, 1 or 2.

== Details ==
* Outside the pregame state, or before the character select screen is set up, the function returns nothing.
* The values match the arguments of [[API:PregameSetCharacterSelectPage|PregameSetCharacterSelectPage]], so the result can be passed straight back to it.

== Errors ==
None.

== Example ==
From <code>interfacecore/source/characterselectwindow.lua</code>:
<pre>
function CharacterSelectWindow.NextCharacterPage()
local rawPage = GetRawCharacterPageIndexFromRealmIndex( PregameGetCharacterSelectPage() ) + 1
if ( rawPage > GetTotalNumRawCharacterPages() )
then
rawPage = 1
end
PregameSetCharacterSelectPage( GetRealmCharacterPageIndexFromRawIndex( rawPage ) )
end
</pre>

== See also ==
* [[API:PregameSetCharacterSelectPage|PregameSetCharacterSelectPage]]
* [[API:PregameGetCharacterSelectNumPages|PregameGetCharacterSelectNumPages]]

API:PregameGetCharacterSelectPage - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)