Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlOnOffSwitch

Assembly: Sandbox.Common.dll

public interface IMyTerminalControlOnOffSwitch: IMyTerminalControl, IMyTerminalValueControl<bool>, ITerminalProperty, IMyTerminalControlTitleTooltip

This is an on / off switch or toggle button. It gives two options that a user can toggled between.

Properties

Member	Description
OffText	The label for the "off" switch
OnText	The label for the "on" switch
Enabled	Allows you to set if the control is enabled Inherited from IMyTerminalControl
Id	Property Id (value name) Inherited from ITerminalProperty
Id	Identifier of control Inherited from IMyTerminalControl
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	Property type (bool - bool , float - float , color - Color ) Inherited from ITerminalProperty
Visible	Allows you to set if the control is visible Inherited from IMyTerminalControl

Member	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

Implements: