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