Widget API: GameTooltip:AddLine

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 < AddLine

GameTooltip:AddLine(text [, red, green, blue [, wrapText]]);

Appends a line of text to tooltip.

Arguments

text

string - text which will appear in new tooltip line

red

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

green

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

blue

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

wrapText

boolean - 'true' to wrap text.

Returns

none

Examples

MyTooltip:SetOwner(TargetFrame, "ANCHOR_RIGHT")
MyTooltip:AddLine("New tooltip line", 1, 1, 1)
MyTooltip:Show()

Details

Note that this only appends the new line to the tooltip. It does not update the tooltip's height/width, so that the newly added line initially appears underneath (outside of) the tooltip.

A subsequent call to GameTooltip:Show() will update the tooltip's borders correctly.

Notes

• As of WoW 2.0, there is no longer a maximum number of lines.
• As of 6.0 uses Lua boolean, rather than WoW Boolean (nil or 1) for wrap text setting.