WoW:USERAPI printMSG: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Displays a custom message to the default chat frame, for the user to see.)
 
m (→‎Returns: There is no "null" in Lua.)
Line 14: Line 14:
=== Returns ===
=== Returns ===


:null
:nil
 


== Example ==
== Example ==

Revision as of 13:05, 4 January 2008

This page documents a user-defined function that you can copy and paste into your addon. Replace PREFIX with your addon or lib prefix to avoid conflicts between different versions of these functions.

User defined functions

printMSG - by Bull3t -

Displays a custom message to the default chat frame, for the user to see. A prefix and suffix can also be added, with ease, in the function. This is just to save you from typing out, DEFAULT_CHAT_FRAME:AddMessage("Prefix " .. "Hello world!" .. " Suffix", 1, 1, 1); everytime you want to tell the user something.

<PREFIX>_printMSG("Hello world!");


Function Parameters

Arguments

msg
String - This is the message you wish to display.

Returns

nil

Example

<PREFIX>_printMSG("Hello world!");

Result

Displays the words Prefix Hello world! Suffix, in the default chat frame.


Code

 function <PREFIX>_printMSG(msg)
    DEFAULT_CHAT_FRAME:AddMessage("Prefix " .. msg .. " Suffix", 1, 1, 1);
 end