Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:46:39Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Pregame}}
Returns information about the current loading screen: the zone or scenario being loaded and the texts to show.

<pre>
loadingData = LoadingScreenGetCurrentData()
</pre>

== Arguments ==
None.

== Returns ==
;loadingData : <code>table</code> – A table with these fields:

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>screenDefId</code> || <code>number</code> || Loading screen definition. 0 when the client has no definition for the load. The stock UI only uses its zone or scenario screens when this is not 0.
|-
| <code>zoneId</code> || <code>number</code> || Zone being loaded. The stock UI passes it to <code>GetZoneName</code>.
|-
| <code>scenarioId</code> || <code>number</code> || Scenario being loaded, 0 for none. The stock UI passes it to <code>GetScenarioName</code>.
|-
| <code>realmId</code> || <code>number</code> || – (0 when there is no screen definition)
|-
| <code>raceId</code> || <code>number</code> || 0 when there is no screen definition. The stock UI uses it to pick a racial divider image.
|-
| <code>zoneText</code> || <code>wstring</code> || Zone description text from the client's loading screen strings.
|-
| <code>tipText</code> || <code>wstring</code> || Tip text from the client's loading screen strings.
|}

== Details ==
* The values are the client's current loading screen state. A new table is built on every call.
* If the loading screen string collections are not loaded, <code>zoneText</code> and <code>tipText</code> are empty.

== Errors ==
None.

== Example ==
From <code>ea_loadingscreen/source/loadingscreen.lua</code>:
<pre>
local loadingData = LoadingScreenGetCurrentData()
-- ...
elseif( loadingData.scenarioId ~= 0 and (loadingData.screenDefId ~= 0) )
then
EA_Window_LoadingScreen.activeMode = EA_Window_LoadingScreen.MODE_SCENARIO_ENTER

-- Otherwise use the standard zone screen if we have data
elseif( (loadingData.zoneId ~= 0) and (loadingData.screenDefId ~= 0) )
then
EA_Window_LoadingScreen.activeMode = EA_Window_LoadingScreen.MODE_STANDARD_ZONE
</pre>

From <code>ea_loadingscreen/source/standardloadingscreen.lua</code>:
<pre>
LabelSetText( textContainerName.."ZoneDescText", loadingData.zoneText )
LabelSetText( textContainerName.."TipText", loadingData.tipText )
</pre>

== See also ==
* [[API:LoadingScreenGetPatchNotesData|LoadingScreenGetPatchNotesData]]

API:LoadingScreenGetCurrentData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)