Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:35Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Dye}}
Returns the colours offered by the dye merchant the player is talking to.

<pre>
dyes = GetDyeMerchantData()
</pre>

== Arguments ==
None.

== Returns ==
;dyes : <code>table</code> – Array of colour tables, indexed from 1, plus a <code>numColors</code> field.

The table has this extra field:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>numColors</code> || <code>number</code> || Number of colours. The stock UI loops from 1 to this value.
|}

Each colour table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>cost</code> || <code>number</code> || Price of the colour, in brass.
|-
| <code>id</code> || <code>number</code> || Position of the colour in the list, starting at 0 (one less than the array index).
|-
| <code>dataIndex</code> || <code>number</code> || – (the stock UI copies it to <code>GameData.DyeMerchant.tintA</code>/<code>tintB</code> before buying).
|-
| <code>paletteIndex</code> || <code>number</code> || Index of the colour in the client's dye palette. Pass it to [[API:DyeMerchantPreview|DyeMerchantPreview]]. The stock UI treats 0 as bleach.
|-
| <code>r</code>, <code>g</code>, <code>b</code> || <code>number</code> || Colour of the palette entry, 0–255 each.
|}

== Details ==
* The data is the dye merchant list the client currently holds. A new table is built on every call.
* <code>numColors</code> is a separate value the client keeps next to the list; it is not counted from the entries. The stock UI relies on it.
* The table can be passed straight to [[API:ColorPickerCreateWithColorTable|ColorPickerCreateWithColorTable]], which reads <code>id</code>, <code>r</code>, <code>g</code> and <code>b</code>.
* If the Lua state is not available, the function returns nothing.

== Errors ==
None.

== Example ==
From <code>default/ea_characterwindow/source/characterwindowdyes.lua</code>:
<pre>
CharacterWindow.dyeColors = GetDyeMerchantData()
CharacterWindow.dyeColorsLookUp = {}
local bleachId = nil
for index = 1, CharacterWindow.dyeColors.numColors
do
if( CharacterWindow.dyeColors[index].paletteIndex == 0 )
then
bleachId = CharacterWindow.dyeColors[index].id
end

CharacterWindow.dyeColorsLookUp[ CharacterWindow.dyeColors[index].paletteIndex ] = CharacterWindow.dyeColors[index]
end

ColorPickerCreateWithColorTable("DyeMerchantColorPicker", CharacterWindow.dyeColors, 5, 10, 10)
</pre>

== See also ==
* [[API:DyeMerchantPreview|DyeMerchantPreview]]
* [[API:DyeMerchantPreviewAll|DyeMerchantPreviewAll]]
* [[API:GetDyeName|GetDyeName]]

API:GetDyeMerchantData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)