Command

From UBot Studio
(Difference between revisions)
Jump to: navigation, search
(Functions)
m (LillyT moved page Command() to Command without leaving a redirect: Needs new title)
 
(9 intermediate revisions by one user not shown)
Line 26: Line 26:
  
 
====addParameter====
 
====addParameter====
=====usage=====exampleCommand.addParameter(parameterName, helperText, editorType, Optional listItems = "", Optional advanced = False)
+
=====usage=====
 +
exampleCommand.addParameter(parameterName, helperText, editorType, Optional listItems = "", Optional advanced = False)
  
editor
+
editorType can be one of the following:
'''Editor Types'''
+
=====Editor Types=====
  
''string
+
*''string
 
+
*''element
''element
+
*''table
 
+
*''list
''table
+
*''variable
 
+
*''listbox
''list
+
*''savefile
 
+
*''openfile
''variable
+
*''openfolder
 
+
*''search
''listbox
+
*''blocktext
 
+
*''code
''savefile
+
*''condition
 
+
''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
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox