WoW:API MessageFrame AddMessage: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
({{widgetmethod}})
Line 1: Line 1:
{{widgetmethod}}
  <center>'''MessageFrame:AddMessage''' ''-Documentation by Jason Citron, Additions by Dan Yankowsky, Fixes by Beladona-''</center><br/><br/>
  <center>'''MessageFrame:AddMessage''' ''-Documentation by Jason Citron, Additions by Dan Yankowsky, Fixes by Beladona-''</center><br/><br/>


Line 34: Line 36:


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.
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.
----
{{Template:WoW API}}

Revision as of 12:15, 10 June 2006

Widget API ← MessageFrame < AddMessage

MessageFrame:AddMessage -Documentation by Jason Citron, Additions by Dan Yankowsky, Fixes by Beladona-




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

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

Arguments
(String text, Number red, Number green, Number blue, Number alpha, 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
alpha
The level of alpha opacity. A clamped float between 0.0 and 1.0
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, 1.0, 5);
Result
Testing -- in red, fades out after 5 seconds

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.