Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:50Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Guild}}
Returns the player's guild advancement: tactic points, unlocked standards, posts and bearers, and the list of guild tactics.

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

== Arguments ==
None.

== Returns ==
;data : <code>table</code> – A table with named fields and an array part, see below.

Named fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>abilityPoints</code> || <code>number</code> || –
|-
| <code>numberBannersUnlocked</code> || <code>number</code> || Number of guild standards unlocked.
|-
| <code>numberPolesUnlocked</code> || <code>number</code> || Number of banner posts unlocked. The stock UI fills its post combo box from 1 to this value.
|-
| <code>numberStandardBearersUnlocked</code> || <code>number</code> || Maximum number of standard bearers.
|}

Array part, indexed from 1, one table per guild tactic:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>abilityID</code> || <code>number</code> || Ability id of the tactic.
|-
| <code>prereqAbilityID</code> || <code>number</code> || Ability id of the prerequisite tactic.
|-
| <code>guildRankPurchasedAt</code> || <code>number</code> || Guild rank at which the tactic was bought; the stock UI treats values above 0 as bought.
|-
| <code>isUpgraded</code> || <code>number</code> || –
|}

== Details ==
* Read the array part with <code>ipairs</code> and the counts by name; both live in the same table.
* <code>isUpgraded</code> is a number, not a boolean.
* If there is no player object, or the Lua state is not available, the function returns nothing.

== Errors ==
None.

== Example ==
Reading the tactic list, from <code>default/ea_guildwindow/source/guildtacticslist.lua</code>:
<pre>
local guildAdvancementData = GetGuildAdvancementData()

if ( guildAdvancementData ~=nil) then
for key, value in ipairs( guildAdvancementData ) do
if (value.abilityID > 0) then
GuildTacticsList.abilityListData[key] = {}
GuildTacticsList.abilityListData[key].abilityID = value.abilityID
GuildTacticsList.abilityListData[key].prereqAbilityID = value.prereqAbilityID
GuildTacticsList.abilityListData[key].guildRankPurchasedAt = value.guildRankPurchasedAt
...
</pre>

Reading a count, from <code>default/ea_guildwindow/source/guildwindowtabbanner.lua</code>:
<pre>
for postNumber = 2, GuildAdvancementData.numberPolesUnlocked do
ComboBoxAddMenuItem( "GWRewardsBannerPostCombo", GetFormatStringFromTable( "guildstrings", StringTables.Guild.TEXT_POST_X, {postNumber} ) )
end
</pre>

== See also ==
* [[API:GuildGetRewards|GuildGetRewards]]
* [[API:GetBannerConfigurationData|GetBannerConfigurationData]]
* [[API:GetGuildTacticsRespecCost|GetGuildTacticsRespecCost]]

API:GetGuildAdvancementData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)