Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Properties | List of all members
Expansions.Missions.Adjusters.AdjusterPartModuleBase Class Reference
Inheritance diagram for Expansions.Missions.Adjusters.AdjusterPartModuleBase:
Expansions.Missions.DynamicModule IConfigNode Expansions.Missions.Adjusters.IPartModuleAdjuster IConfigNode Expansions.Missions.IMENodeDisplay Expansions.Missions.Adjusters.AdjusterActiveRadiatorBase Expansions.Missions.Adjusters.AdjusterAlternatorBase Expansions.Missions.Adjusters.AdjusterAnchoredDecouplerBase Expansions.Missions.Adjusters.AdjusterCargoBayBase Expansions.Missions.Adjusters.AdjusterControlSurfaceBase Expansions.Missions.Adjusters.AdjusterDataTransmitterBase Expansions.Missions.Adjusters.AdjusterDecoupleBase Expansions.Missions.Adjusters.AdjusterDeployablePartBase Expansions.Missions.Adjusters.AdjusterDeployableSolarPanelBase Expansions.Missions.Adjusters.AdjusterDockingNodeBase Expansions.Missions.Adjusters.AdjusterEnginesBase Expansions.Missions.Adjusters.AdjusterFuelLineBase Expansions.Missions.Adjusters.AdjusterGeneratorBase Expansions.Missions.Adjusters.AdjusterGimbalBase Expansions.Missions.Adjusters.AdjusterGPSBase Expansions.Missions.Adjusters.AdjusterGrappleNodeBase Expansions.Missions.Adjusters.AdjusterKerbNetAccessBase Expansions.Missions.Adjusters.AdjusterLiftingSurfaceBase Expansions.Missions.Adjusters.AdjusterLightBase Expansions.Missions.Adjusters.AdjusterProbeControlPointBase Expansions.Missions.Adjusters.AdjusterRCSBase Expansions.Missions.Adjusters.AdjusterReactionWheelBase Expansions.Missions.Adjusters.AdjusterResourceIntakeBase Expansions.Missions.Adjusters.AdjusterSASBase Expansions.Missions.Adjusters.AdjusterScienceExperimentBase Expansions.Missions.Adjusters.AdjusterToggleCrossfeedBase Expansions.Missions.Adjusters.AdjusterWheelBrakesBase Expansions.Missions.Adjusters.AdjusterWheelDeploymentBase Expansions.Missions.Adjusters.AdjusterWheelMotorBase

Public Types

enum  FailureActivationState : int { FailureActivationState.CurrentState, FailureActivationState.On, FailureActivationState.Off }
 We use this to specify the failure state for any part that can turn on and off More...
 
enum  FailureDeploymentState : int { FailureDeploymentState.CurrentState, FailureDeploymentState.Deployed, FailureDeploymentState.Retracted }
 We use this to specify the failure state for any part that can deploy More...
 
enum  FailureOpenState : int { FailureOpenState.CurrentState, FailureOpenState.Open, FailureOpenState.Closed }
 We use this to specify the failure state for any part that can open and close More...
 

Public Member Functions

virtual void Activate ()
 Activate this adjuster. More...
 
 AdjusterPartModuleBase ()
 Constructor More...
 
 AdjusterPartModuleBase (MENode node)
 Constructor More...
 
void CleanUp ()
 Call this to clean up all the bits and bobs from the part module adjuster. More...
 
virtual void Deactivate ()
 Deactivate this adjuster. More...
 
override string GetDisplayName ()
 Get the display name for this module More...
 
override string GetNodeBodyParameterString (BaseAPField field)
 Returns the string to be displayed when the parameter is displayed in the node body More...
 
List< Type > GetPartModulesThatCanBeAffected ()
 Get a list of all the part modules that can be affected by this adjuster. This method controls the manner in which we work out the part modules that can be affected. We take a list of the target classes, then figure out all of their children and add them all to a list of part modules that can be affected. If you just want to add an extra class or two to the list, override GetPartModuleTarget() or GetPartModuleTargetList() instead. More...
 
virtual List< Type > GetPartModuleTargetList ()
 Get a list of all the target part modules that can be affected by this adjuster. We'll use the information in GetPartModulesThatCanBeAffected() and search for all the child classes too. More...
 
