WoW:API ScrollingMessageFrame AddMessage: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Move page script moved page API ScrollingMessageFrame AddMessage to API ScrollingMessageFrame AddMessage without leaving a redirect) |
||
| (9 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
{{widgetmethod}} | |||
Outputs text to a local MessageFrame, with optional color id. | Outputs text to a local MessageFrame, with optional color id.- Updated in 2.4.2 | ||
MessageFrame:AddMessage(text[,r,g,b[,id]]); | MessageFrame:AddMessage(text[,r,g,b[,id][,addToStart]]); | ||
== Parameters == | |||
=== Arguments === | |||
:(String text, Number red, Number green, Number blue, Number id, Boolean addToStart) | |||
:(String text, Number red, Number green, Number blue, Number id) | |||
:;text : The string message to output | :;text : The string message to output | ||
| Line 16: | Line 15: | ||
:;b : The intensity of the blue 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 | :;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_GLOBAL: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== | ==Escape Sequences== | ||
It is possible to control the text in the MessageFrame with escape sequences in text | It is also possible to control the text of parts of lines in the MessageFrame with escape sequences in text. | ||
===Set | <div style="margin-left:3%;"> | ||
===Set color=== | |||
Syntax: | Syntax: | ||
| | '''|c'''AARRGGBB colored text | ||
Example: | Example: | ||
| | '''|c'''FFFF0000This Will Be In Red | ||
=== | ===Reset color=== | ||
Syntax: | Syntax: | ||
|cAARRGGBB colored text |r uncolored text | |cAARRGGBB colored text '''|r''' uncolored text | ||
Example: | Example: | ||
|cFF00FF00In Green| | |cFF00FF00In Green'''|r'''Default Color | ||
</div> | |||
==See also== | |||
*[[UI Escape Sequences]] | |||
Latest revision as of 04:47, 15 August 2023
← 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[edit]
Arguments[edit]
- (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[edit]
- nil
Example[edit]
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_GLOBAL: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[edit]
It is also possible to control the text of parts of lines in the MessageFrame with escape sequences in text.
Set color[edit]
Syntax:
|cAARRGGBB colored text
Example:
|cFFFF0000This Will Be In Red
Reset color[edit]
Syntax:
|cAARRGGBB colored text |r uncolored text
Example:
|cFF00FF00In Green|rDefault Color