Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SaveUpgradePipeline.ModuleReplace Class Referenceabstract
Inheritance diagram for SaveUpgradePipeline.ModuleReplace:
SaveUpgradePipeline.UpgradeScript SaveUpgradePipeline.v1123_dockingNode

Public Member Functions

override TestResult OnTest (ConfigNode node, LoadContext loadContext, ref string nodeName)
 
override 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...
 
- Public Member Functions inherited from SaveUpgradePipeline.UpgradeScript
bool AppliesInContext (LoadContext ctx)
 
void Init (LoadContext contextMask, string nodeUrlCraft, string nodeUrlSFS)
 
virtual TestResult Test (ConfigNode n, LoadContext loadContext)
 
override string ToString ()
 
virtual void Upgrade (ConfigNode n, LoadContext loadContext)
 

Protected Member Functions

override void OnInit ()
 
abstract void Setup (out string moduleName, out string newModuleName)
 
- Protected Member Functions inherited from SaveUpgradePipeline.UpgradeScript
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)
 
void RecurseNodes (ConfigNode node, string[] urlNodes, int level, Callback< ConfigNode, ConfigNode > cb, ConfigNode parent=null)
 
virtual TestResult VersionTest (Version v)
 

Protected Attributes

string moduleName
 
string newModuleName
 
- Protected Attributes inherited from SaveUpgradePipeline.UpgradeScript
string nodeUrlCraft
 
string nodeUrlSFS
 

Additional Inherited Members

- Public Attributes inherited from SaveUpgradePipeline.UpgradeScript
LoadContext ContextMask
 
- Properties inherited from SaveUpgradePipeline.UpgradeScript
abstract string Description [get]
 
abstract Version EarliestCompatibleVersion [get]
 
abstract string Name [get]
 
abstract Version TargetVersion [get]
 

Member Function Documentation

override void SaveUpgradePipeline.ModuleReplace.OnInit ( )
inlineprotectedvirtual

Reimplemented from SaveUpgradePipeline.UpgradeScript.

override TestResult SaveUpgradePipeline.ModuleReplace.OnTest ( ConfigNode  node,
LoadContext  loadContext,
ref string  nodeName 
)
inlinevirtual
override void SaveUpgradePipeline.ModuleReplace.OnUpgrade ( ConfigNode  node,
LoadContext  loadContext,
ConfigNode  parentNode 
)
inlinevirtual

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

Implements SaveUpgradePipeline.UpgradeScript.

abstract void SaveUpgradePipeline.ModuleReplace.Setup ( out string  moduleName,
out string  newModuleName 
)
protectedpure virtual

Member Data Documentation

string SaveUpgradePipeline.ModuleReplace.moduleName
protected
string SaveUpgradePipeline.ModuleReplace.newModuleName
protected

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