Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
SaveUpgradePipeline.UpgradeScript Class Referenceabstract
Inheritance diagram for SaveUpgradePipeline.UpgradeScript:
SaveUpgradePipeline.ModuleReplace SaveUpgradePipeline.PartOffset SaveUpgradePipeline.v110_WheelModuleOverhaul SaveUpgradePipeline.v180_ModuleAeroSurface SaveUpgradePipeline.v180_ModuleControlSurface SaveUpgradePipeline.v1123_dockingNode SaveUpgradePipeline.PartReplace SaveUpgradePipeline.v110_LandingGearOffset SaveUpgradePipeline.v110_LandingLegLT1Offset SaveUpgradePipeline.v110_LandingLegLT2Offset SaveUpgradePipeline.probeCoreSphere SaveUpgradePipeline.v1120_engineLargeSkipper SaveUpgradePipeline.v1120_liquidEngine1_2 SaveUpgradePipeline.v1120_liquidEngine2_2 SaveUpgradePipeline.v1120_liquidEngine3 SaveUpgradePipeline.v1120_liquidEngineMini SaveUpgradePipeline.v1120_microEngine SaveUpgradePipeline.v1120_mk1pod SaveUpgradePipeline.v1120_probeCoreOcto SaveUpgradePipeline.v1120_probeCoreOcto2 SaveUpgradePipeline.v1120_radialEngineMini SaveUpgradePipeline.v1120_RCSBlock SaveUpgradePipeline.v1120_rocketNoseCone SaveUpgradePipeline.v1120_ServiceBay_125 SaveUpgradePipeline.v1120_ServiceBay_250 SaveUpgradePipeline.v1120_Size3to2Adapter SaveUpgradePipeline.v1120_solidBooster SaveUpgradePipeline.v1120_solidBooster_sm SaveUpgradePipeline.v1120_stackBiCoupler SaveUpgradePipeline.v1120_stackTriCoupler SaveUpgradePipeline.v170_fuelTank1_2 SaveUpgradePipeline.v170_fuelTank2_2 SaveUpgradePipeline.v170_fuelTank3_2 SaveUpgradePipeline.v170_fuelTank4_2 SaveUpgradePipeline.v170_mk1_2 SaveUpgradePipeline.v170_stackDecoupler SaveUpgradePipeline.v170_stackDecoupler1_2 SaveUpgradePipeline.v170_stackDecouplerMini SaveUpgradePipeline.v170_stackDecouplerSize3 SaveUpgradePipeline.v170_stackSeparator SaveUpgradePipeline.v170_stackSeparatorBig SaveUpgradePipeline.v170_stackSeparatorMini SaveUpgradePipeline.v170_toroidalFuelTank

Public Member Functions

bool AppliesInContext (LoadContext ctx)
 
void Init (LoadContext contextMask, string nodeUrlCraft, string nodeUrlSFS)
 
abstract TestResult OnTest (ConfigNode node, LoadContext loadContext, ref string nodeName)
 
abstract void OnUpgrade (ConfigNode node, LoadContext loadContext, ConfigNode parentNode)
 The OnUpgrade method that is called when a node has tested successfully and will be actioned More...
 
virtual TestResult Test (ConfigNode n, LoadContext loadContext)
 
override string ToString ()
 
virtual void Upgrade (ConfigNode n, LoadContext loadContext)
 

Public Attributes

LoadContext ContextMask
 

Protected Member Functions

virtual bool CheckMaxVersion (Version v)
 
virtual bool CheckMinVersion (Version v)
 
virtual Version GetCfgNodeVersion (ConfigNode n, LoadContext loadContext)
 
string GetNodeURL (LoadContext loadContext)
 
void LogTestResults (string nodeName, TestResult test)
 
virtual void OnInit ()
 
void RecurseNodes (ConfigNode node, string[] urlNodes, int level, Callback< ConfigNode, ConfigNode > cb, ConfigNode parent=null)
 
virtual TestResult VersionTest (Version v)
 

Protected Attributes

string nodeUrlCraft
 
string nodeUrlSFS
 

Properties

abstract string Description [get]
 
abstract Version EarliestCompatibleVersion [get]
 
abstract string Name [get]
 
abstract Version TargetVersion [get]
 

Member Function Documentation

bool SaveUpgradePipeline.UpgradeScript.AppliesInContext ( LoadContext  ctx)
inline
virtual bool SaveUpgradePipeline.UpgradeScript.CheckMaxVersion ( Version  v)
inlineprotectedvirtual
virtual bool SaveUpgradePipeline.UpgradeScript.CheckMinVersion ( Version  v)
inlineprotectedvirtual
virtual Version SaveUpgradePipeline.UpgradeScript.GetCfgNodeVersion ( ConfigNode  n,
LoadContext  loadContext 
)
inlineprotectedvirtual
string SaveUpgradePipeline.UpgradeScript.GetNodeURL ( LoadContext  loadContext)
inlineprotected
void SaveUpgradePipeline.UpgradeScript.Init ( LoadContext  contextMask,
string  nodeUrlCraft,
string  nodeUrlSFS 
)
inline
void SaveUpgradePipeline.UpgradeScript.LogTestResults ( string  nodeName,
TestResult  test 
)
inlineprotected
virtual void SaveUpgradePipeline.UpgradeScript.OnInit ( )
inlineprotectedvirtual

Reimplemented in SaveUpgradePipeline.PartReplace, SaveUpgradePipeline.PartOffset, and SaveUpgradePipeline.ModuleReplace.

abstract TestResult SaveUpgradePipeline.UpgradeScript.OnTest ( ConfigNode  node,
LoadContext  loadContext,
ref string  nodeName 
)
pure virtual

Implemented in SaveUpgradePipeline.PartReplace, SaveUpgradePipeline.v110_WheelModuleOverhaul, SaveUpgradePipeline.v180_ModuleAeroSurface, SaveUpgradePipeline.v180_ModuleControlSurface, SaveUpgradePipeline.PartOffset, and SaveUpgradePipeline.ModuleReplace.

abstract void SaveUpgradePipeline.UpgradeScript.OnUpgrade ( ConfigNode  node,
LoadContext  loadContext,
ConfigNode  parentNode 
)
pure virtual

The OnUpgrade method that is called when a node has tested successfully and will be actioned

Parameters
nodeThe node to be actioned
loadContextWhat load context is the node being accessed in
parentNodeThe parent of this node from the recurse process - typically used to get the vessel from a part

Implemented in SaveUpgradePipeline.PartReplace, SaveUpgradePipeline.v110_WheelModuleOverhaul, SaveUpgradePipeline.PartOffset, SaveUpgradePipeline.v180_ModuleAeroSurface, SaveUpgradePipeline.v180_ModuleControlSurface, SaveUpgradePipeline.v1120_ServiceBay_125, SaveUpgradePipeline.v1120_ServiceBay_250, SaveUpgradePipeline.v1120_stackTriCoupler, SaveUpgradePipeline.v1120_stackBiCoupler, SaveUpgradePipeline.v1120_engineLargeSkipper, SaveUpgradePipeline.v1120_liquidEngine1_2, SaveUpgradePipeline.v1120_liquidEngine2_2, SaveUpgradePipeline.v1120_liquidEngine3, SaveUpgradePipeline.v1120_liquidEngineMini, SaveUpgradePipeline.v1120_microEngine, SaveUpgradePipeline.v1120_mk1pod, SaveUpgradePipeline.v1120_probeCoreOcto, SaveUpgradePipeline.v1120_probeCoreOcto2, SaveUpgradePipeline.v1120_Size3to2Adapter, SaveUpgradePipeline.v1120_solidBooster, SaveUpgradePipeline.v1120_solidBooster_sm, SaveUpgradePipeline.v170_stackDecoupler, SaveUpgradePipeline.v170_stackDecoupler1_2, SaveUpgradePipeline.v170_stackDecouplerMini, SaveUpgradePipeline.v170_stackDecouplerSize3, SaveUpgradePipeline.v170_stackSeparator, SaveUpgradePipeline.v170_stackSeparatorMini, SaveUpgradePipeline.v170_toroidalFuelTank, SaveUpgradePipeline.probeCoreSphere, SaveUpgradePipeline.v1120_rocketNoseCone, SaveUpgradePipeline.v1120_radialEngineMini, SaveUpgradePipeline.v1120_RCSBlock, SaveUpgradePipeline.v170_fuelTank1_2, SaveUpgradePipeline.v170_fuelTank2_2, SaveUpgradePipeline.v170_fuelTank3_2, SaveUpgradePipeline.v170_fuelTank4_2, SaveUpgradePipeline.v170_mk1_2, SaveUpgradePipeline.v170_stackSeparatorBig, and SaveUpgradePipeline.ModuleReplace.

void SaveUpgradePipeline.UpgradeScript.RecurseNodes ( ConfigNode  node,
string[]  urlNodes,
int  level,
Callback< ConfigNode, ConfigNode >  cb,
ConfigNode  parent = null 
)
inlineprotected
virtual TestResult SaveUpgradePipeline.UpgradeScript.Test ( ConfigNode  n,
LoadContext  loadContext 
)
inlinevirtual

< results might vary in each node, so the final result for a script follows this hierarchy:

override string SaveUpgradePipeline.UpgradeScript.ToString ( )
inline
virtual void SaveUpgradePipeline.UpgradeScript.Upgrade ( ConfigNode  n,
LoadContext  loadContext 
)
inlinevirtual
virtual TestResult SaveUpgradePipeline.UpgradeScript.VersionTest ( Version  v)
inlineprotectedvirtual

Member Data Documentation

LoadContext SaveUpgradePipeline.UpgradeScript.ContextMask
string SaveUpgradePipeline.UpgradeScript.nodeUrlCraft
protected
string SaveUpgradePipeline.UpgradeScript.nodeUrlSFS
protected

Property Documentation

abstract string SaveUpgradePipeline.UpgradeScript.Description
get
abstract Version SaveUpgradePipeline.UpgradeScript.EarliestCompatibleVersion
get
abstract string SaveUpgradePipeline.UpgradeScript.Name
get
abstract Version SaveUpgradePipeline.UpgradeScript.TargetVersion
get
The documentation for this class was generated from the following file:
API Download: HTML | XML
Generated on Tue Nov 1 2022 18:36:41 for Kerbal Space Program by   doxygen 1.8.7