Help:Widget method articles: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (fix cat)
(Removed Parameters header and fixed some whitespaces)
Line 9: Line 9:




== Parameters ==
== Arguments ==
=== Arguments ===
<!-- List each argument, together with its type -->
<!-- List each argument, together with its type -->
:("arg1", arg2)
:("arg1", arg2)
Line 17: Line 16:
:;arg2 : Table - description
:;arg2 : Table - description


=== Returns ===
== Returns ==
<!-- 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 -->
:isTrue, retVal1, retVal2  <!-- remove this line if it's just one value -->
Line 37: Line 36:




==Details==
== Details ==
<!-- 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! -->
Line 44: Line 43:




==Also See==
== Also See ==


* [[UIOBJECT WidgetName|WidgetName information]]
* [[UIOBJECT WidgetName|WidgetName information]]

Revision as of 11:14, 2 May 2007

Widget API ← Widget


One line summary description of function.

isTrue, retVal1, retVal2 = WidgetName: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


Example

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

Result

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


Details

Does something particularly detailed.


Also See