ColorMixin:WrapTextInColorCode()

Main Menu
WoW API Lua API FrameXML util Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

→ FrameXML Funcs

→ FrameXML Docs

These functions are implemented in :WrapTextInColorCode FrameXML/Util.lua.

Wraps a string with |cffRRGGBB and |r escape sequences.

wrappedText = WrapTextInColorCode(text, colorHexString)
wrappedText = color:WrapTextInColorCode(text)

Arguments

text

string - The text to wrap

colorHexString

string - ff followed by six hexadecimal digits as RRGGBB like the return from ColorMixin:GenerateHexColor().

Returns

wrappedText

string - |cffRRGGBBtext|r with the appropriate values inserted for RR, GG, BB and text.

Details

• Operates as a standalone function with two arguments, or as a method of ColorMixin with one argument.

Example

print("Did someone say " .. WrapTextInColorCode("yellow", "ffffff00") .. "?")   -- Did someone say yellow?

Patch changes

• Patch 7.1.0 (2016-10-25): Added as a standalone function.
  
• Patch 7.0.3 (2016-07-19): Added as a method of ColorMixin.