Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:42:03Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Dye}}
Shows on the character how one equipped item would look with dye merchant colours.

<pre>
DyeMerchantPreview(location, slot, primaryColor, secondaryColor)
</pre>

== Arguments ==
;location : <code>number</code> – Must be <code>GameData.ItemLocs.EQUIPPED</code>.
;slot : <code>number</code> – Equipment slot of the item.
;primaryColor : <code>number</code> – Palette index for the primary colour (<code>paletteIndex</code> from [[API:GetDyeMerchantData|GetDyeMerchantData]]), or a negative number to keep the item's current primary dye.
;secondaryColor : <code>number</code> – Palette index for the secondary colour, or a negative number to keep the current secondary dye.

== Returns ==
Nothing.

== Details ==
* Nothing happens unless <code>location</code> is <code>EQUIPPED</code>, the slot holds an item, and the item has the <code>GameData.Item.EITEMFLAG_DYE_ABLE</code> flag.
* A colour is only applied to a channel the item's model supports (see [[API:GetDyeTintMasks|GetDyeTintMasks]]), and a colour of 0 is not applied. Only armour slots take a preview.
* The colour values are rounded toward zero.
* This is a preview in the client. Buying the dyes is a separate step. Use [[API:RevertDyePreview|RevertDyePreview]] or [[API:RevertAllDyePreview|RevertAllDyePreview]] to undo it.
* If there is no player object, nothing happens.
* The function needs at least four arguments and only reads the last four.

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

== Example ==
From <code>default/ea_characterwindow/source/characterwindowdyes.lua</code>:
<pre>
function CharacterWindow.PreviewDyes()

if( CharacterWindow.dyeAll )
then
DyeMerchantPreviewAll( CharacterWindow.primaryColor, CharacterWindow.secondaryColor )
elseif( CharacterWindow.selectedDyeSlotName )
then
DyeMerchantPreview( GameData.ItemLocs.EQUIPPED, WindowGetId( CharacterWindow.selectedDyeSlotName ), CharacterWindow.primaryColor, CharacterWindow.secondaryColor )
end
</pre>
The stock UI starts with both colours at -1 (keep current) when the dye merchant opens.

== See also ==
* [[API:DyeMerchantPreviewAll|DyeMerchantPreviewAll]]
* [[API:GetDyeMerchantData|GetDyeMerchantData]]
* [[API:RevertDyePreview|RevertDyePreview]]

API:DyeMerchantPreview - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)