Widget API: MessageFrame:AddMessage

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 ← MessageFrame < AddMessage

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

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.