Define

This command is a flow command. This command allows you to define a custom command or function that can be used in your bot.

Name: The name of the command or function being created (please avoid using function or commands names that already exist within UBot Studio as commands and functions.)

Command or Function: Select "Function" when creating a custom function that returns values. Select "Command" when creating a custom command that runs a task.

Parameters: allows you to pass variables into a command or function.

The define command, when creating a function, will use the Return command to return values from the function.

For an example on creating a Function with the Define command, please see the Return command's example 1.

Example 1

Naming the command, placing other commands in the define command and clicking OK creates the command under the Custom Commands tab.

define search for a keyword {
    navigate("google.com", "Wait")
    type text(<name="q">, "Stina Nordenstam", "Standard")
    click(<name="btnK">, "Left Click", "No")
}
search for a keyword()

Running the script will run the commands in the defined command called "search for a keyword" as one command.

For more information on how to create a function, please see the Return command.

Example 2

Adding a parameter allows you to quickly pass information into a define function or command in order to control the way the command or function runs.

Browser URL("bing.com")
define Browser URL(#website) {
    navigate(#website, "Wait")
}

Notice that adding a parameter created a parameter within the the defined command called Browser URL.

Typing a url into the parameter in the define command and running the defined command navigates the browser to the specified url.

Example 3

The define command can also be used to create a button on the UI through the UI editor.

This capability only applies to commands created with the define command.

To attach a defined command to a UI button created on the UI, click View, and select the UI Editor.

Drag the button onto the UI area. On the right side of the UI editor, name the button.

Under the drop down labeled UBot Command, select the define command you would like to run when the button is clicked.

Click ok after selecting a command to return to the UBot scripting area. Notice that the button appears the UI above the browser.

Clicking the button will run the commands within the defined command assigned to the UI button.