Functions

Revision as of 16:00, 10 January 2016

Creates a new function object.

Determines which edition of UBot Studio can use this function

This property should be set to the function that will run when the function is run within a script

If this is a container function, you can use this delegate function to add children automatically

The tooltip that appears when the user mouses over the function

Determines what the function can return. Can be one of the following:

The name of the function, which will show as the node’s title.

exampleFunction.addParameter(parameterName, helperText, editorType, Optional listItems = "", Optional advanced = False)

editorType can be one of the following:

@@ Line 1: / Line 1: @@
-This is the same as command, and also includes:
+Creates a new function object.
-===returnType===
+== 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
+===returnType===
+Determines what the function can return. Can be one of the following:
 *''"string"
 *''"list"
 *''"table"
+====name====
+The name of the function, which will show as the node’s title.
+== 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