Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:47:45Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Pregame}}
Returns the texts the quick start window shows for the character it offers to log in.

<pre>
nameLabel, rank, careerLabel, locationLabel = PregameGetQuickStartLabels()
</pre>

== Arguments ==
None.

== Returns ==
;nameLabel : <code>wstring</code> – The character's name and surname, joined by one of the client's built-in text templates.
;rank : <code>number</code> – The character's rank. A stored rank of 0 is returned as 1.
;careerLabel : <code>wstring</code> – The character's career name.
;locationLabel : <code>wstring</code> – The character's location, put into one of the client's built-in text templates.

== Details ==
* The function only returns values in the pregame state, when the character select screen and its quick start character data exist. Otherwise it returns nothing.
* The stock quick start window also reads <code>rank</code> on its own, to warn trial accounts about characters above the trial level cap.

== Errors ==
None.

== Example ==
From <code>interfacecore/source/quickstartwindow.lua</code>:
<pre>
local nameLabel, rank, careerLabel, locationLabel = PregameGetQuickStartLabels( )
LabelSetText("QuickStartWindowNameLabel", nameLabel)
local rankAndCareerLineText = GetPregameStringFormat( StringTables.Pregame.TEXT_QUICK_START_LINE_TWO, { rank, careerLabel} )
LabelSetText("QuickStartWindowRankLabel", rankAndCareerLineText)
LabelSetText("QuickStartWindowLocationLabel", locationLabel)
</pre>

== See also ==
* [[API:GetAccountData|GetAccountData]]
* [[API:GetServerList|GetServerList]]

API:PregameGetQuickStartLabels - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)