virtual Type GetTargetPartModule ()
 Get the target part module that can be affected by this adjuster. We'll use the information in GetPartModulesThatCanBeAffected() and search for all the child classes too. More...
 
override void Load (ConfigNode node)
 
virtual void OnPartModuleAdjusterListModified ()
 Another part module adjuster has been added or removed to the affected part module. More...
 
void RemoveAdjuster ()
 
override void Save (ConfigNode node)
 
void Setup (PartModule newPartModule)
 Call this to set up this part module adjuster. More...
 
void UpdateStatusMessage (string newStatusMessage)
 Changes the status message for this adjuster to be displayed in the PAW. The status message stays the same until this method is called, so you don't have to call it every frame. More...
 
- Public Member Functions inherited from Expansions.Missions.DynamicModule
void AddParameterToNodeBody (string parameter)
 Add a parameter to be displayed in the node body Used for batch processing node body parameters If you want an immediate UI update, use AddParameterToNodeBodyAndUpdateUI More...
 
void AddParameterToNodeBodyAndUpdateUI (string parameter)
 Add a parameter to be displayed in the node body Then updates the UI on the node body More...
 
void AddParameterToSAP (string parameter)
 Add a parameter to be displayed in the Settings Action Pane More...
 
virtual object Clone ()
 
virtual void Destroy ()
 Perform all the cleaning operations that we need before the module is destroyed. More...
 
 DynamicModule ()
 
 DynamicModule (MENode node)
 Creates a new instance of this dynamic module More...
 
override bool Equals (object obj)
 
virtual List< string > GetDefaultPinnedParameters ()
 Get a list of default node pinned parameters for this dynamic module More...
 
virtual string GetDisplayToolTip ()
 Get the tooltip for this module UI More...
 
override int GetHashCode ()
 
virtual string GetInfo ()
 Get the information to be displayed about the module in the tooltip. More...
 
List< IMENodeDisplayGetInternalParametersToDisplay ()
 Gets some more parameters to display. More...
 
string GetName ()
 Get the name of the action module More...
 
MENode GetNode ()
 Get the linked Mission node. More...
 
bool HasNodeBodyParameter (string parameter)
 Evaluates if the parameter is present in the node body display parameters More...
 
bool HasSAPParameter (string parameter)
 Evaluates if the parameter is present in the SAP More...
 
virtual void Initialize ()
 Perform all the setup operations that we need when the module is initialised in the mission builder. More...
 
virtual void ParameterSetupComplete ()
 Can be used as a hook once all the parameters in a module have been setup and/or displayed in the SAP. More...
 
void RemoveParameterFromNodeBody (string parameter)
 Add a parameter to be displayed in the node body Used for batch processing node body parameters If you want an immediate UI update, use AddParameterToNodeBodyAndUpdateUI More...
 
void RemoveParameterFromNodeBodyAndUpdateUI (string parameter)
 Removes a parameter to be displayed in the node body Then updates the UI on the node body More...
 
void RemoveParameterFromSAP (string parameter)
 Remove a parameter to be displayed in the Settings Action Pane More...
 
void SetNode (MENode node)
 Sets the linked Mission Node More...
 
void UpdateNodeBodyUI ()
 Updates the node body parameters More...
 

Static Public Member Functions

static AdjusterPartModuleBase CreateInstanceOfModuleAdjuster (ConfigNode node)
 Creates a new part module adjuster, then loads the node information into it. More...
 
static AdjusterPartModuleBase CreateInstanceOfModuleAdjuster (string className)
 Creates a new part module adjuster. More...
 
static List
< AdjusterPartModuleBase
CreateModuleAdjusterList (ConfigNode node)
 

Public Attributes

Guid adjusterID
 Unique ID to identify this part adjuster More...
 
string AdjusterState = "#autoLOC_8100276"
 Field which is displayed in the PAW to show the status of the module adjuster. More...
 
bool canBeRepaired
 Is this adjuster a failure that can be repaired? More...
 
bool disableKSPActions
 Should all the part module KSP actions be disabled? More...
 
bool disableKSPEvents
 Should all the part module KSP events be disabled? More...
 
bool disableKSPFields
 Should all the part module KSP Fields be disabled? More...
 
- Public Attributes inherited from Expansions.Missions.DynamicModule
List< string > parametersDisplayedInSAP
 The parameters displayed in the Settings Action Pane More...
 

Protected Attributes

PartModule adjustedModule
 
string guiName = "#autoLOC_8000002"
 Name for this adjuster used in all the displays More...
 
- Protected Attributes inherited from Expansions.Missions.DynamicModule
MENode node
 Refernce to the Node that the action is part of More...
 

Properties

int ClassID [get]
 Hash code of the class name. More...
 
string ClassName [get]
 Class name. More...
 
BaseEventList Events [get]
 All the PAW events supported by the adjuster More...
 
BaseFieldList Fields [get]
 All the PAW fields supported by the adjuster More...
 
- Properties inherited from Expansions.Missions.DynamicModule
virtual bool canBeDisplayedInEditor [get]
 Does this dynamic module can be displayed in the editor More...
 
string id [get, set]
 Id of this dynamic module instance, this is a unique autogenerated number to diferenciate mutliple instance of the same type More...
 
string name [get, set]
 the name of the module class More...
 

Member Enumeration Documentation

We use this to specify the failure state for any part that can turn on and off

Enumerator
CurrentState 
On 
Off 

We use this to specify the failure state for any part that can deploy

Enumerator
CurrentState 
Deployed 
Retracted 

We use this to specify the failure state for any part that can open and close

Enumerator
CurrentState 
Open 
Closed 

Constructor & Destructor Documentation

Expansions.Missions.Adjusters.AdjusterPartModuleBase.AdjusterPartModuleBase ( )
inline

Constructor

Expansions.Missions.Adjusters.AdjusterPartModuleBase.AdjusterPartModuleBase ( MENode  node)
inline

Constructor

Member Function Documentation

virtual void Expansions.Missions.Adjusters.AdjusterPartModuleBase.Activate ( )
inlinevirtual

Activate this adjuster.

Reimplemented in Expansions.Missions.Adjusters.AdjusterReactionWheelTorque, Expansions.Missions.Adjusters.AdjusterGimbalLimitControl, Expansions.Missions.Adjusters.FailureLightFlickering, Expansions.Missions.Adjusters.FailureWheelDeploymentStuck, Expansions.Missions.Adjusters.FailureDeployablePartStuck, Expansions.Missions.Adjusters.FailureCrossfeedStuck, Expansions.Missions.Adjusters.FailureCargoBayStuck, Expansions.Missions.Adjusters.FailureLightStuck, Expansions.Missions.Adjusters.FailureResourceIntakeStuck, Expansions.Missions.Adjusters.AdjusterActiveRadiatorMaxEnergyTransfer, Expansions.Missions.Adjusters.FailureActiveRadiatorStuck, Expansions.Missions.Adjusters.FailureReactionWheelStuck, Expansions.Missions.Adjusters.AdjusterAlternatorOutput, Expansions.Missions.Adjusters.AdjusterControlSurfaceActuatorSpeed, Expansions.Missions.Adjusters.AdjusterDataTransmitterPower, Expansions.Missions.Adjusters.AdjusterDeployableSolarPanelEfficiency, Expansions.Missions.Adjusters.AdjusterGeneratorEfficiency, Expansions.Missions.Adjusters.AdjusterLiftingSurfaceLiftForce, Expansions.Missions.Adjusters.AdjusterWheelBrakesTorque, Expansions.Missions.Adjusters.AdjusterWheelMotorTorque, Expansions.Missions.Adjusters.AdjusterEnginesThrottle, Expansions.Missions.Adjusters.AdjusterLightIntensity, Expansions.Missions.Adjusters.AdjusterSASServiceLevel, Expansions.Missions.Adjusters.FailureAnchoredDecouplerCantDecouple, Expansions.Missions.Adjusters.FailureFuelLineBlocked, Expansions.Missions.Adjusters.AdjusterKerbNetAccessDisabled, Expansions.Missions.Adjusters.FailureControlSurfaceDisableControl, Expansions.Missions.Adjusters.FailureDataTransmitterBroken, Expansions.Missions.Adjusters.FailureDecoupleCantDecouple, Expansions.Missions.Adjusters.FailureEnginesDeadEngine, Expansions.Missions.Adjusters.FailureGPSNoDisplay, Expansions.Missions.Adjusters.FailureRCSFireRandomly, Expansions.Missions.Adjusters.FailureRCSStopWorking, Expansions.Missions.Adjusters.FailureReactionWheelBroken, Expansions.Missions.Adjusters.FailureScienceExperimentDisable, Expansions.Missions.Adjusters.FailureDockingNodeCantUndock, Expansions.Missions.Adjusters.FailureGrappleNodeCantGrapple, and Expansions.Missions.Adjusters.FailureGrappleNodeCantRelease.

