Changes: Help:API Function articles/Preload

Revision as of 11:39, 9 June 2010

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.

ru:Справка:Статьи о функциях API/Предварительная загрузка

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
 <!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
 One line summary description of function.
 <!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
  isTrue, retVal1, retVal2 = func("arg1", arg2, ...)
 == Arguments ==
 <!-- List each argument, together with its type -->
+;arg1 : String - description
-:("arg1", arg2)
+;arg2 : Table - description
-:;arg1 : String - description
-:;arg2 : Table - description
 == 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 -->
+;isTrue : Boolean - is it true
-:isTrue, retVal1, retVal2  <!-- remove this line if it's just one value -->
+;retVal1 : String - is it true
-:;isTrue : Boolean - is it true
+;retVal2 : Number - is it true
-:;retVal1 : String - is it true
-:;retVal2 : Number - is it true
 == Triggers Events ==
 <!-- 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
+* {{api|t=e|WHO_LIST_UPDATE}}, when your query has finished processing on the server and new "Who" information is available
 == Example ==
@@ Line 44: / Line 35: @@
 <!-- Details not appropriate for the main description can go here.
      REMOVE the section if you're just going to restate the intro line! -->
 : Does something particularly detailed.
+<noinclude>[[ru:Справка:Статьи о функциях API/Предварительная загрузка]]</noinclude>
-[[Category:Boilerplates|API Function]] <!-- REMOVE THIS LINE WHEN CREATING THE PAGE! -->