Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:57Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Pregame}}
Returns the list of game servers that the login server sent.

<pre>
servers = GetServerList()
</pre>

== Arguments ==
None.

== Returns ==
;servers : <code>table</code> – Array of server tables, indexed from 1.

Each server table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>name</code> || <code>wstring</code> || Server name.
|-
| <code>id</code> || <code>number</code> || Server id. Pass it to [[API:SelectServer|SelectServer]].
|-
| <code>status</code> || <code>number</code> || –
|-
| <code>population</code> || <code>number</code> || –
|-
| <code>maximum</code> || <code>number</code> || –
|-
| <code>language</code> || <code>number</code> || Language id. The stock UI looks it up in the <code>ServerLanguage</code> string table.
|-
| <code>orderPopulationDensity</code> || <code>number</code> || Order population level. The stock UI combines it with <code>orderPopulationQueue</code> to judge realm imbalance.
|-
| <code>destructionPopulationDensity</code> || <code>number</code> || Destruction population level.
|-
| <code>orderPopulationQueue</code> || <code>number</code> || –
|-
| <code>destructionPopulationQueue</code> || <code>number</code> || –
|-
| <code>online</code> || <code>boolean</code> || <code>true</code> if the server is up.
|-
| <code>region</code> || <code>string</code> || Region key, such as <code>"STR_REGION_NORTHAMERICA"</code>. The stock UI uses it as a key into <code>StringTables.ServerLocation</code>.
|-
| <code>rulesetOpenRvR</code> || <code>boolean</code> || –
|-
| <code>rulesetRolePlaying</code> || <code>boolean</code> || –
|-
| <code>rulesetCore</code> || <code>boolean</code> || –
|-
| <code>localeDistance</code> || <code>number</code> || The stock UI sorts by it and treats 0 as a local server.
|-
| <code>sameLanguage</code> || <code>boolean</code> || –
|-
| <code>orderBonus</code> || <code>number</code> || Order bonus value. The stock UI passes it to [[API:PregameSetServerRealmBonuses|PregameSetServerRealmBonuses]].
|-
| <code>destructionBonus</code> || <code>number</code> || Destruction bonus value.
|-
| <code>redirect</code> || <code>boolean</code> || –
|-
| <code>trialServer</code> || <code>boolean</code> || –
|-
| <code>legacy</code> || <code>boolean</code> || –
|-
| <code>retired</code> || <code>boolean</code> || <code>true</code> for a retired server. [[API:SelectServer|SelectServer]] refuses these.
|-
| <code>orderChars</code> || <code>boolean</code> || <code>true</code> if the account has at least one Order character on this server.
|-
| <code>destructionChars</code> || <code>boolean</code> || <code>true</code> if the account has at least one Destruction character on this server.
|-
| <code>characterCount</code> || <code>number</code> || Number of the account's characters on this server.
|}

== Details ==
* A new table is built from the client's stored login data on every call.
* The function returns nothing if the login data is not available.
* The stock server select window refreshes its list on <code>SystemData.Events.SERVER_LIST_RESPONSE</code>.

== Errors ==
None.

== Example ==
From <code>interfacecore/source/serverselectwindow.lua</code>:
<pre>
local tempList = GetServerList()
ServerSelectWindow.serverList = {}

for _, data in ipairs(tempList)
do
-- show the server if it is not a legacy server and not a retired server
-- or if it is not retired, and is a legacy server, and we are set to showLegacyServers
-- or if the server is legacy or retired, but we have a character on it
if( ( not data.legacy and not data.retired) or
( not data.retired and data.legacy and ServerSelectWindow.showLegacyServers ) or
( data.characterCount ~= 0 ) )
then
table.insert(ServerSelectWindow.serverList, data)
end
end
</pre>

== See also ==
* [[API:SelectServer|SelectServer]]
* [[API:PregameSetServerRealmBonuses|PregameSetServerRealmBonuses]]
* [[API:GetAccountData|GetAccountData]]

API:GetServerList - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)