Widget API: ScrollingMessageFrame:AddMessage

From AddOn Studio
Revision as of 23:09, 16 May 2008 by WoWWiki>Saiket (Added addToStart argument from 2.4.2 - unsure of argument name.)
Jump to navigation Jump to search

Widget API ← ScrollingMessageFrame < AddMessage

Outputs text to a local MessageFrame, with optional color id.- Updated in 2.4.2

MessageFrame:AddMessage(text[,r,g,b[,id][,addToStart]]);

Parameters

Arguments

(String text, Number red, Number green, Number blue, Number id, Boolean addToStart)
text
The string message to output
r
The intensity of the red component. A number between 0.0 and 1.0
g
The intensity of the green component. A number between 0.0 and 1.0
b
The intensity of the blue component. A number between 0.0 and 1.0
id
A number that classifies the line of text, for later changing the color
addToStart
Boolean - Set to true to add the message to the start of the MessageFrame as if it was the first printed message - New in 2.4.2.

Returns

nil


Example

DEFAULT_CHAT_FRAME:AddMessage("Testing", 1.0, 0.0, 0.0);

Outputs "Testing" on a single line in your default chat window -- in red.

DEFAULT_CHAT_FRAME:AddMessage("AddOn Loaded!", 0.0, 1.0, 0.0, nil, true);

Outputs "AddOn Loaded!" at the start of your default chat window -- in green.

Escape Sequences

It is also possible to control the text of parts of lines in the MessageFrame with escape sequences in text.

Set color

Syntax:

|cAARRGGBB  colored text  

Example:

|cFFFF0000This Will Be In Red

Reset color

Syntax:

|cAARRGGBB  colored text  |r  uncolored text

Example:

|cFF00FF00In Green|rDefault Color

Template:AlsoSee