The script header is a comment at the top of each script. It must have a specified format, and when the script is run, it controls various information displayed in the script parameter window.
/**
* Script Documentation
* @name Example Script
*
@version 0.0.0.0
* @author Your Name
* @signed 0
* @namespace
MYS
*/
The comment must begin with /** and each line in the comment must begin with *.
Script Name
The @name field determines the name of the script that is displayed to the user in the script menus and in the script parameter window. It does not have to be the same as the
Script Version
The @version field can contain any single-line string, but it is suggested to maintain the version of the script to be in the Windows-standard format x.x.x.x. The first number indicates the primary revision with the subsequent numbers for increasingly minor revisions.
Script Author
The @author field can contain any single-line string to identify the person or organization responsible for the script.
Script Signing
The @signed field is reserved for use by Delsys to identify scripts that have been tested and verified through our internal process. It can contain any numeric value, but scripts created by users can never be signed. Contact support@delsys.com if you would like to have your script included in an EMGworks release.
Script Namespace
Each script is entirely contained in a JavaScript namespace to avoid naming conflicts between scripts. The namespace for this script is specified on the @namespace line. It must be a valid JavaScript identifier.
Script Documentation
Any lines of text not prefixed with one of the above field declarations is considered to be documentation for the script and displayed in the script parameter window when running the script. Multiple lines of documentation can be used.