https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ASetGuildHeraldrySceneAPI:SetGuildHeraldryScene - Revision history2026-10-18T06:58:39ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:SetGuildHeraldryScene&diff=30720&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:49:01Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Guild}}<br />
Updates the guild heraldry preview, and optionally the guild standard preview, with a heraldry design.<br />
<br />
<pre><br />
SetGuildHeraldryScene(patternId, primaryColor, secondaryColor, emblemId, postNumber, updateStandard)<br />
</pre><br />
<br />
== Arguments ==<br />
;patternId : <code>number</code> – Pattern id. Stored as a 16-bit value.<br />
;primaryColor : <code>number</code> – Primary (base) colour id. Stored as an 8-bit value.<br />
;secondaryColor : <code>number</code> – Secondary (pattern) colour id. Stored as an 8-bit value.<br />
;emblemId : <code>number</code> – Emblem id. Stored as a 16-bit value.<br />
;postNumber : <code>number</code> – Banner post number. Stored as an 8-bit value.<br />
;updateStandard : <code>boolean</code> – <code>true</code> to apply the design to the guild standard preview as well.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* The heraldry preview is updated whenever it exists. The guild standard preview is updated only when it exists and <code>updateStandard</code> is <code>true</code>.<br />
* This only changes the client-side previews. To save a design, the stock heraldry editor uses [[API:SendHeraldryConfigurationData|SendHeraldryConfigurationData]].<br />
* <code>updateStandard</code> must be a real boolean.<br />
* The function needs at least six arguments and only reads the last six.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when an argument has the wrong type.<br />
<br />
== Example ==<br />
From <code>default/ea_guildwindow/source/heraldryeditor.lua</code>:<br />
<pre><br />
-- Pattern, Primary Color, Secondary Color, Emblem, bUpdateStandard<br />
SetGuildHeraldryScene(<br />
HeraldryEditor.CurrentPatternID,<br />
HeraldryEditor.CustomColors[HeraldryEditor.COLOR_CHOICE_BASE],<br />
HeraldryEditor.CustomColors[HeraldryEditor.COLOR_CHOICE_PATTERN],<br />
HeraldryEditor.CurrentEmblemID,<br />
GuildWindowTabBanner.CurrentPostNumber,<br />
bUpdateStandard)<br />
</pre><br />
<br />
== See also ==<br />
* [[API:SetGuildStandardScene|SetGuildStandardScene]]<br />
* [[API:GetHeraldryConfigurationData|GetHeraldryConfigurationData]]<br />
* [[API:SendHeraldryConfigurationData|SendHeraldryConfigurationData]]</div>Maintenance script