View source for API:GetPQLootWinners

{{LuaApi|group=PublicQuest}}
Returns the final loot roll results of the public quest the player has just finished.

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

== Arguments ==
None.

== Returns ==
;data : <code>table</code> – 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>scoreboardData</code> || <code>table</code> || Up to 24 loot rows, see below.
|-
| <code>playerData</code> || <code>table</code> || The local player's row, see below. Empty if the client has no row for the player.
|}

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>sackType</code> || <code>number</code> || Bag won. <code>6</code> for the first rows, one per gold bag; for later rows the stored bag type if it is 1 to 4, otherwise <code>0</code>.
|-
| <code>roll</code> || <code>number</code> || <code>persistence</code> plus two other values stored for the row.
|-
| <code>persistence</code> || <code>number</code> || –
|-
| <code>bonus</code> || <code>number</code> || Always <code>-1</code> in this function.
|}

<code>playerData</code>, when filled, has the same fields plus:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>place</code> || <code>number</code> || The player's place.
|-
| <code>looserPrize</code> || <code>wstring</code> || Text of a consolation prize; the stock UI shows it when it is not empty. (The key is spelled <code>looserPrize</code>.)
|}

For <code>playerData</code>, <code>sackType</code> is <code>6</code> when <code>place</code> is not larger than the number of gold bags; otherwise it is worked out as for the other rows.

== Details ==
* Compared to [[API:GetPQTopContributors|GetPQTopContributors]], this table has no bag counts, no <code>numContributors</code> and no <code>timeUntilPQReset</code>, and <code>bonus</code> is always <code>-1</code>. The stock UI shows no contribution text when <code>bonus</code> is negative.
* Slots with an empty name are skipped, but each row keeps the index of its slot, so <code>scoreboardData</code> can have gaps.
* The data is kept until [[API:ClearPQLootData|ClearPQLootData]] is called; after that the function returns nothing.

== Errors ==
None.

== Example ==
From <code>default/easystem_utils/source/publicqueststates.lua</code>:
<pre>
local winnersData = GetPQLootWinners()
if winnersData ~= nil
then
    PQData.ParseScoreboardData( winnersData )
elseif (GameData.PQData.pqName ~= nil) and (GameData.PQData.pqName ~= L"")
then
    PQData.SetResettingData()
else
    ERROR(L"PQData.ShowFinalResults Error: no data found")
    return
end
</pre>

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