Scripting Manual Conventions
Arial Narrow
This is the default general text of this manual and all instructional text
Green Courier New Text
This text style is reserved for Basic Scripting syntax as it relates to the various procedures, functions, or general script syntax in the manual. Please note that any scripted line followed by the linewrap image is actually intended to be entered as one singular line of text in the scripting window. Multi-line commands are currently not supported in the scripting environment.
Blue Courier New Text
This text style denotes an Event Trigger
Example template for scripting functions:
Structure
functionHere(params)
Type
Type of Function - Ex: Procedure
Description
Input a description of the scripting function here.
Parameters: 2
- param1 (String) – brief description of parameter
- param2 (String) – brief description of parameter
OR, you can use a table:
Parameters:
| Parameter | Type | Description
| sCompany | String | the Company of the asset that should be looked up on main screensID | String | the ID of the asset that should be looked up on main screen |
Return Value
Input return value here (if applicable)
Example
Input Code Example Here (if applicable) |