Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:54Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Scenario}}
Returns the scenario queues the player is currently in, or nothing if the player is not queued.

<pre>
queueData = GetScenarioQueueData()
</pre>

== Arguments ==
None.

== Returns ==
;queueData : <code>table</code> – Queue table (see below), or nothing when the player is in no queue.

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>totalQueuedScenarios</code> || <code>number</code> || Number of queue entries.
|-
| <code>[1]</code> … <code>[n]</code> || <code>table</code> || One table per queue entry, see below.
|}

Each queue entry:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Id of the queued scenario.
|-
| <code>grouped</code> || <code>boolean</code> || –
|-
| <code>type</code> || <code>number</code> || Queue type. The stock UI passes it together with <code>id</code> to <code>EA_Window_OverheadMap.GetQueueName</code> to build the entry's name.
|}

== Details ==
* The stock UI uses the <code>nil</code> result as the "not queued" test (for example to stop the glow animation on the overhead map's queue button).
* A new table is built on every call.

== Errors ==
None.

== Example ==
From <code>default/ea_overheadmapwindow/source/overheadmapwindow.lua</code>:
<pre>
local queueData = GetScenarioQueueData()

if( queueData ~= nil) then
EA_Window_ContextMenu.CreateContextMenu( SystemData.ActiveWindow.name )

local queueCount = queueData.totalQueuedScenarios
for index = 1, queueCount do
local queueName = EA_Window_OverheadMap.GetQueueName( queueData[index].type, queueData[index].id )
...
end
</pre>

== See also ==
* [[API:IsScenarioF2PServer|IsScenarioF2PServer]]
* [[API:JoinScenarioGroup|JoinScenarioGroup]]

API:GetScenarioQueueData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)