Widget API: GameTooltip:SetText

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ Methods

← Widget API ← GameTooltip < SetText

SetText("text"[, red, green, blue[, alpha[, textWrap]]])

Sets the text of the tooltip.

Arguments

"text"

string - The text of the new tooltip. Variable can be used inplace of a string.

red

Optional - number range 0 to 1 - red color value for text string

green

Optional - number range 0 to 1 - green color value for text string

blue

Optional - number range 0 to 1 - blue color value for text string

alpha

Optional - number range 0 to 1 - specifies the opacity of text. Default is 1.

textWrap

Optional - boolean - 'true' to wrap the text string to fit the tooltip box. Default is 'false'.

Returns

none

Example

GameTooltip:SetText("This is my awesome tooltip!", 0.5, 0.5, 0.5, 0.75, 1)

Would result in a semi transparent, greyish colored tooltip that would probably be wrapped to a second line due to the textWrap flag and its length.

Details

When using the flag the tooltip width is set at a preset size (about the size of the ability tooltips on spells.). Long tooltips will go off the side of the screen if this is not set. Alternatively you can simply use a "\n" in the "text" arg to force a new line.

If optional parameters are not specified the text defaults to Gold color, Full Opaque, and NON-wrapped.