UICommand

From UBot Studio
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
The same as Command and includes:
+
Creates a new ui command object.
 +
 
 +
== Properties ==
 +
 
 +
====userLevel====
 +
Determines which edition of UBot Studio can use this command
 +
 
 +
====category====
 +
Determines which toolbox category this will go in
  
 
====getHTML====
 
====getHTML====
 +
This property should be set to a function that returns html for the command’s ui
 +
 +
====generateChildren====
 +
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
 +
 +
====name====
 +
The name of the command, which will show as the node’s title.
 +
 +
== Functions ==
 +
 +
 +
====addParameter====
 +
=====usage=====
 +
exampleCommand.addParameter(parameterName, helperText, editorType, Optional listItems = "", Optional advanced = False)
 +
 +
editorType can be one of the following:
 +
=====Editor Types=====
  
Should be set to a function that returns html for the command’s ui
+
*''string
 +
*''element
 +
*''table
 +
*''list
 +
*''variable
 +
*''listbox
 +
*''savefile
 +
*''openfile
 +
*''openfolder
 +
*''search
 +
*''blocktext
 +
*''code
 +
*''condition

Revision as of 15:56, 10 January 2016

Creates a new ui command object.

Contents

Properties

userLevel

Determines which edition of UBot Studio can use this command

category

Determines which toolbox category this will go in

getHTML

This property should be set to a function that returns html for the command’s ui

generateChildren

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

name

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

Functions

addParameter

usage

exampleCommand.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
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox