Documentation

Editing Functions

Added in v2.0

When you select a Function setting and open the advanced options panel at the bottom, you will get an editor panel like this:
Function editor

Enabled
Determines if this function is enabled or disabled.
Name
This is the name of the function. This is the text that you would enter on the command line to call the function.
Script
This is the full script of the function. See the Scripting topic for more information.
Language
Select the scripting language used for this function. Built-in languages include: zScript, Lua, VBScript, and JavaScript. But any other scripting language installed into the Windows Scripting Host can also be used.
Script Text / XML / Compiled Code
Selecting the Compiled Code tab will show the low-level code generated by this function. This is for internal testing purposes and is not documented further. Selecting the XML tab will allow you to edit the raw XML data used for copy/paste and import/export.
Params
This allows you to specify Named Arguments for the function. It is simply a list of the argument names, separated by commas. The $ character in front of the argument name is optional.
Type
The variable type returned from the function.
Notes
Used to store comments with the function. You might use this to remind yourself what the function is used for.

Add comment

Login or register to post comments