Space Engineers
Public Member Functions | Public Attributes | Properties | List of all members
Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue > Class Template Referenceabstract
Inheritance diagram for Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue >:
Sandbox.Game.Gui.MyTerminalControl< TBlock > Sandbox.Game.Screens.Terminal.Controls.ITerminalValueControl< TBlock, TValue > Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalValueControl< TValue > Sandbox.Game.Gui.ITerminalControl Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl Sandbox.ModAPI.Interfaces.ITerminalProperty< TValue > Sandbox.Game.Gui.ITerminalControl Sandbox.Game.Gui.ITerminalControlSync Sandbox.ModAPI.Interfaces.ITerminalProperty Sandbox.Game.Screens.Terminal.Controls.MyTerminalControlProperty< TBlock, TValue >

Public Member Functions

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)
 
virtual TValue GetValue (TBlock block)
 
virtual void SetValue (TBlock block, TValue value)
 
virtual void Serialize (BitStream stream, TBlock block)
 
abstract TValue GetDefaultValue (TBlock block)
 
TValue GetMininum (TBlock block)
 
abstract TValue GetMinimum (TBlock block)
 
abstract TValue GetMaximum (TBlock block)
 
TValue GetValue (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
void SetValue (VRage.Game.ModAPI.Ingame.IMyCubeBlock block, TValue value)
 
TValue GetDefaultValue (VRage.Game.ModAPI.Ingame.IMyCubeBlock 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)
 
void Serialize (BitStream stream, MyTerminalBlock block)
 (De)serializes block data. More...
 
- Public Member Functions inherited from Sandbox.Game.Gui.MyTerminalControl< TBlock >
delegate void WriterDelegate (TBlock block, StringBuilder writeTo)
 
MyGuiControlBase GetGuiControl ()
 Returns control to show in terminal. When control does not exists yet, it creates it More...
 
 MyTerminalControl (string id)
 
void UpdateVisual ()
 This updates a control that is currently displayed, allowing you to refresh it's state More...
 
void RedrawControl ()
 Recreates the control GUI. This allows you to update the Title of some controls. More...
 

Public Attributes

SerializerDelegate Serializer
 Serializer which (de)serializes the value. More...
 
- Public Attributes inherited from Sandbox.Game.Gui.MyTerminalControl< TBlock >
readonly string Id
 
Func< TBlock, bool > Enabled = (b) => true
 
Func< TBlock, bool > Visible = (b) => true
 

Properties

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.Game.Gui.MyTerminalControl< TBlock >
ArrayOfTypeEnumerator< MyTerminalBlock, ArrayEnumerator< MyTerminalBlock >, TBlock > TargetBlocks [get]
 
TBlock FirstBlock [get]
 
bool SupportsMultipleBlocks [get, set]
 
MyTerminalAction< TBlock >[] Actions [get, protected set]
 
- Properties inherited from Sandbox.Game.Gui.ITerminalControl
string Id [get]
 
bool SupportsMultipleBlocks [get]
 If control supports multiple blocks The only control which does not is Name editor control More...
 
MyTerminalBlock[] TargetBlocks [get, set]
 Sets blocks which are controlled now More...
 
ITerminalAction[] Actions [get]
 Returns terminal actions 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< TValue >
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...
 

Additional Inherited Members

- Static Public Attributes inherited from Sandbox.Game.Gui.MyTerminalControl< TBlock >
static readonly float PREFERRED_CONTROL_WIDTH = 400f / MyGuiConstants.GUI_OPTIMAL_SIZE.X
 
static readonly MyTerminalBlock[] Empty = new MyTerminalBlock[0]
 
- Protected Member Functions inherited from Sandbox.Game.Gui.MyTerminalControl< TBlock >
abstract MyGuiControlBase CreateGui ()
 Called when app needs GUI (not on DS) More...
 
virtual void OnUpdateVisual ()
 Called when GUI needs update More...
 

Detailed Description

Type Constraints
TBlock :MyTerminalBlock 

Definition at line 15 of file MyTerminalValueControl.cs.

Constructor & Destructor Documentation

Definition at line 52 of file MyTerminalValueControl.cs.

Member Function Documentation

delegate void Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue >.ExternalSetterDelegate ( IMyTerminalBlock  block,
TValue  value 
)
abstract TValue Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue >.GetDefaultValue ( TBlock  block)
pure virtual

Definition at line 102 of file MyTerminalValueControl.cs.

abstract TValue Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue >.GetMaximum ( TBlock  block)
pure virtual

Definition at line 118 of file MyTerminalValueControl.cs.

abstract TValue Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue >.GetMinimum ( TBlock  block)
pure virtual

Definition at line 113 of file MyTerminalValueControl.cs.

TValue Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue >.GetMininum ( TBlock  block)
inline

Definition at line 108 of file MyTerminalValueControl.cs.

delegate TValue Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue >.GetterDelegate ( TBlock  block)
virtual TValue Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue >.GetValue ( TBlock  block)
inlinevirtual

Definition at line 92 of file MyTerminalValueControl.cs.

virtual void Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue >.Serialize ( BitStream  stream,
TBlock  block 
)
inlinevirtual
void Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue >.Serialize ( BitStream  stream,
MyTerminalBlock  block 
)
inline

(De)serializes block data.

Implements Sandbox.Game.Gui.ITerminalControlSync.

Definition at line 123 of file MyTerminalValueControl.cs.

delegate void Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue >.SerializerDelegate ( BitStream  stream,
ref TValue  value 
)
delegate void Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue >.SetterDelegate ( TBlock  block,
TValue  value 
)
virtual void Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue >.SetValue ( TBlock  block,
TValue  value 
)
inlinevirtual
void Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue >.SetValue ( VRage.Game.ModAPI.Ingame.IMyCubeBlock  block,
TValue  value 
)
inline

Definition at line 97 of file MyTerminalValueControl.cs.

Member Data Documentation

Serializer which (de)serializes the value.

Definition at line 40 of file MyTerminalValueControl.cs.

Property Documentation

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.

Definition at line 28 of file MyTerminalValueControl.cs.

Expression<Func<TBlock, TValue> > Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, TValue >.MemberExpression
set

Definition at line 43 of file MyTerminalValueControl.cs.

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.

Definition at line 35 of file MyTerminalValueControl.cs.


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