Toggle
Syntax
Command
Description
Return Value
Toggle <value>
Toggles the value of the selected object(s) The value the object(s) were set to
•
<value>
◦ A percentage from
0
to
100
. When specifying percentages, the value can optionally be followed
by the
%
sign.
◦ A decimal number from
#0
to
#255
. When specifying decimal numbers, the value must be
proceeded with a
#
sign.
◦ A hexadecimal number from
$00
to
$FF
. When specifying hexadecimal numbers, the value
must be proceeded with a
$
sign.
◦
FL
(Full) or
On
can be used as a shortcut that means
100%
◦
Off
can be used as a shortcut that means
0%
Abbreviation
TOG
Description
Toggling Values
The
Toggle
command flip-flops the currently selected object(s) values between a fixed value and zero. In
other words, if the selected value is already set to the toggle value, the value is set to zero. But, if the
selected value is not equal to the toggle value, then the value is set to the toggle value. This flip-flop
behavior creates a situation where each time the
Toggle
command is executed, the selected value(s)
alternate between zero and the toggle value.
The
Toggle
command can be used with many types of objects, including
Buttons
,
Channels
,
Groups
,
Outputs
, and
Playbacks
.
Other than the alternating behavior, the
Toggle
command otherwise behaves similarly to the
command.
Interactive Technologies, Inc.
CueServer 2 User's Manual - 18.5.18
Page 249 of 429
