Scripting Help Conventions
The majority of this guide lists individual script commands using the following format.
[ScriptName]
[Description of script use.]
| UI Access | [UI commands corresponding to the script command, if any.] |
| Parameters | [List of arguments taken by the script command, if any. Includes argument types and brief descriptions.] |
| Return Value | [The script's return value, if any.] |
| Python Syntax | [Correct syntax for the command in Python. Arguments are enclosed in angle brackets (<>).] |
| Python Example |
|
Variable Types
The following data types are used throughout the help:
- <string> – use within quotation marks.
- <bool> – boolean value; should be set to either True or False.
- <int> – an integer. For example, 1.
- <double> – a double precision value. For example, 1.2.
- <array> – a list contained in square brackets.
- <value> – can be an integer, string, or other variable, depending on context.