Syntax
| Command | Description | Return Value |
|---|---|---|
Effect <number> [<range...>] |
Select one or more effects in the active playback fader | 0 |
Effect Clear or Effect ; |
Deselect all effects | 0 |
Effect ? |
Return the current selection | A selection string |
<number>- An effect slot from
1to4.
- An effect slot from
Abbreviation
EF
Description
Selecting Effects
The Effect command selects one or more effects in the active playback fader. Effects are dynamic overlays applied to each playback fader that can modify channel values in real-time. Each Playback Fader has four independent effect slots. Effects can modify the color, intensity, position, and other parameters of channels and/or fixtures.
Setting Effect Properties
Once an effect is selected using the Effect command, properties of effects can be changed using the Set or assignment commands. The following example demonstrates how a playback’s effects can be manipulated using CueScript.
Playback 1
Effect 2
"effect.type" = 1 // Set type to Hue Rotate
"effect.rate" = 0.5 // Set rate to 0.5 seconds
For a detailed listing of the various effect properties that can be manipulated using CueScript, refer to the Effect Properties topic.
Enabling/Disabling Effects
Effects can be enabled or disabled individually using the Enable or Disable commands. A disabled effect does not contribute to the output of a playback fader.
Deselecting All Effects
Using either Effect Clear or Effect ; will deselect all effects while leaving “Effect” as the current command target.
Determining Which Effects Are Selected
The question mark ? can be used to ask what the current selection is. A selection string will be returned, which will consist of a single number (like 3) or a range (like 1>4), or if no effects are selected, 0 will be returned.
Examples
Effect 1
Selects effect 1 in the active playback.
Effect 1>4 Disable
Disables the contribution of effects 1 through 4.