API:SendHeraldryConfigurationData
From RoR Wiki
UI Lua API · Guild functions
Version: WAR 1.4.8
Sends a new heraldry design for the player's guild to the server.
SendHeraldryConfigurationData(emblemId, patternId, primaryColor, secondaryColor, shape)
Arguments
- emblemId
number– Emblem id. Sent as a 16-bit value.- patternId
number– Pattern id. Sent as a 16-bit value.- primaryColor
number– Primary (base) colour id. Sent as an 8-bit value.- secondaryColor
number– Secondary (pattern) colour id. Sent as an 8-bit value.- shape
number– 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 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 default/ea_guildwindow/source/heraldryeditor.lua:
-- 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)