Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:48:42Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Guild}}
Sends a new heraldry design for the player's guild to the server.

<pre>
SendHeraldryConfigurationData(emblemId, patternId, primaryColor, secondaryColor, shape)
</pre>

== Arguments ==
;emblemId : <code>number</code> – Emblem id. Sent as a 16-bit value.
;patternId : <code>number</code> – Pattern id. Sent as a 16-bit value.
;primaryColor : <code>number</code> – Primary (base) colour id. Sent as an 8-bit value.
;secondaryColor : <code>number</code> – Secondary (pattern) colour id. Sent as an 8-bit value.
;shape : <code>number</code> – Banner shape. Sent as an 8-bit value.

== Returns ==
Nothing.

== Details ==
* The values are sent to the server together with the player's character id. The client does not check permissions or cost. The stock heraldry editor first shows a confirmation dialog with the cost from [[API:GetHeraldryCost|GetHeraldryCost]].
* If there is no player object, or the Lua state is not available, nothing is sent.
* The function needs at least five arguments and only reads the last five.

== Errors ==
None besides the generic ''Invalid Parameters'' message when an argument is not a number.

== Example ==
From <code>default/ea_guildwindow/source/heraldryeditor.lua</code>:
<pre>
-- Params must match those expected in war_interface::LuaSendHeraldryConfigurationData.
SendHeraldryConfigurationData(HeraldryEditor.CurrentEmblemID,
HeraldryEditor.CurrentPatternID,
HeraldryEditor.CustomColors[HeraldryEditor.COLOR_CHOICE_BASE],
HeraldryEditor.CustomColors[HeraldryEditor.COLOR_CHOICE_PATTERN],
HeraldryEditor.CurrentShapeChoice)
</pre>

== See also ==
* [[API:GetHeraldryConfigurationData|GetHeraldryConfigurationData]]
* [[API:GetHeraldryCost|GetHeraldryCost]]
* [[API:SetGuildHeraldryScene|SetGuildHeraldryScene]]

API:SendHeraldryConfigurationData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)