Comments can be included in CueScript. A comment is a human-readable explanation or annotation in the source code of a block of CueScript. The following CueScript code includes two different types of comments:
/* Start the Evening Show in Playback 1
While also clearing any overrides in Playback 2 */
Playback 2; Clear
Playback 1; Cue 1 Go // Evening Show
// Set our show variable to keep track
Set currentShow "Evening"
The following sections describe the two comment types supported by CueScript in detail.
Block Comments
CueScript can use block comments similarly to JavaScript and the C programming languages. When a Block Comment Start is encountered, which is a slash followed by an asterisk /*, CueScript begins ignoring any text it finds until it encounters a Block Comment End, which is an asterisk followed by a slash */.
The block comment can begin anywhere on a line and end on the same line or many lines later.
Here is an example of a multi-line block comment:
/*
This is a comment that is ignored by CueScript.
These are handy to be able to add lots of text to the body of a CueScript code block.
*/
Line Comments
CueScript can also use line comments similarly to JavaScript and the C programming language. A line comment starts with a double-slash // and ends at the end of the current line. Any time CueScript encounters a line comment, it ignores any text it finds until it encounters the next line of code.
The line comment can begin anywhere on a line and it will end as soon as the end of the line is reached.
Here’s an example of several line comments:
// Setup the main playback
Playback 1; Clear
Set playback.mode Merge // Standard mode
// Setup the playback used for dimming
Playback 2; Clear
Group 50 At FL // Start with all dimmers at Full
Set playback.mode Scale // For scaling dimmers