Appendix A: CueScript Command Summary
Contents
1. Substitutes the value of a variable or system function into the command line The semicolon is for visually separat ing parts of a long string of CueScript commands to help make CueScript more readable CueServer ignores semicolons in commands Examples gt 10 Channel 101 gt 201 Output 1 gt 4 Channel At FL Button On Output Off Device Cue 1 Go cue I Gors Output 1 gt 8 Off Device 7 Release Hello World 0 Begin Show 4 x 3 myCueNumber 10 5 myPrompt Press Start backlight 50 Group x At 33 Cue myCueNumber Go myPrompt 0 Log Light backlight Cue rand 1 10 Go Group 1 At 33 Group 2 At 50 Channel 1 gt 10 Record Cue 101 Button 1 On Wait 10 Off Appendix A CueScript Command Summary 169 170 Appendix A CueScript Command Summary CueServer User s Manual2. Toggle level TOG Unjoin station number Update Cue option cue number UP Wait time W except Description Suspends the timing operation of the current playback fader Any crossfades streming cues or auto follow timers are paused This function is useful for loading cues that are part of chases for editing Specifies the crossfade time of any channel values that are set with the At command The Time command does not affect cue playback Any time from O through 6500 may be specified in 0 1 second increments A time of O zero indicates that values snap immediately to their desired levels Toggles the level or value of the selected object s between O zero and the speci fied level Removes the logical connection between stations as created by the Join command Unparks the currently selected DMX chan nels See the Park command for more details Updates the DMX levels in a cue Similar to recording a cue but does not affect the cue name timing parameters link or command string To update using only selected channels use the option To update with no channels use the option To merge only selected channels use the option Inserts a delay into command execution Any commands that appear after the Wait command will be placed in a special Wait Queue for execution in the future Clears all currently waiting commands in the Wait Queue Used to extend the curren
3. Appendix A CueScript Command Summary The following table is a quick reference of the commands in the CueScript programming language used by CueServer Both simple and complex command sequences can be executed by CueServer by simply typing them into one of CueServer s web pages or as a result of one of CueServer s triggers Such as timers buttons contact closures cues and more or from external sources such as custom web pages Flash objects LCD touchscreens or via the serial MIDI or Ethernet ports For a complete description of each command please refer to the CueScript Command Language chapter Command At unit value A or At array of values A or At unit offset A or At Cue cue number level AQ or Q At Input AIN CueServer User s Manual Description Sets the value of selected object s Works with Channels Fixtures Groups Buttons and Outputs By default channel values are expressed in percentages Decimal values can be specified with the character hexadecimal values can be specified with the character The FL expression is a shortcut for 100 Sets the values of selected object s to an array of values Similar to the regular At command but multiple values are given in an array which are assigned to each selected Channel Button or Output in a sequential pattern Sets the values of selected object s to an offset from their current values
4. Channel 1 At 50 Channel 10 gt 25 At 75 Channel 10 20 30 Releas Channel Disable Channel 1 gt 4 21 gt 24 Park Playback 3 Clear Contact 1 Disable Contact 2 5 Enable Cue 1 Cue 2 Go Cue 10 5 Fade 7 Go Delete Cue 1 Delete Group 2 Device 7 Cue 1 Go Device 5 gt 8 Output 1 On Channel 1 gt 10 Disable Button 4 Disable Contact Disable Channel 1 gt 10 Enable Button 4 Enable Contact Enable Fade 5 Cue 1 Fade 10 Go Cue 5 Fade 2 5 5 Go CueServer User s Manual Command Fixture range F Follow time FO Follow Clear FOCL Group group number GR or U Input enable state IN Input Update INUP Join station number Link cue number L Log string Macro macro number M CueServer User s Manual Description Selects one or more fixture s channels The Fixture command works similarly to the Channel command but it selects all channels of a fixture at a time Changes the currently selected playback fader s cue auto follow time Times from O to 6500 seconds may be specified in 0 1 second increments Clears the follow timer from the current playback fader Causes the next cue in the current play back fader to execute Recalls a set of channels saved in a group Can be used similarly to the Channel or Fixture commands Examples Fixture 1 At 50 Fixture 2 4 6 8 At 75 Fixture 1 gt 5 At 50 FL 0 3
5. Examples Merge Playback 3 Merge Next At Channel Fixture Next Next Channel 1 Off tput 2 4 Off tton 1 gt 5 Off Channel 1 On tput 2 4 On tton 1 gt 5 On tput 1 At FL tput 2 4 6 At 0 tput 1 gt 8 Off Override Playback 2 Override Channel 1 Park Channel 101 gt 200 Park Fixture 3 Park Group 7 Park Playback Playback Override Cue 1 Go Clear Playback At 50 Previous At 0 Channel 2 At 20 Previous At 10 Fixture 2 At 50 Previous At FL Record Cue 1 Record Cue 101 5 Channel 1 gt 10 Record Cue 5 Record Cue 7 CueServer User s Manual Command Record Group group number RU Record Stop RSTO Record Stream cue number RSTR Release REL or Z Reset Start Stop Clear AA ew Station range CueServer User s Manual hh mm ss ff Description Records a group into memory with the currently selected channels included in the group Stops any streaming cue that is currently being recorded Begins recording a streaming DMX cue into memory with the given cue number Any cue number from 0 1 through 4999 9 may be used See the detailed description of Record Stream for details about its advanced options Removes the influence of the currently selected DMX channels from the currently selected playback fader If no channels are selected the Release command releases all channels in the playback fader Resets all four playback fad
6. Park Fixture Follow 10 Cue 1 Follow 15 Go Follow Clear Playback 2 Follow Clear Go Cue 1 Go Cue Fade 5 Go Group 1 Group 2 At 33 Group 3 Release Conditionally executes statements depending on a boolean value May optionally contain an ELSE statement for execution if the boolean is false Enables or disables the influence of the DMX Input port on the playback faders Forces all DMX Input Triggers to execute their action commands Logically joins the selected station s with the station specified by the Join command See also Unjoin Changes the cue that will follow the current cue By default cues execute in numerical order This command can allow any cue to follow the current cue Adds the given string to the System Log 2g Log Depreciated Use Override instead Executes a user defined macro IF enabled THEN Cue 1 Go ENDIF showMode HEN Macro 1 ELSE Macro 2 ENDIF Enable Disable tion 1 Join 2 tion 1 gt 10 Join 15 Link 1 Cue 1 Link 101 Go Hello World Variable x x Appendix A CueScript Command Summary 165 Command Output range O Override OV Park Playback number P Previous PREV Or Record Cue option cue number RQ Description Changes the currently selected playback fader s DMX combine mode to merge which combines the fader s levels with the pre
7. Similar to the regular At command but values are assigned as a relative offset from the current value s All values are pinned to O and 100 i e the values do not wrap around Sets the values of selected object s to data stored in a cue Useful for recalling only parts of a cue into the current play back An optional level may be specified that scales the recalled levels from the cue Sets the values of selected object s to the current levels available on the DMX Input port Useful for taking a snapshot of the DMX Input Examples Channel 1 At 50 Fixture 5 gt 8 At 75 Group 3 At FL Button 4 At 255 Output 5 At SFF Time 5 Channel 1 gt 10 At 33 Channel 1 gt 3 At 10 20 30 Fixture 4 At 0 50 FL Group 10 At 255 0 80 Channel 1 At 5 Channel 5 gt 8 At 10 Group 3 At 25 Fixture 4 At 50 Channel 1 At 10 Channel 2 At SOC Channel 1 gt 10 At Cue 7 Fixture 3 At Cue 101 Group 4 Time 10 At Cue 99 Button 1 At Cue 1 Group 2 At Cue 1 50 Channel 1 gt 512 At Input Fixture 1 3 5 At Input Output 1 At Input Appendix A CueScript Command Summary 163 Command At Playback number Button range B Channel range Contact range CO Cue cue number CU or Q Delete object DEL Device range DEV or Fade time Description Sets the values of selected object s to the current levels in one of the four playback faders Stops executing CueScript commands
8. ers and the CueScript command interpreter to power on values Also resets Timecode and the command queue Changes the currently selected playback fader s DMX combine mode to scale When a fader is in scale mode any active channels in the fader are used as a pro portional scaling factor for values coming from the previous fader Use scale mode to create grand masters or submasters Refers to the Button or Contact that resulted in the execution of the command Manages the internal generation of time code Allows the timecode generator to be reset to zero started stopped cleared or sets the timecode to a user specified value Resumes normal timing operation of the current playback fader Start resumes any crossfades streaming cues or auto follow timers that have been paused by the Stop command Selects one or more stations for joining or unjoining with other stations Examples Record Group 1 Channel 1 3 5 7 Record Group 2 Record Stop Record Stream 101 triggerchannel 512 streamlength 20 5 Record Stream 102 Release Channel 1 gt 10 Release Playback 2 Group 3 Release Scale Playback 4 Scale Self On Self At 4 Self Disable Reset Start Stop Clear SOI 23 245 53 0 7 EII ESTEL ALa Start Playback 4 Start Station 1 Join 2 Station 1 gt 10 Join 15 Appendix A CueScript Command Summary 167 Command Stop STO T
9. t selection Used to remove objects from the current selection 168 Appendix A CueScript Command Summary Examples Stop Playback 3 Stop Time 5 Time 10 Channel 1 gt 10 At FL Time 1 5 Fixture 3 At 50 Channel 1 Toggle FL Group 1 Toggle 33 Button 1 Toggle 1 Playback 1 Toggle 100 Station Station 1 Unjoin 2 1 gt 10 Unjoin 15 Channel 1 Unpark Channel 101 gt 200 Unpark Fixture 3 Unpark Group 7 Unpark Update Cue 1 Channel At FL Update Cue 2 Channel 5 Update Cue 3 Update Cue 4 Group 1 Update Cue 5 Wait 30 Cue 1 Go Button 1 On Wait 5 Off Cue 1 Go Wait 1 Go Wait 1 Go Wait Clear 10 Channel 1 3 Button 1 gt 4 8 5 Channel 1 gt 10 4 Button 1 gt 4 2 CueServer User s Manual Command gt through wildcard command string string string location variable value variable CueServer User s Manual Description Used to specify a range of objects Used to select all objects of a given type Used to broadcast CueScript commands to other CueServers on the local network Stores a given string into a special loca tion Used to write to the LCD Display serial ports MIDI port and Ethernet broadcast packets See the command s documentation for details Stores a value into a variable Variables may be user defined or system defined The quotes around the value are optional if the value is a number
10. that follow the Break command Useful for use with variables to conditionally execute commands Selects one or more buttons for setting the indicator LED or enable states Selects one or more channels Used for setting and releasing channel levels enabling disabling parking unparking and other similar functions Clears the selected playback fader All channels except parked channels will be released cue list information and timing values will be reset Selects one or more contacts for setting their enable states Specifies the cue to be executed by the next Go command Deletes Cues or Groups Targets one or more CueServers by Device ID for receiving CueScript com mands Typically used in conjunction with the syntax for broadcasting messages to remote CueServers over the network Disables currently selected Channels Buttons or Contacts Enables currently selected Channels Buttons or Contacts Changes the currently selected playback fader s cue crossfade time Times from O to 6500 seconds may be specified in 0 1 second increments Split fade times are expressed with a separator 164 Appendix A CueScript Command Summary Examples Channel 1 gt 512 At Playback 4 Group 3 At Playback 2 MyEnable Cue 101 Go The MyEnable variable may be empty or contain the Break command Button 1 At FL Button 5 gt 8 On Button 3 4 At 235 Button 1 3 5 Enable
11. vious levels in a highest takes precedence HTP manner Shifts the current selection to the next logical group of objects A special CueScript token that is equiva lent to the command At 0 Can be used to set the value of any object A special CueScript token that is equiva lent to the command At FL Can be used to set the value of any object Selects one or more outputs for setting their output value Changes the currently selected playback fader s DMX combine mode to override When a fader is in override mode any active channels in the fader replace the levels of other faders before it Parks the currently selected DMX chan nels When a channel is parked it is no longer affected by setting or releasing channels or cue playback Parked chan nels become frozen at their current level until they are unparked Selects one of the four playback faders as the target for all subsequent commands that operate on a fader Shifts the current selection to the previous logical group of objects Reboots the CueServer All show play back is immediately interrupted Records a cue into memory with the given cue number Any cue number from 0 1 through 6499 9 may be used By default all 512 channels are recorded into the cue To record only selected channels use the option To record no channels use the 4 option 166 Appendix A CueScript Command Summary Playback Playback
Download Pdf Manuals
Related Search