void Expansions.Missions.Adjusters.AdjusterPartModuleBase.CleanUp ( )
inline

Call this to clean up all the bits and bobs from the part module adjuster.

static AdjusterPartModuleBase Expansions.Missions.Adjusters.AdjusterPartModuleBase.CreateInstanceOfModuleAdjuster ( ConfigNode  node)
inlinestatic

Creates a new part module adjuster, then loads the node information into it.

Parameters
nodeConfig node to load into the new module adjuster.
Returns
Returns the new module adjuster.
static AdjusterPartModuleBase Expansions.Missions.Adjusters.AdjusterPartModuleBase.CreateInstanceOfModuleAdjuster ( string  className)
inlinestatic

Creates a new part module adjuster.

Parameters
classNameClass name of the new module adjuster.
Returns
Returns the new module adjuster.
static List<AdjusterPartModuleBase> Expansions.Missions.Adjusters.AdjusterPartModuleBase.CreateModuleAdjusterList ( ConfigNode  node)
inlinestatic

Creates a new list of part module adjusters, and loads the node information into it.

Parameters
nodeConfig node to load into the new module adjuster list.
Returns
Returns the new module adjuster list.
virtual void Expansions.Missions.Adjusters.AdjusterPartModuleBase.Deactivate ( )
inlinevirtual
override string Expansions.Missions.Adjusters.AdjusterPartModuleBase.GetDisplayName ( )
inlinevirtual

Get the display name for this module

Returns

Reimplemented from Expansions.Missions.DynamicModule.

override string Expansions.Missions.Adjusters.AdjusterPartModuleBase.GetNodeBodyParameterString ( BaseAPField  field)
inlinevirtual
List<Type> Expansions.Missions.Adjusters.AdjusterPartModuleBase.GetPartModulesThatCanBeAffected ( )
inline

Get a list of all the part modules that can be affected by this adjuster. This method controls the manner in which we work out the part modules that can be affected. We take a list of the target classes, then figure out all of their children and add them all to a list of part modules that can be affected. If you just want to add an extra class or two to the list, override GetPartModuleTarget() or GetPartModuleTargetList() instead.

Returns
Returns a list of all the part modules that this adjuster can affect.
virtual List<Type> Expansions.Missions.Adjusters.AdjusterPartModuleBase.GetPartModuleTargetList ( )
inlinevirtual

Get a list of all the target part modules that can be affected by this adjuster. We'll use the information in GetPartModulesThatCanBeAffected() and search for all the child classes too.

Returns
Returns a list of the target part modules that this adjuster can affect.
virtual Type Expansions.Missions.Adjusters.AdjusterPartModuleBase.GetTargetPartModule ( )
inlinevirtual

Get the target part module that can be affected by this adjuster. We'll use the information in GetPartModulesThatCanBeAffected() and search for all the child classes too.

Returns
Returns the target part module that this adjuster can affect.

