Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:36Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Dye}}
Returns the name of a colour in the client's dye palette.

<pre>
name = GetDyeName(paletteIndex)
</pre>

== Arguments ==
;paletteIndex : <code>number</code> – Index into the dye palette, such as the <code>paletteIndex</code> field from [[API:GetDyeMerchantData|GetDyeMerchantData]] or the <code>dyeTintA</code>/<code>dyeTintB</code> fields of an item.

== Returns ==
;name : <code>string</code> – The name stored in the client's palette entry for that index, as a plain (not wide) string.

== Details ==
* If the argument check fails, nothing is returned.
* Exactly one argument must be passed.
* The stock UI never calls this function.

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

== Example ==
A minimal call built from the signature above:
<pre>
local name = GetDyeName( itemData.dyeTintA )
</pre>

== See also ==
* [[API:GetDyeMerchantData|GetDyeMerchantData]]
* [[API:GetDyeTintMasks|GetDyeTintMasks]]

API:GetDyeName - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)