Kirkburn31335@legacy41551592 (talk | contribs) mNo edit summary |
(outdent some of the lists, make some of the repetition less required.) |
||
| Line 1: | Line 1: | ||
{{wowapi}} __NOTOC__ |
{{wowapi}} __NOTOC__ |
||
| − | |||
<!-- Describe the purpose of the function, exhausting detail can be saved for a later section --> |
<!-- Describe the purpose of the function, exhausting detail can be saved for a later section --> |
||
One line summary description of function. |
One line summary description of function. |
||
| Line 9: | Line 8: | ||
== Arguments == |
== Arguments == |
||
<!-- List each argument, together with its type --> |
<!-- List each argument, together with its type --> |
||
| ⚫ | |||
| − | :("arg1", arg2) |
||
| ⚫ | |||
| − | |||
| ⚫ | |||
| ⚫ | |||
| − | |||
== Returns == |
== Returns == |
||
| + | :isTrue, retVal1, retVal2 <!-- Include this line ONLY IF there are multiple return values and a large number of arguments --> |
||
<!-- List each return value, together with its type --> |
<!-- List each return value, together with its type --> |
||
| ⚫ | |||
| − | :isTrue, retVal1, retVal2 <!-- remove this line if it's just one value --> |
||
| ⚫ | |||
| − | |||
| − | + | ;retVal2 : Number - is it true |
|
| ⚫ | |||
| ⚫ | |||
== Triggers Events == |
== Triggers Events == |
||
<!-- If this function triggers an event, name it here. If not, remove the entire section. --> |
<!-- If this function triggers an event, name it here. If not, remove the entire section. --> |
||
| − | + | * "[[Events/W#WHO_LIST_UPDATE|WHO_LIST_UPDATE]]", when your query has finished processing on the server and new "Who" information is available |
|
| Line 43: | Line 38: | ||
<!-- Details not appropriate for the main description can go here. |
<!-- Details not appropriate for the main description can go here. |
||
REMOVE the section if you're just going to restate the intro line! --> |
REMOVE the section if you're just going to restate the intro line! --> |
||
| − | |||
: Does something particularly detailed. |
: Does something particularly detailed. |
||
Revision as of 01:49, 12 August 2009
 |
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards. |
One line summary description of function.
isTrue, retVal1, retVal2 = func("arg1", arg2, ...)
Arguments
- 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.