Functions
From UBot Studio
(Difference between revisions)
(→Properties) |
|||
| (2 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | Creates a new function object. | |
| − | |||
| + | == Properties == | ||
| + | |||
| + | ====userLevel==== | ||
| + | Determines which edition of UBot Studio can use this function | ||
| + | |||
| + | ====category==== | ||
| + | Determines which toolbox category this will go in | ||
| + | |||
| + | ====logic==== | ||
| + | This property should be set to the function that will run when the function is run within a script | ||
| + | |||
| + | ====generateChildren==== | ||
| + | If this is a container function, you can use this delegate function to add children automatically | ||
| + | |||
| + | ====toolTip==== | ||
| + | The tooltip that appears when the user mouses over the function | ||
| + | |||
| + | ====name==== | ||
| + | The name of the function, which will show as the node’s title. | ||
| + | |||
| + | ====returnType==== | ||
| + | Determines what the function can return. Can be one of the following: | ||
*''"string" | *''"string" | ||
*''"list" | *''"list" | ||
| + | *''"table" | ||
| + | |||
| + | == Functions == | ||
| + | |||
| + | |||
| + | ====addParameter==== | ||
| + | =====usage===== | ||
| + | exampleFunction.addParameter(parameterName, helperText, editorType, Optional listItems = "", Optional advanced = False) | ||
| + | |||
| + | editorType can be one of the following: | ||
| + | =====Editor Types===== | ||
| + | |||
| + | *''string | ||
| + | *''element | ||
| + | *''table | ||
| + | *''list | ||
| + | *''variable | ||
| + | *''listbox | ||
| + | *''savefile | ||
| + | *''openfile | ||
| + | *''openfolder | ||
| + | *''search | ||
| + | *''blocktext | ||
| + | *''code | ||
| + | *''condition | ||
Latest revision as of 16:01, 10 January 2016
Creates a new function object.
Contents |
[edit] Properties
[edit] userLevel
Determines which edition of UBot Studio can use this function
[edit] category
Determines which toolbox category this will go in
[edit] logic
This property should be set to the function that will run when the function is run within a script
[edit] generateChildren
If this is a container function, you can use this delegate function to add children automatically
[edit] toolTip
The tooltip that appears when the user mouses over the function
[edit] name
The name of the function, which will show as the node’s title.
[edit] returnType
Determines what the function can return. Can be one of the following:
- "string"
- "list"
- "table"
[edit] Functions
[edit] addParameter
[edit] usage
exampleFunction.addParameter(parameterName, helperText, editorType, Optional listItems = "", Optional advanced = False)
editorType can be one of the following:
[edit] Editor Types
- string
- element
- table
- list
- variable
- listbox
- savefile
- openfile
- openfolder
- search
- blocktext
- code
- condition
