Changes: API MessageFrame AddMessage

Revision as of 15:06, 27 February 2010

Outputs text to a MessageFrame in the specified color, for a specified amount of time.

MessageFrame:AddMessage("text", red, green, blue, messageId, holdTime);

Arguments

(String text, Number red, Number green, Number blue, Number messageId, Number holdTime)

text: The message to output
red: The intensity of the red component. A clamped float between 0.0 and 1.0
green: The intensity of the green component. A clamped float between 0.0 and 1.0
blue: The intensity of the blue component. A clamped float between 0.0 and 1.0
messageId: A user-defined number that specifies which "color group" this message fits into. See the list of system-defined symbolic names. GetChatTypeIndex can be used to turn a symbolic name into an integer index.
holdTime: length of time before the message fades out from the frame, in seconds

Returns

nil

Example

UIErrorsFrame:AddMessage("Testing", 1.0, 0.0, 0.0, 53, 5);

Result

Testing -- in red, fades out after 5 seconds, in message group 53

Description

Any of the parameters after text are optional. The hold time should also be set however, otherwise the message will remain within the ScrollingMessageFrame until it is scrolled up past the lines specified in the frame, or until you exit the game.

If you call UpdateChatColor with messageId as an argument, you can change the color of a chat message dynamically.

@@ Line 1: / Line 1: @@
+{{widgetmethod}}
- <center>'''AddMessage''' ''-Documentation by Jason Citron, Additions by Dan Yankowsky-''</center>
-Outputs text to a local frame in the specified color.
+Outputs text to a MessageFrame in the specified color, for a specified amount of time.
- AddMessage(text, red, green, blue, alpha, holdTime);
+ MessageFrame:AddMessage("text", red, green, blue, messageId, holdTime);
 ----
 ;''Arguments''
-:(String text, Number red, Number green, Number blue, Number alpha, Number holdTime)
+:(String text, Number red, Number green, Number blue, Number messageId, Number holdTime)
 :;text : The message to output
-:;red : The intensity of the red component. A number between 0.0 and 1.0
+:;red : The intensity of the red component. A clamped float between 0.0 and 1.0
-:;green : The intensity of the green component. A number between 0.0 and 1.0
+:;green : The intensity of the green component. A clamped float between 0.0 and 1.0
-:;blue : The intensity of the blue component. A number between 0.0 and 1.0
+:;blue : The intensity of the blue component. A clamped float between 0.0 and 1.0
+:;messageId : A user-defined number that specifies which "color group" this message fits into. See the [[ChatTypeInfo|list of system-defined symbolic names]]. [[API GetChatTypeIndex|GetChatTypeIndex]] can be used to turn a symbolic name into an integer index.
-:;alpha : The opacity of the text. A number between 0.0 and 1.0
-:;holdTime : Time in seconds before the message fades.
+:;holdTime : length of time before the message fades out from the frame, in seconds
 ----
@@ Line 24: / Line 24: @@
 ----
 ;''Example''
- AddMessage("Testing", 1.0, 0.0, 0.0, 1.0, 5);
+ UIErrorsFrame:AddMessage("Testing", 1.0, 0.0, 0.0, 53, 5);
 ;''Result''
- Testing -- in red
+ Testing -- in red, fades out after 5 seconds, in message group 53
 ----
+;''Description''
-==Escape Sequences==
-It is possible to control the text in the MessageFrame with escape sequences in text
+Any of the parameters after text are optional. The hold time should also be set however, otherwise the message will remain within the ScrollingMessageFrame until it is scrolled up past the lines specified in the frame, or until you exit the game.
-===Set Color===
-Syntax:
- |cAARRGGBB  colored text
-Example:
- |cFFFF0000This Will Be In Red
+If you call UpdateChatColor with messageId as an argument, you can change the color of a chat message dynamically.
-===Remove Color===
-Syntax:
- |cAARRGGBB  colored text  |r  uncolored text
-Example:
- |cFF00FF00In Green|rDefault Color
-----
-{{Template:WoW API}}