WoW:API message: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Added information about cvar "scriptErrors")
m (Move page script moved page API message to API message without leaving a redirect)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{framexmlfunc|FrameXML/BasicControls.xml}} __NOTOC__
{{framexmlfunc|FrameXML/BasicControls.xml}}
 
 
message("text");
 
Displays a message box.
Displays a message box.
message("text")


 
== Arguments ==
== Parameters ==
;text : String - message to be displayed.
=== Arguments ===
:("text")
 
:;text : String - message to be displayed.
 
=== Returns ===
:;nil
 
 
== Example ==
message("This is an example.");
 


==Details==
==Details==
: Pops up a message box displaying the argument with an "Okay" button inside a frame.
* Pops up a message box displaying the argument with an "Okay" button inside a frame.
 
* As of 3.1, message() is no longer an alias of the [[API ERRORMESSAGE|_ERRORMESSAGE]] function. It is a standalone function that bypasses the cvar "scriptErrors" entirely and always displays an error box.
: (?) As of 1.10, message("text") no longer seems to work inside instances under certain conditions.  The fix for this is currently unknown.
* As of 3.2 message() is broken / Depreciated as the message frame is no longer defined. Suitable alternative is {{api|print}}(...);
 
: As of 2.1, the cvar "scriptErrors" must be set to 1 for this to work.  This can be accomplished through a call to [[API SetCVar |SetCVar]]().
 
: This is just an alias of the [[API ERRORMESSAGE|_ERRORMESSAGE]] function.

Latest revision as of 04:46, 15 August 2023

WoW API < message

"I" iconThis function is implemented in Lua here FrameXML/BasicControls.xml.

Displays a message box.

message("text")

Arguments[edit]

text
String - message to be displayed.

Details[edit]

  • Pops up a message box displaying the argument with an "Okay" button inside a frame.
  • As of 3.1, message() is no longer an alias of the _ERRORMESSAGE function. It is a standalone function that bypasses the cvar "scriptErrors" entirely and always displays an error box.
  • As of 3.2 message() is broken / Depreciated as the message frame is no longer defined. Suitable alternative is print(...);