https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetHeraldryBestOptionsAPI:GetHeraldryBestOptions - Revision history2026-10-18T04:53:44ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetHeraldryBestOptions&diff=30400&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:43:56Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Guild}}<br />
Returns the heraldry emblems, patterns and colours available for a race filter and banner shape.<br />
<br />
<pre><br />
options = GetHeraldryBestOptions(filterId, shape)<br />
</pre><br />
<br />
== Arguments ==<br />
;filterId : <code>number</code> – Race filter. The stock heraldry editor uses 20 (all Destruction), 21 (Chaos), 22 (Dark Elf), 23 (Greenskin), 30 (all Order), 31 (Dwarf), 32 (Empire), 33 (High Elf).<br />
;shape : <code>number</code> – Banner shape. Only patterns for this shape are returned.<br />
<br />
== Returns ==<br />
;options : <code>table</code> – A table with three arrays, each indexed from 1.<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>emblemList</code> || <code>table</code> || Array of emblem ids (<code>number</code>).<br />
|-<br />
| <code>patternList</code> || <code>table</code> || Array of pattern ids (<code>number</code>) for the given shape.<br />
|-<br />
| <code>colorList</code> || <code>table</code> || Array of colour ids (<code>number</code>).<br />
|}<br />
<br />
== Details ==<br />
* Each "all" filter (20, 30) returns the union of the three race filters of that realm.<br />
* Any other <code>filterId</code> matches no race group.<br />
* The lists come from the client's heraldry data; the server is not contacted.<br />
* If there is no player object, or the Lua state is not available, the function returns nothing.<br />
* The function needs at least two arguments and only reads the last two.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when an argument is not a number.<br />
<br />
== Example ==<br />
From <code>default/ea_guildwindow/source/heraldryeditor.lua</code>:<br />
<pre><br />
HeraldryEditor.BestOptionsFiltered = GetHeraldryBestOptions(filterID, HeraldryEditor.CurrentShapeChoice)<br />
<br />
HeraldryEditor.MaxPatternChoices = #HeraldryEditor.BestOptionsFiltered.patternList<br />
HeraldryEditor.MaxEmblemChoices = #HeraldryEditor.BestOptionsFiltered.emblemList<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GetHeraldryConfigurationData|GetHeraldryConfigurationData]]<br />
* [[API:SendHeraldryConfigurationData|SendHeraldryConfigurationData]]</div>Maintenance script