API:GetDyeName

UI Lua API · Dye functions
Version: WAR 1.4.8

Returns the name of a colour in the client's dye palette.

name = GetDyeName(paletteIndex)

Arguments

paletteIndex

number – Index into the dye palette, such as the paletteIndex field from GetDyeMerchantData or the dyeTintA/dyeTintB fields of an item.

Returns

name

string – 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:

local name = GetDyeName( itemData.dyeTintA )

See also

• GetDyeMerchantData
• GetDyeTintMasks