Help:API Function articles

From Wowpedia
Jump to: navigation, search






One line summary description of function.

isTrue, retVal1, retVal2, retVal3 = {{subst:Help:API Function articles/Preload/Name}}("arg1", arg2, arg3, arg4, ...)

Arguments

arg1 
String - description.
arg2 
Table - description.
arg3 
Number - description.
arg4 
Boolean - description.

Returns

isTrue, retVal1, retVal2, retVal3
isTrue 
Boolean - true if the sky is blue, false otherwise.
retVal1 
String - name of something or someone.
retVal2 
Number - amount of something.
retVal3 
Flag - 1 if something, nil otherwise.

Triggers Events

  • WHO_LIST_UPDATE, when your query has finished processing on the server and new "Who" information is available

Example

The following snippet does something clever and insightful.

local a, b, c = func("hi", {1,2,3} )
if a > 20 and b < 20 and a^20 + b^20 = c^20 then
 print("Stuff!")
end

Details

  • Does something particularly detailed.

Patch changes

See also