Space Engineers
Properties | List of all members
Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlOnOffSwitch Interface Reference

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

Inheritance diagram for Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlOnOffSwitch:
Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalValueControl< bool > Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlTitleTooltip Sandbox.Game.Gui.MyTerminalControlOnOffSwitch< TBlock >

Properties

MyStringId OnText [get, set]
 The label for the "on" switch More...
 
MyStringId OffText [get, set]
 The label for the "off" switch More...
 
- Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl
string Id [get]
 Identifier of control More...
 
Func< IMyTerminalBlock, bool > Enabled [set]
 Allows you to set if the control is enabled More...
 
Func< IMyTerminalBlock, bool > Visible [set]
 Allows you to set if the control is visible More...
 
bool SupportsMultipleBlocks [get, set]
 Allows you to set if the control is visible when the block is selected as a group More...
 
- Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalValueControl< bool >
Func< IMyTerminalBlock, TValue > Getter [get, set]
 This is triggered when the value of the control is required. More...
 
Action< IMyTerminalBlock, TValue > Setter [get, set]
 This is triggered when the value of the control is set by the user. Depending on the control, this may be called a lot. More...
 
- Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlTitleTooltip
MyStringId Title [get, set]
 Allows you to get or set the Label that appears on the control More...
 
MyStringId Tooltip [get, set]
 Allows you to get or set the tooltip that appears when you hover over the control More...
 

Additional Inherited Members

- Public Member Functions inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl
void RedrawControl ()
 Recreates the control GUI. This allows you to update the Title of some controls. More...
 
void UpdateVisual ()
 This updates a control that is currently displayed, allowing you to refresh it's state More...
 

Detailed Description

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

Definition at line 8 of file IMyTerminalControlOnOffSwitch.cs.

Property Documentation

MyStringId Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlOnOffSwitch.OffText
getset

The label for the "off" switch

Definition at line 17 of file IMyTerminalControlOnOffSwitch.cs.

MyStringId Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlOnOffSwitch.OnText
getset

The label for the "on" switch

Definition at line 13 of file IMyTerminalControlOnOffSwitch.cs.


The documentation for this interface was generated from the following file: