Space Engineers
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
Sandbox.Game.Gui.MyTerminalControlCheckbox< TBlock > Class Template Reference
Inheritance diagram for Sandbox.Game.Gui.MyTerminalControlCheckbox< TBlock >:
Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, bool > Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlCheckbox Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalValueControl< bool > Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlTitleTooltip

Public Member Functions

 MyTerminalControlCheckbox (string id, MyStringId title, MyStringId tooltip, MyStringId?on=null, MyStringId?off=null)
 
MyTerminalAction< TBlock > EnableAction (string icon, StringBuilder name, StringBuilder onText, StringBuilder offText)
 
override bool GetDefaultValue (TBlock block)
 
override bool GetMinimum (TBlock block)
 
override bool GetMaximum (TBlock block)
 
override void SetValue (TBlock block, bool value)
 
override bool GetValue (TBlock block)
 
- Public Member Functions inherited from Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, bool >
delegate TValue GetterDelegate (TBlock block)
 
delegate void SetterDelegate (TBlock block, TValue value)
 
delegate void SerializerDelegate (BitStream stream, ref TValue value)
 
delegate void ExternalSetterDelegate (IMyTerminalBlock block, TValue value)
 
 MyTerminalValueControl (string id)
 
TValue GetValue (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
virtual void SetValue (TBlock block, TValue value)
 
void SetValue (VRage.Game.ModAPI.Ingame.IMyCubeBlock block, TValue value)
 
virtual void Serialize (BitStream stream, TBlock block)
 
void Serialize (BitStream stream, MyTerminalBlock block)
 (De)serializes block data. More...
 
TValue GetDefaultValue (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
TValue GetMininum (TBlock block)
 
TValue GetMininum (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
TValue GetMinimum (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
TValue GetMaximum (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
- 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...
 

Public Attributes

MyStringId Title
 
MyStringId OnText
 
MyStringId OffText
 
MyStringId Tooltip
 
- Public Attributes inherited from Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, bool >
SerializerDelegate Serializer
 Serializer which (de)serializes the value. More...
 

Protected Member Functions

override MyGuiControlBase CreateGui ()
 
override void OnUpdateVisual ()
 

Additional Inherited Members

- Properties inherited from Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, bool >
GetterDelegate Getter [get, set]
 Getter which gets value from block. Can be set by anyone, but used only by MyTerminalValueControl. If you need to get the value, use GetValue method. More...
 
SetterDelegate Setter [get, set]
 Setter which sets value to block. Can be set by anyone, but used only by MyTerminalValueControl. If you need to set the value, use SetValue method, which does handles notification. More...
 
Expression< Func< TBlock, TValue > > MemberExpression [set]
 
- Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlCheckbox
MyStringId OnText [get, set]
 The "on" label text More...
 
MyStringId OffText [get, set]
 The "off" label text 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...
 

Detailed Description

Type Constraints
TBlock :MyTerminalBlock 

Definition at line 19 of file MyTerminalControlCheckbox.cs.

Constructor & Destructor Documentation

Sandbox.Game.Gui.MyTerminalControlCheckbox< TBlock >.MyTerminalControlCheckbox ( string  id,
MyStringId  title,
MyStringId  tooltip,
MyStringId on = null,
MyStringId off = null 
)
inline

Definition at line 32 of file MyTerminalControlCheckbox.cs.

Member Function Documentation

override MyGuiControlBase Sandbox.Game.Gui.MyTerminalControlCheckbox< TBlock >.CreateGui ( )
inlineprotected

Definition at line 42 of file MyTerminalControlCheckbox.cs.

MyTerminalAction<TBlock> Sandbox.Game.Gui.MyTerminalControlCheckbox< TBlock >.EnableAction ( string  icon,
StringBuilder  name,
StringBuilder  onText,
StringBuilder  offText 
)
inline

Definition at line 89 of file MyTerminalControlCheckbox.cs.

override bool Sandbox.Game.Gui.MyTerminalControlCheckbox< TBlock >.GetDefaultValue ( TBlock  block)
inlinevirtual
override bool Sandbox.Game.Gui.MyTerminalControlCheckbox< TBlock >.GetMaximum ( TBlock  block)
inlinevirtual
override bool Sandbox.Game.Gui.MyTerminalControlCheckbox< TBlock >.GetMinimum ( TBlock  block)
inlinevirtual
override bool Sandbox.Game.Gui.MyTerminalControlCheckbox< TBlock >.GetValue ( TBlock  block)
inlinevirtual
override void Sandbox.Game.Gui.MyTerminalControlCheckbox< TBlock >.OnUpdateVisual ( )
inlineprotected

Definition at line 58 of file MyTerminalControlCheckbox.cs.

override void Sandbox.Game.Gui.MyTerminalControlCheckbox< TBlock >.SetValue ( TBlock  block,
bool  value 
)
inline

Definition at line 112 of file MyTerminalControlCheckbox.cs.

Member Data Documentation

Definition at line 29 of file MyTerminalControlCheckbox.cs.

Definition at line 28 of file MyTerminalControlCheckbox.cs.

Definition at line 27 of file MyTerminalControlCheckbox.cs.

Definition at line 30 of file MyTerminalControlCheckbox.cs.


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