Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:43Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=PublicQuest}}
Returns the top-contributor scoreboard of the public quest the player has just finished, together with the player's own standing.

<pre>
data = GetPQTopContributors()
</pre>

== Arguments ==
None.

== Returns ==
;data : <code>table</code> – Public quest result table (see below), or nothing if the client holds no public quest result.

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>PQName</code> || <code>wstring</code> || Name of the public quest.
|-
| <code>metMinContribution</code> || <code>boolean</code> || –
|-
| <code>optedOut</code> || <code>boolean</code> || –
|-
| <code>forcedOut</code> || <code>boolean</code> || –
|-
| <code>numGoldSacks</code> || <code>number</code> || Number of gold loot bags.
|-
| <code>numPurpleSacks</code> || <code>number</code> || Number of purple loot bags.
|-
| <code>numBlueSacks</code> || <code>number</code> || Number of blue loot bags.
|-
| <code>numGreenSacks</code> || <code>number</code> || Number of green loot bags.
|-
| <code>numWhiteSacks</code> || <code>number</code> || Number of white loot bags.
|-
| <code>numContributors</code> || <code>number</code> || Total number of contributors.
|-
| <code>timeUntilPQReset</code> || <code>number</code> || Seconds until the public quest resets (a stored millisecond value divided by 1000, rounded down).
|-
| <code>scoreboardData</code> || <code>table</code> || Up to 24 contributor rows, see below.
|-
| <code>playerData</code> || <code>table</code> || The local player's row, see below.
|}

Each row in <code>scoreboardData</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>name</code> || <code>wstring</code> || Character name.
|-
| <code>grade</code> || <code>number</code> || –
|-
| <code>bonus</code> || <code>number</code> || Contribution bonus.
|-
| <code>roll</code> || <code>number</code> || <code>persistence</code> plus one other value stored for the row. <code>bonus</code> is not included.
|-
| <code>persistence</code> || <code>number</code> || –
|-
| <code>sackType</code> || <code>number</code> || Always <code>7</code> in this function.
|}

<code>playerData</code> has the same fields as a scoreboard row, plus <code>place</code> (<code>number</code>), the player's place on the scoreboard.

== Details ==
* The three flags come from three bits of one stored value.
* The scoreboard has 24 fixed slots. Slots with an empty name are skipped, but each row keeps the index of its slot, so <code>scoreboardData</code> can have gaps.
* <code>playerData</code> is always filled, even if the player has no row.
* The data is kept until [[API:ClearPQLootData|ClearPQLootData]] is called; after that the function returns nothing.
* The stock UI calls this function when the public quest result window switches to its "top contributors" state (<code>PQData.ShowTopContributors</code>).

== Errors ==
None.

== Example ==
From <code>default/easystem_utils/source/publicqueststates.lua</code>:
<pre>
function PQData.ShowTopContributors()
PQData.currentState = PQData.STATE_SHOW_TOP_CONTRIBUTORS
local contributorsData = GetPQTopContributors()

if contributorsData == nil
then
return
end

PQData.ParseScoreboardData( contributorsData )
</pre>

== See also ==
* [[API:GetPQLootWinners|GetPQLootWinners]]
* [[API:ClearPQLootData|ClearPQLootData]]
* [[API:PQLootItem|PQLootItem]]

API:GetPQTopContributors - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)