Reimplemented in Expansions.Missions.Adjusters.AdjusterActiveRadiatorBase, Expansions.Missions.Adjusters.AdjusterFuelLineBase, Expansions.Missions.Adjusters.AdjusterProbeControlPointBase, Expansions.Missions.Adjusters.AdjusterWheelBrakesBase, Expansions.Missions.Adjusters.AdjusterWheelDeploymentBase, Expansions.Missions.Adjusters.AdjusterWheelMotorBase, Expansions.Missions.Adjusters.AdjusterAlternatorBase, Expansions.Missions.Adjusters.AdjusterCargoBayBase, Expansions.Missions.Adjusters.AdjusterControlSurfaceBase, Expansions.Missions.Adjusters.AdjusterDataTransmitterBase, Expansions.Missions.Adjusters.AdjusterDecoupleBase, Expansions.Missions.Adjusters.AdjusterDeployablePartBase, Expansions.Missions.Adjusters.AdjusterDeployableSolarPanelBase, Expansions.Missions.Adjusters.AdjusterDockingNodeBase, Expansions.Missions.Adjusters.AdjusterGimbalBase, Expansions.Missions.Adjusters.AdjusterGPSBase, Expansions.Missions.Adjusters.AdjusterGrappleNodeBase, Expansions.Missions.Adjusters.AdjusterKerbNetAccessBase, Expansions.Missions.Adjusters.AdjusterLiftingSurfaceBase, Expansions.Missions.Adjusters.AdjusterLightBase, Expansions.Missions.Adjusters.AdjusterReactionWheelBase, Expansions.Missions.Adjusters.AdjusterResourceIntakeBase, Expansions.Missions.Adjusters.AdjusterScienceExperimentBase, Expansions.Missions.Adjusters.AdjusterToggleCrossfeedBase, Expansions.Missions.Adjusters.AdjusterEnginesBase, Expansions.Missions.Adjusters.AdjusterGeneratorBase, Expansions.Missions.Adjusters.AdjusterRCSBase, Expansions.Missions.Adjusters.AdjusterSASBase, and Expansions.Missions.Adjusters.AdjusterAnchoredDecouplerBase.

override void Expansions.Missions.Adjusters.AdjusterPartModuleBase.Load ( ConfigNode  node)
inlinevirtual
virtual void Expansions.Missions.Adjusters.AdjusterPartModuleBase.OnPartModuleAdjusterListModified ( )
inlinevirtual

Another part module adjuster has been added or removed to the affected part module.

void Expansions.Missions.Adjusters.AdjusterPartModuleBase.RemoveAdjuster ( )
inline
override void Expansions.Missions.Adjusters.AdjusterPartModuleBase.Save ( ConfigNode  node)
inlinevirtual
void Expansions.Missions.Adjusters.AdjusterPartModuleBase.Setup ( PartModule  newPartModule)
inline

Call this to set up this part module adjuster.

Parameters
newPartModulePart module to which this adjuster is being applied.
void Expansions.Missions.Adjusters.AdjusterPartModuleBase.UpdateStatusMessage ( string  newStatusMessage)
inline

Changes the status message for this adjuster to be displayed in the PAW. The status message stays the same until this method is called, so you don't have to call it every frame.

Parameters
newStatusMessageNew status message to be displayed.

Member Data Documentation

PartModule Expansions.Missions.Adjusters.AdjusterPartModuleBase.adjustedModule
protected
Guid Expansions.Missions.Adjusters.AdjusterPartModuleBase.adjusterID

Unique ID to identify this part adjuster

string Expansions.Missions.Adjusters.AdjusterPartModuleBase.AdjusterState = "#autoLOC_8100276"

Field which is displayed in the PAW to show the status of the module adjuster.

bool Expansions.Missions.Adjusters.AdjusterPartModuleBase.canBeRepaired

Is this adjuster a failure that can be repaired?

bool Expansions.Missions.Adjusters.AdjusterPartModuleBase.disableKSPActions

Should all the part module KSP actions be disabled?

bool Expansions.Missions.Adjusters.AdjusterPartModuleBase.disableKSPEvents

Should all the part module KSP events be disabled?

bool Expansions.Missions.Adjusters.AdjusterPartModuleBase.disableKSPFields

Should all the part module KSP Fields be disabled?

string Expansions.Missions.Adjusters.AdjusterPartModuleBase.guiName = "#autoLOC_8000002"
protected

Name for this adjuster used in all the displays

Property Documentation

int Expansions.Missions.Adjusters.AdjusterPartModuleBase.ClassID
get

Hash code of the class name.

string Expansions.Missions.Adjusters.AdjusterPartModuleBase.ClassName
get

Class name.

BaseEventList Expansions.Missions.Adjusters.AdjusterPartModuleBase.Events
get

All the PAW events supported by the adjuster

BaseFieldList Expansions.Missions.Adjusters.AdjusterPartModuleBase.Fields
get

All the PAW fields supported by the adjuster


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