TransferTypeBase Class Reference

Inheritance diagram for TransferTypeBase:

Public Types
enum	DrawReason { DrawReason.ManeuverChanged, DrawReason.VesselChanged, DrawReason.TransferTypeChanged, DrawReason.AppShown }

Public Member Functions
abstract bool	ChangePosition (ManeuverNode node, out string errorString)
abstract void	ChangeTime ()
abstract bool	CreateManeuver (out ManeuverNode newNode, 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...
abstract 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...
abstract void	DrawTypeControls (ManeuverToolUIFrame appFrame, DrawReason reason)
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...
abstract void	HideApp ()
	Called when the app is hidden/closed. More...
abstract void	OnUpdate ()
	Called in Update() from ManueverTool for the currently selected transfer type. 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...
abstract void	UpdateTransferData ()
	Called to tell the Transfer Type to update it's TransferDataSimple. This will be called when UI values are changed. More...

Public Attributes
TransferDataBase	currentSelectedTransfer
	The currently selected TransferDataBase for the transfer type instance. More...
TransferDataTopDataBase	currentSelectTopData
	The current selected TransferDataTopDataBase for the transfer type instance. More...

Member Enumeration Documentation

enum TransferTypeBase.DrawReason

Enumerator
ManeuverChanged
VesselChanged
TransferTypeChanged
AppShown

Constructor & Destructor Documentation

TransferTypeBase.TransferTypeBase ( )

inline

Constructor

Member Function Documentation

abstract bool TransferTypeBase.ChangePosition ( ManeuverNode  node, out string  errorString  )

pure virtual

Implemented in TransferTypeSimple.

abstract void TransferTypeBase.ChangeTime ( )

pure virtual

Implemented in TransferTypeSimple.

abstract bool TransferTypeBase.CreateManeuver ( out ManeuverNode  newNode, out string  alarmTitle, out string  alarmDesc  )

pure virtual

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

newNode	The created node (or null)
alarmTitle	The Alarm title for the maneuver
alarmDesc	The Alarm description for the maneuver

Returns

True if the node was created

Implemented in TransferTypeSimple.

abstract string TransferTypeBase.DisplayName ( )

pure virtual

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

Returns

Implemented in TransferTypeSimple.

abstract void TransferTypeBase.DrawTypeControls ( ManeuverToolUIFrame  appFrame, DrawReason  reason  )

pure virtual

Implemented in TransferTypeSimple.

virtual bool TransferTypeBase.FollowingManeuversCheck ( TransferDataBase  transferData, Callback  onOk, Callback  onLeave, Callback  onCancel  )

inlinevirtual

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.

Parameters

transferData
onOk
onLeave
onCancel

Returns

abstract void TransferTypeBase.HideApp ( )

pure virtual

Called when the app is hidden/closed.

Implemented in TransferTypeSimple.

abstract void TransferTypeBase.OnUpdate ( )

pure virtual

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

Implemented in TransferTypeSimple.

virtual bool TransferTypeBase.PriorManeuversCheck ( TransferDataBase  transferData, Callback  onOk, Callback  onCancel  )

inlinevirtual

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.

Parameters

transferData
onOk
onCancel

Returns

abstract void TransferTypeBase.UpdateTransferData ( )

pure virtual

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

Returns

Implemented in TransferTypeSimple.

Member Data Documentation

TransferDataBase TransferTypeBase.currentSelectedTransfer

The currently selected TransferDataBase for the transfer type instance.

TransferDataTopDataBase TransferTypeBase.currentSelectTopData

The current selected TransferDataTopDataBase for the transfer type instance.

---

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

• KSP/Assets/Scripts/Manuever Planning/TransferTypeBase.cs