| IMyTerminalControlOnOffSwitch Interface |
[This is preliminary documentation and is subject to change.]
This is an on / off switch or toggle button. It gives two options that a user can toggled between.
Namespace: Sandbox.ModAPI.Interfaces.Terminal
Assembly: Sandbox.Common (in Sandbox.Common.dll) Version: 1.0.0.0
SyntaxC#
public interface IMyTerminalControlOnOffSwitch : IMyTerminalControl, IMyTerminalValueControl<bool>, ITerminalProperty, IMyTerminalControlTitleTooltip
The IMyTerminalControlOnOffSwitch type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Enabled |
Allows you to set if the control is enabled
(Inherited from IMyTerminalControl.) |
| Getter |
This is triggered when the value of the control is required.
(Inherited from IMyTerminalValueControlTValue.) |
| Id |
Identifier of control
(Inherited from IMyTerminalControl.) |
| OffText |
The label for the "off" switch
|
| OnText |
The label for the "on" switch
|
| Setter |
This is triggered when the value of the control is set by the user. Depending on the control, this may be called a lot.
(Inherited from IMyTerminalValueControlTValue.) |
| SupportsMultipleBlocks |
Allows you to set if the control is visible when the block is selected as a group
(Inherited from IMyTerminalControl.) |
| Title |
Allows you to get or set the Label that appears on the control
(Inherited from IMyTerminalControlTitleTooltip.) |
| Tooltip |
Allows you to get or set the tooltip that appears when you hover over the control
(Inherited from IMyTerminalControlTitleTooltip.) |
| TypeName | (Inherited from ITerminalProperty.) |
| Visible |
Allows you to set if the control is visible
(Inherited from IMyTerminalControl.) |
Methods| Name | Description | |
|---|---|---|
 | RedrawControl |
Recreates the control GUI. This allows you to update the Title of some controls.
(Inherited from IMyTerminalControl.) |
| UpdateVisual |
This updates a control that is currently displayed, allowing you to refresh it's state
(Inherited from IMyTerminalControl.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AsTValue |
Property type cast
(Defined by TerminalPropertyExtensions.) |
| AsBool |
Property type cast
(Defined by TerminalPropertyExtensions.) |
| AsColor |
Property type cast
(Defined by TerminalPropertyExtensions.) |
| AsFloat |
Property type cast
(Defined by TerminalPropertyExtensions.) |
| CastTValue |
Property type cast
(Defined by TerminalPropertyExtensions.) |
| IsTValue |
Check property type
(Defined by TerminalPropertyExtensions.) |
See Also