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__
- <center>'''Title''' ''-Documentation by [[user:Author|Author]]-''</center>
+<!-- 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 ==
-Short description
+<!-- List each argument, together with its type -->
+;arg1 : String - description
+;arg2 : Table - description
+== Returns ==
- func(arg1, arg2, ...);
+: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
+;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. -->
-;''Arguments''
+* {{api|t=e|WHO_LIST_UPDATE}}, when your query has finished processing on the server and new "Who" information is available
+== Example ==
-:(String arg1, Table arg2)
+<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
+ local a, b, c = func("hi", {1,2,3} )
+<big>'''Result'''</big>
-:;arg1 : description
+<!-- If it helps, include example results here, though they are not required. You're allowed to cheat liberally since WoW isn't a command line language. -->
-:;arg2 : description
+ a = "hi "
+ b = "hi hi"
+ c = "hi hi hi"
-----
-;''Returns''
+== Details ==
-:isTrue, retVal2, retVal3
+<!-- Details not appropriate for the main description can go here.
-:;isTrue : is it true
+     REMOVE the section if you're just going to restate the intro line! -->
+: Does something particularly detailed.
-----
+<noinclude>[[ru:Справка:Статьи о функциях API/Предварительная загрузка]]</noinclude>
-;''Example''
- func("hi", {1,2,3} );
-;''Result''
- hi
- hi hi
- hi hi hi
-----
-;''Description''
-: Does something
-----
-{{Template:WoW API}}