WoW:API print: Difference between revisions

Latest revision as of 04:47, 15 August 2023

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < print

This function is implemented in Lua here RestrictedEnvironment.lua.

Passes its arguments to the current print output handler. By default, this will output them all to the default chat frame.

print(...)

Arguments

...: Any - any number of any type of values.

Example

print("Hello, WoW!")

prints Hello, WoW!

print("Hello", "this is a", nil, "value")

(note that "nil" is not in double quotes)

prints Hello this is a nil value

print("Hello", "this is a"..nil, "value")

Throws the error, "attempt to concatenate a nil value"

print("Hello", "this is a", {}, "value")

prints Hello this is a table: ###### value

Details

This function is a securecall/forceinsecure wrapper around the current print output handler function. Instead of attempting to replace it, you can set your own output handler function using setprinthandler(func).
This function serves as a cleaner replacement from DEFAULT_CHAT_FRAME:AddMessage(); unlike which, it can safely be used to output nil values.

History

Added in 3.0.2 (8926)

@@ Line 1: / Line 1: @@
-{{wowapi}}
+{{framexmlfunc|RestrictedEnvironment.lua}}
-Takes any number of arguments and prints their values to the default chat frame using the [[API tostring|tostring()]] function
+Passes its arguments to the current print output handler. By default, this will output them all to the default chat frame.
-  print("Hello, WoW!")
+  print(...)
-== Parameters ==
-=== Arguments ===
-:("arg1"[, "argN"])
-:;arg1 : object to print
+== Arguments ==
-:;argN : object to print, separated by a space from the previous object.
+; ... : Any - any number of any type of values.
-=== Returns ===
-:;nil
 == Example ==
@@ Line 28: / Line 20: @@
   print("Hello", "this is a", {}, "value")
 prints <code>Hello this is a table: ###### value</code>
 == Details ==
-This function serves as a cleaner replacement from DEFAULT_CHAT_FRAME:AddMessage().
+* This function is a securecall/forceinsecure wrapper around the current print output handler function. Instead of attempting to replace it, you can set your own output handler function using {{api|setprinthandler}}(func).
+* This function serves as a cleaner replacement from DEFAULT_CHAT_FRAME:AddMessage(); unlike which, it can safely be used to output nil values.
-Each argument given is printed separated by a space from the previous one.
-Unlike DEFAULT_CHAT_FRAME:AddMessage(), '''print()''' will allow the output nil values to the chat frame without causing an error message.
-'''print()''' was added in 3.0.2 (8926)
+== History ==
+* Added in 3.0.2 (8926)