Help:Widget method articles: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Removed Parameters header and fixed some whitespaces)
 
Line 1: Line 1:
{{widgetmethod}} __NOTOC__
{{widgetmethod|WidgetName}}
 


<!-- 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 -->
Line 37: Line 36:


== Details ==
== Details ==
<!-- 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.


== Also See ==
: Does something particularly detailed. <!-- Details not appropriate for the main description can go here.
    DO NOT REMOVE this section. If you're just going to restate the intro line, then dont, leave it blank -->


* [[UIOBJECT WidgetName|WidgetName information]]
== See also ==
* [[UISUMMARY WidgetName|WidgetName summary]]


* [[UIOBJECT OtherRelatedWidget|OtherRelatedWidget]] <!-- REMOVE THIS SUGGESTIVE ITEM, BUT LEAVE THIS 'SEE ALSO' SECTION FOR
    FUTURE TRAVELERS. It is extremly important to place siginificant refrences outside this article here --> 


[[Category:Boilerplates|Widget Method]] <!-- REMOVE THIS CATEGORIZATION WHEN YOU USE THE BOILERPLATE TO CREATE A NEW PAGE! -->
[[Category:Boilerplates|Widget Method]] <!-- REMOVE THIS CATEGORIZATION WHEN YOU USE THE BOILERPLATE TO CREATE A NEW PAGE!  
  The widgetmethod template also takes care of widget categories -->

Latest revision as of 19:05, 17 September 2013

Widget API ← Widget

One line summary description of function.

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


Arguments[edit]

("arg1", arg2)
arg1
String - description
arg2
Table - description

Returns[edit]

isTrue, retVal1, retVal2
isTrue
Boolean - is it true
retVal1
String - is it true
retVal2
Number - is it true


Example[edit]

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

Result[edit]

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


Details[edit]

Does something particularly detailed.

See also[edit]