https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetHeraldryConfigurationData 2026-10-17T13:43:49Z Revision history for this page on the wiki MediaWiki 1.43.11 https://wiki.returnofreckoning.com/index.php?title=API:GetHeraldryConfigurationData&diff=30401&oldid=prev 2026-10-16T19:43:57Z

<p>UI Lua API import (WAR 1.4.8)</p> <p><b>New page</b></p><div>{{LuaApi|group=Guild}}<br /> Returns the current heraldry of the player&#039;s guild.<br /> <br /> &lt;pre&gt;<br /> heraldry = GetHeraldryConfigurationData()<br /> &lt;/pre&gt;<br /> <br /> == Arguments ==<br /> None.<br /> <br /> == Returns ==<br /> ;heraldry : &lt;code&gt;table&lt;/code&gt; – The guild&#039;s heraldry.<br /> <br /> {| class=&quot;wikitable&quot;<br /> ! Key !! Type !! Meaning<br /> |-<br /> | &lt;code&gt;emblemIcon&lt;/code&gt; || &lt;code&gt;number&lt;/code&gt; || Emblem id.<br /> |-<br /> | &lt;code&gt;backgroundPattern&lt;/code&gt; || &lt;code&gt;number&lt;/code&gt; || Pattern id.<br /> |-<br /> | &lt;code&gt;primaryColorID&lt;/code&gt; || &lt;code&gt;number&lt;/code&gt; || Primary (base) colour id.<br /> |-<br /> | &lt;code&gt;secondaryColorID&lt;/code&gt; || &lt;code&gt;number&lt;/code&gt; || Secondary (pattern) colour id.<br /> |-<br /> | &lt;code&gt;shape&lt;/code&gt; || &lt;code&gt;number&lt;/code&gt; || Banner shape.<br /> |-<br /> | &lt;code&gt;reserved&lt;/code&gt; || &lt;code&gt;number&lt;/code&gt; || Reservation state, compared with &lt;code&gt;SystemData.GuildHeraldryReservation&lt;/code&gt; values (&lt;code&gt;LOCKED&lt;/code&gt;, &lt;code&gt;RESET_AVAILABLE&lt;/code&gt;).<br /> |}<br /> <br /> == Details ==<br /> * The stock heraldry editor also reads &lt;code&gt;heraldry.post&lt;/code&gt;. The client does not set that field, so it is always &lt;code&gt;nil&lt;/code&gt;.<br /> * If there is no player object, or the Lua state is not available, the function returns nothing.<br /> <br /> == Errors ==<br /> None.<br /> <br /> == Example ==<br /> From &lt;code&gt;default/ea_guildwindow/source/heraldryeditor.lua&lt;/code&gt;:<br /> &lt;pre&gt;<br /> local heraldryData = GetHeraldryConfigurationData()<br /> ...<br /> HeraldryEditor.CurrentShapeChoice = heraldryData.shape<br /> HeraldryEditor.BestOptionsFiltered = GetHeraldryBestOptions(filterID, HeraldryEditor.CurrentShapeChoice)<br /> HeraldryEditor.CurrentPatternIndex = HeraldryEditor.GetPatternIndexFromPatternID(heraldryData.backgroundPattern)<br /> HeraldryEditor.CurrentEmblemIndex = HeraldryEditor.GetEmblemIndexFromEmblemID(heraldryData.emblemIcon)<br /> HeraldryEditor.CustomColors[HeraldryEditor.COLOR_CHOICE_BASE] = heraldryData.primaryColorID<br /> HeraldryEditor.CustomColors[HeraldryEditor.COLOR_CHOICE_PATTERN] = heraldryData.secondaryColorID<br /> &lt;/pre&gt;<br /> <br /> == See also ==<br /> * [[API:SendHeraldryConfigurationData|SendHeraldryConfigurationData]]<br /> * [[API:GetHeraldryBestOptions|GetHeraldryBestOptions]]<br /> * [[API:ResetGuildHeraldry|ResetGuildHeraldry]]</div>

Maintenance script