Help:API Function articles

From WoWWiki

Use {{subst: :Help:API Function articles/Preload}} to import this boilerplate into a page. Do not copy the source of this article. The boilerplate itself is contained on Help:API Function articles/Preload.

---

One line summary description of function.

isTrue, retVal1, retVal2 = func("arg1", arg2, ...)

Arguments

("arg1", arg2)

arg1 

String - description

arg2 

Table - description

Returns

isTrue, retVal1, retVal2

isTrue 

Boolean - is it true

retVal1 

String - is it true

retVal2 

Number - is it true

Triggers Events

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

Example

local a, b, c = func("hi", {1,2,3} )

Result

a = "hi "
b = "hi hi"
c = "hi hi hi"

Details

Does something particularly detailed.