Button

Syntax

Command Description Return Value
Button <number> [<range...>] Select one or more buttons The pressed state of the selected button(s)
Button <station>.<number> [<range...>] Select one or more buttons on a specific station The pressed state of the selected button(s)
Button ? Return the current selection A selection string

Abbreviation

B

Description

Selecting Buttons

The Button command selects one or more buttons in the system. Buttons are typically physical pushbuttons on the front of a CueServer or individual buttons on a connected button station. Use the Button command in conjunction with an action command like At, On, Off, Set, Enable or Disable to change the properties of one or more buttons. When used alone or in logic expressions, the Button command returns the current state of the specified button(s).

Either a single button number can be specified, or a range of buttons can be specified using the various selection operators like +, -, > and ~.

The wildcard character * can be used as the button number to mean all buttons for a particular station.

Working With Stations

When no station number specified, the default station is assumed. The Station command can be used to change the default station. Unless changed by the Station command, the default station is typically Station 0, which corresponds to the built-in buttons on the CueServer itself. When a station number is specified as part of the Button command, that station number will be used for the selection.

Determining Which Buttons 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 5>7+9), or if no buttons are selected, 0 will be returned.

Examples

Button 1
Selects button 1. Future action commands will be directed towards button 1. Also returns 0, or 1 to indicate if the button is currently unpressed or pressed.

Button 1>5 On
Turns the LED indicators of buttons 1 thru 5 on.

Button 1>3+5>8 Off
Turns the LED indicators of buttons 1 through 3 and 5 through 8 off.

Button 2.3>5 Enable
Enables buttons 3 through 5 on station 2.

Button 3.1
Set Button.OnColor {100,50,0}
Set Button.Flash 4
On
Disable
Selects button 1 of station 3, then sets the button’s OnColor property to Orange (RGB color (100,50,0)), then sets the button’s Flash property to 4, then turns the LED indicator on, then disables button presses from the button.

Button 1.* Off
Turns the LED indicators of all buttons on station 1 off.

Station 5
Button 7 Enable
Enables button 7 of station 5.

Button ?
Returns the current button selection in the format of a single number like 3, or a range like 5>7+9.

See Also