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.PartOffset Class Referenceabstract
Inheritance diagram for SaveUpgradePipeline.PartOffset:
SaveUpgradePipeline.UpgradeScript 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

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 pName, out Vector3 posOffset, out Quaternion rotOffset)
 
- 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 partName
 
Vector3 position
 Final Part Position - including rotation More...
 
Vector3 position0
 Original Part Position More...
 
Vector3 positionOffset
 the position offset in part local space More...
 
Quaternion rotation
 Final Part Rotation More...
 
Quaternion rotation0 = Quaternion.identity
 Original Part Rotation More...
 
Quaternion rotationOffset
 the rotation offset, in part local space More...
 
- 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.PartOffset.OnInit ( )
inlineprotectedvirtual

Reimplemented from SaveUpgradePipeline.UpgradeScript.

Reimplemented in SaveUpgradePipeline.PartReplace.

override TestResult SaveUpgradePipeline.PartOffset.OnTest ( ConfigNode  node,
LoadContext  loadContext,
ref string  nodeName 
)
inlinevirtual

Implements SaveUpgradePipeline.UpgradeScript.

Reimplemented in SaveUpgradePipeline.PartReplace.

override void SaveUpgradePipeline.PartOffset.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.

Reimplemented in SaveUpgradePipeline.PartReplace, 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, and SaveUpgradePipeline.v170_stackSeparatorBig.

abstract void SaveUpgradePipeline.PartOffset.Setup ( out string  pName,
out Vector3  posOffset,
out Quaternion  rotOffset 
)
protectedpure virtual

Implemented in SaveUpgradePipeline.PartReplace, SaveUpgradePipeline.v110_LandingGearOffset, SaveUpgradePipeline.v110_LandingLegLT1Offset, and SaveUpgradePipeline.v110_LandingLegLT2Offset.

Member Data Documentation

string SaveUpgradePipeline.PartOffset.partName
protected
Vector3 SaveUpgradePipeline.PartOffset.position
protected

Final Part Position - including rotation

Vector3 SaveUpgradePipeline.PartOffset.position0
protected

Original Part Position

Vector3 SaveUpgradePipeline.PartOffset.positionOffset
protected

the position offset in part local space

Quaternion SaveUpgradePipeline.PartOffset.rotation
protected

Final Part Rotation

Quaternion SaveUpgradePipeline.PartOffset.rotation0 = Quaternion.identity
protected

Original Part Rotation

Quaternion SaveUpgradePipeline.PartOffset.rotationOffset
protected

the rotation offset, in part local space

Note: does not change child parts, just the part

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