Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:49Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=RvR}}
Returns the progress of all realm resource quests (RRQs) the client knows about.

<pre>
rrqData = GetRRQData()
</pre>

== Arguments ==
None.

== Returns ==
;rrqData : <code>table</code> – Table keyed by RRQ id (not an array), or nothing if the client has no RRQ data object.

Each entry <code>rrqData[rrquestID]</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>rrquestID</code> || <code>number</code> || The RRQ id (same as the key).
|-
| <code>displayType</code> || <code>number</code> || Display style. The stock UI compares it with <code>GameData.RRQDisplayType</code> values (for example <code>ERRQDISPLAY_LIVE_EVENT</code>, <code>ERRQDISPLAY_TOMB_KINGS</code>).
|-
| <code>paused</code> || <code>boolean</code> || <code>true</code> when <code>minutesUntilUnpause</code> is greater than 0.
|-
| <code>minutesUntilUnpause</code> || <code>number</code> || –
|-
| <code>realmWithAccess</code> || <code>number</code> || Realm that has access. Read as a signed byte; the stock UI's test data uses <code>-1</code> for "none".
|-
| <code>realmProgress</code> || <code>table</code> || Progress per realm, keyed by realm number. Each value is a table with <code>curVal</code> (<code>number</code>) and <code>maxVal</code> (<code>number</code>).
|}

== Details ==
* <code>paused</code> is not stored separately; it is derived from <code>minutesUntilUnpause</code>.
* <code>realmProgress</code> is keyed by realm value, so use <code>pairs</code> or index it with <code>GameData.Realm.ORDER</code> / <code>GameData.Realm.DESTRUCTION</code>, as the stock UI does.
* A new table is built on every call. The stock UI calls this function from its <code>SystemData.Events.RRQ_LIST_UPDATED</code> handler.

== Errors ==
None.

== Example ==
From <code>default/easystem_rrq/source/rrqprogressbar.lua</code>:
<pre>
function RRQProgressBar.OnRRQsUpdated()
RRQProgressBar.RealmResourceQuestData = GetRRQData()

for windowID, windowData in pairs( RRQProgressBarTracker )
do
RRQProgressBar.UpdateStatusWindow( windowID )
end
end
</pre>

Reading one realm's progress, from the same file:
<pre>
local rrqData = RRQProgressBar.RealmResourceQuestData[self.rrquestID]
...
StatusBarSetMaximumValue(self.windowName.."Bar"..iRealm.."Bar", rrqData.realmProgress[iRealm].maxVal)
StatusBarSetCurrentValue(self.windowName.."Bar"..iRealm.."Bar", rrqData.realmProgress[iRealm].curVal)
</pre>

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

API:GetRRQData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)