Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Properties | List of all members
TransferTypeSimple Class Reference
Inheritance diagram for TransferTypeSimple:
TransferTypeBase

Public Member Functions

override bool ChangePosition (ManeuverNode node, out string errorString)
 
override void ChangeTime ()
 
override bool CreateManeuver (out ManeuverNode node, out string alarmTitle, out string alarmDesc)
 Called when the player clicks the Create Maneuver Button in the Maneuver Tool UI. This method should create the Manuever Node based on the TransferDataSimple. More...
 
override string DisplayName ()
 Should return a localized formatted Name for the Transfer Type. This will be displayed in the Maneuver tool Transfer Type dropdown list. More...
 
override void DrawTypeControls (ManeuverToolUIFrame appFrame, DrawReason reason)
 
override void HideApp ()
 Called when the app is hidden/closed. More...
 
void OnTargetClicked (int value)
 
override void OnUpdate ()
 Called in Update() from ManueverTool for the currently selected transfer type. More...
 
void UpdateTopData ()
 
override void UpdateTransferData ()
 Called to tell the Transfer Type to update it's TransferDataSimple. This will be called when UI values are changed. More...
 
- Public Member Functions inherited from TransferTypeBase
virtual bool FollowingManeuversCheck (TransferDataBase transferData, Callback onOk, Callback onLeave, Callback onCancel)
 Will check if there are any following maneuvers to newTime for vessel. If there are will display a dialog and return true. The dialog will then call onOk onLeave or onCancel callback. If there are no following maneuvers no dialog will display and will return false. More...
 
virtual bool PriorManeuversCheck (TransferDataBase transferData, Callback onOk, Callback onCancel)
 Will check if there are any prior maneuvers to newTime for vessel. If there are will display a dialog and return true. The dialog will then call onOk or onCancel callback. If there are no prior maneuvers no dialog will display and will return false. More...
 
 TransferTypeBase ()
 Constructor More...
 

Public Attributes

double topFrameUpdateIntervalSecs = 60
 The update interval for the top frame data in seconds. Will also update when other events occur, such as switch vessels, etc. More...
 
- Public Attributes inherited from TransferTypeBase
TransferDataBase currentSelectedTransfer
 The currently selected TransferDataBase for the transfer type instance. More...
 
TransferDataTopDataBase currentSelectTopData
 The current selected TransferDataTopDataBase for the transfer type instance. More...
 

Properties

TransferDataSimple currentSelectedTransfer [get, set]
 The currently selected TransferDataSimple for the transfer type instance. More...
 
TransferDataTopDataBase currentSelectedTransferTopData [get, set]
 This is the Data Instance for the dynamic UI controls shown in the Top window of the Maneuver Tool More...
 

Additional Inherited Members

- Public Types inherited from TransferTypeBase
enum  DrawReason { DrawReason.ManeuverChanged, DrawReason.VesselChanged, DrawReason.TransferTypeChanged, DrawReason.AppShown }
 

Member Function Documentation

override bool TransferTypeSimple.ChangePosition ( ManeuverNode  node,
out string  errorString 
)
inlinevirtual

Implements TransferTypeBase.

override void TransferTypeSimple.ChangeTime ( )
inlinevirtual

Implements TransferTypeBase.

override bool TransferTypeSimple.CreateManeuver ( out ManeuverNode  newNode,
out string  alarmTitle,
out string  alarmDesc 
)
inlinevirtual

Called when the player clicks the Create Maneuver Button in the Maneuver Tool UI. This method should create the Manuever Node based on the TransferDataSimple.

Parameters
newNodeThe created node (or null)
alarmTitleThe Alarm title for the maneuver
alarmDescThe Alarm description for the maneuver
Returns
True if the node was created

Implements TransferTypeBase.

override string TransferTypeSimple.DisplayName ( )
inlinevirtual

Should return a localized formatted Name for the Transfer Type. This will be displayed in the Maneuver tool Transfer Type dropdown list.

Returns

Implements TransferTypeBase.

override void TransferTypeSimple.DrawTypeControls ( ManeuverToolUIFrame  appFrame,
DrawReason  reason 
)
inlinevirtual

Implements TransferTypeBase.

override void TransferTypeSimple.HideApp ( )
inlinevirtual

Called when the app is hidden/closed.

Implements TransferTypeBase.

void TransferTypeSimple.OnTargetClicked ( int  value)
inline
override void TransferTypeSimple.OnUpdate ( )
inlinevirtual

Called in Update() from ManueverTool for the currently selected transfer type.

Implements TransferTypeBase.

void TransferTypeSimple.UpdateTopData ( )
inline
override void TransferTypeSimple.UpdateTransferData ( )
inlinevirtual

Called to tell the Transfer Type to update it's TransferDataSimple. This will be called when UI values are changed.

Returns

Implements TransferTypeBase.

Member Data Documentation

double TransferTypeSimple.topFrameUpdateIntervalSecs = 60

The update interval for the top frame data in seconds. Will also update when other events occur, such as switch vessels, etc.

Property Documentation

TransferDataSimple TransferTypeSimple.currentSelectedTransfer
getset

The currently selected TransferDataSimple for the transfer type instance.

TransferDataTopDataBase TransferTypeSimple.currentSelectedTransferTopData
getset

This is the Data Instance for the dynamic UI controls shown in the Top window of the Maneuver Tool


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