View source for API:GuildGetRewards

{{LuaApi|group=Guild}}
Returns the list of rewards that guilds unlock as they gain guild ranks.

<pre>
rewards = GuildGetRewards()
</pre>

== Arguments ==
None.

== Returns ==
;rewards : <code>table</code> – Array of reward tables, indexed from 1. Empty if the client has no reward data.

Each reward table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>rank</code> || <code>number</code> || Guild rank the reward belongs to.
|-
| <code>tacticId</code> || <code>number</code> || Tactic id. The stock UI treats -2 as "one reward plus a tactic point", -1 as no tactic, and -101 as the heraldry reward.
|-
| <code>realm</code> || <code>number</code> || Realm of the reward. The stock UI adds an <code>_ORDER</code> suffix to the string id when it is 1.
|-
| <code>sortOrder</code> || <code>number</code> || Sort position among rewards of the same rank. The stock UI treats 0 as "not set".
|-
| <code>rewardNum</code> || <code>number</code> || Reward number within the rank. The stock UI uses it to build the string id <code>GUILD_RANK&lt;rank&gt;_REWARD&lt;rewardNum&gt;</code>.
|}

== Details ==
* A comment in the stock UI describes the list as coming from a <code>.csv</code> file.
* A new table is built on every call.

== Errors ==
None.

== Example ==
From <code>default/ea_guildwindow/source/guildwindowtabrewards.lua</code>:
<pre>
local guildRewards = GuildGetRewards()

for k, v in ipairs(guildRewards) do
    if(v.sortOrder == 0)
    then
        v.sortOrder = nil
    end

    if(v.tacticId == GuildWindowTabRewards.TACTICID_SINGLE_REWARD_AND_TACTIC)
    then
        AddSingleRewardAndTacticPoint(v.rank)
    else
        AddGuildRewardData(v.rank, v.tacticId, v.realm, v.sortOrder, v.rewardNum)
    end
end
</pre>

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