Describes a state of the Comms Radio.
- Namespace
- CommsRadioAPI
- Base Types
-
- object
graph BT
Type-->Base0["object"]
Type["CommsRadioState"]
class Type type-node
Syntax
public sealed class CommsRadioState
Constructors
| Name | Summary |
|---|---|
| CommsRadioState |
Construct a new CommsRadioState object. |
Fields
| Name | Field Type | Constant Value | Summary |
|---|---|---|---|
| behaviour | ButtonBehaviourType |
Whether the up and down buttons switch between Comms Radio modes (Regular), trigger the state action handler (Override), or are completely ignored (Ignore).
|
|
| lcdAction | string |
The text displayed in large letters at the bottom of the LCD screen.
|
|
| lcdArrow | LCDArrowState |
Whether the arrow on the LCD screen is off, pointing left, or pointing right.
|
|
| lcdContent | string |
The text displayed in small letters below the title on the LCD screen.
|
|
| lcdTitle | string |
The text displayed in large letters at the top of the LCD screen.
|
|
| led | LEDState |
Whether the LED light on the back of the Comms Radio is off or on.
|
Methods
| Name | Return Value | Summary |
|---|---|---|
| Fork |
CommsRadioState |
Creates a new Comms Radio state where the provided parameters are overlayed onto the existing state.
|