Expansions.Missions.DynamicModule Class Reference

Inheritance diagram for Expansions.Missions.DynamicModule:

Public Member Functions
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	GetDisplayName ()
	Get the display name for this 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< IMENodeDisplay >	GetInternalParametersToDisplay ()
	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...
virtual string	GetNodeBodyParameterString (BaseAPField field)
	Returns the string to be displayed when the parameter is displayed in the node body 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	Load (ConfigNode node)
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...
virtual void	Save (ConfigNode node)
void	SetNode (MENode node)
	Sets the linked Mission Node More...
void	UpdateNodeBodyUI ()
	Updates the node body parameters More...

Public Attributes
List< string >	parametersDisplayedInSAP
	The parameters displayed in the Settings Action Pane More...

Protected Attributes
MENode	node
	Refernce to the Node that the action is part of More...

Properties
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...

Constructor & Destructor Documentation

Expansions.Missions.DynamicModule.DynamicModule ( )

inline

Expansions.Missions.DynamicModule.DynamicModule ( MENode  node )

inline

Creates a new instance of this dynamic module

Member Function Documentation

void Expansions.Missions.DynamicModule.AddParameterToNodeBody ( string  parameter )

inline

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

Implements Expansions.Missions.IMENodeDisplay.

void Expansions.Missions.DynamicModule.AddParameterToNodeBodyAndUpdateUI ( string  parameter )

inline

Add a parameter to be displayed in the node body Then updates the UI on the node body

Implements Expansions.Missions.IMENodeDisplay.

void Expansions.Missions.DynamicModule.AddParameterToSAP ( string  parameter )

inline

Add a parameter to be displayed in the Settings Action Pane

Implements Expansions.Missions.IMENodeDisplay.

virtual object Expansions.Missions.DynamicModule.Clone ( )

inlinevirtual

virtual void Expansions.Missions.DynamicModule.Destroy ( )

inlinevirtual

Perform all the cleaning operations that we need before the module is destroyed.

override bool Expansions.Missions.DynamicModule.Equals ( object  obj )

inline

virtual List<string> Expansions.Missions.DynamicModule.GetDefaultPinnedParameters ( )

inlinevirtual

Get a list of default node pinned parameters for this dynamic module

Returns

Reimplemented in Expansions.Missions.ScoreModule_Accuracy, Expansions.Missions.ScoreModule_Resource, Expansions.Missions.ScoreModule_Modifier, Expansions.Missions.ScoreModule_Time, and Expansions.Missions.ScoreModule_Completion.

virtual string Expansions.Missions.DynamicModule.GetDisplayName ( )

inlinevirtual

Get the display name for this module

Returns

Implements Expansions.Missions.IMENodeDisplay.

Reimplemented in Expansions.Missions.Adjusters.AdjusterPartModuleBase, Expansions.Missions.AwardModule, Expansions.Missions.ScoreModule_Accuracy, Expansions.Missions.VesselRestriction_Resource, Expansions.Missions.VesselRestriction_Size, Expansions.Missions.VesselRestriction_Crew, Expansions.Missions.VesselRestriction_Mass, Expansions.Missions.ScoreModule_Modifier, Expansions.Missions.VesselRestriction_Stages, Expansions.Missions.VesselRestriction_Cost, Expansions.Missions.VesselRestriction, Expansions.Missions.VesselRestriction_PartCount, Expansions.Missions.VesselRestriction_RequiredParts, Expansions.Missions.ScoreModule_Time, Expansions.Missions.ScoreModule_Resource, and Expansions.Missions.ScoreModule_Completion.

virtual string Expansions.Missions.DynamicModule.GetDisplayToolTip ( )

inlinevirtual

Get the tooltip for this module UI

Returns

Reimplemented in Expansions.Missions.ScoreModule_Modifier, and Expansions.Missions.ScoreModule_Completion.

override int Expansions.Missions.DynamicModule.GetHashCode ( )

inline

virtual string Expansions.Missions.DynamicModule.GetInfo ( )

inlinevirtual

Get the information to be displayed about the module in the tooltip.

Returns

Information to be displayed about the module in the tooltip

Implements Expansions.Missions.IMENodeDisplay.

Reimplemented in Expansions.Missions.ScoreModule_Accuracy, Expansions.Missions.ScoreModule_Resource, Expansions.Missions.ScoreModule_Modifier, Expansions.Missions.ScoreModule_Time, and Expansions.Missions.ScoreModule_Completion.

List<IMENodeDisplay> Expansions.Missions.DynamicModule.GetInternalParametersToDisplay ( )

inline

Gets some more parameters to display.

Returns

Returns additional parameters that the module might want to display.

Implements Expansions.Missions.IMENodeDisplay.

string Expansions.Missions.DynamicModule.GetName ( )

inline

Get the name of the action module

Implements Expansions.Missions.IMENodeDisplay.

MENode Expansions.Missions.DynamicModule.GetNode ( )

inline

Get the linked Mission node.

Returns

Associated MENode or null

Implements Expansions.Missions.IMENodeDisplay.

virtual string Expansions.Missions.DynamicModule.GetNodeBodyParameterString ( BaseAPField  field )

inlinevirtual

Returns the string to be displayed when the parameter is displayed in the node body

Parameters

field

Returns

Implements Expansions.Missions.IMENodeDisplay.

Reimplemented in Expansions.Missions.Adjusters.AdjusterPartModuleBase, Expansions.Missions.ScoreModule_Accuracy, Expansions.Missions.Adjusters.FailureLightFlickering, Expansions.Missions.Adjusters.AdjusterReactionWheelTorque, Expansions.Missions.Adjusters.AdjusterGimbalLimitControl, Expansions.Missions.Adjusters.AdjusterDataTransmitterPower, Expansions.Missions.ScoreModule, Expansions.Missions.ScoreModule_Modifier, Expansions.Missions.ScoreModule_Resource, Expansions.Missions.Adjusters.AdjusterActiveRadiatorMaxEnergyTransfer, Expansions.Missions.Adjusters.AdjusterAlternatorOutput, Expansions.Missions.Adjusters.AdjusterDeployableSolarPanelEfficiency, Expansions.Missions.Adjusters.AdjusterLiftingSurfaceLiftForce, Expansions.Missions.Adjusters.AdjusterLightIntensity, Expansions.Missions.Adjusters.AdjusterWheelBrakesTorque, Expansions.Missions.Adjusters.AdjusterWheelMotorTorque, Expansions.Missions.Adjusters.AdjusterControlSurfaceActuatorSpeed, Expansions.Missions.Adjusters.AdjusterGeneratorEfficiency, Expansions.Missions.Adjusters.AdjusterEnginesThrottle, Expansions.Missions.Adjusters.AdjusterSASServiceLevel, and Expansions.Missions.ScoreModule_Time.

bool Expansions.Missions.DynamicModule.HasNodeBodyParameter ( string  parameter )

inline

Evaluates if the parameter is present in the node body display parameters

Parameters

parameter

Returns

Implements Expansions.Missions.IMENodeDisplay.

bool Expansions.Missions.DynamicModule.HasSAPParameter ( string  parameter )

inline

Evaluates if the parameter is present in the SAP

Parameters

parameter

Returns

Implements Expansions.Missions.IMENodeDisplay.

virtual void Expansions.Missions.DynamicModule.Initialize ( )

inlinevirtual

Perform all the setup operations that we need when the module is initialised in the mission builder.

virtual void Expansions.Missions.DynamicModule.Load ( ConfigNode  node )

inlinevirtual

Implements IConfigNode.

Reimplemented in Expansions.Missions.Adjusters.AdjusterPartModuleBase, Expansions.Missions.ScoreModule_Accuracy, Expansions.Missions.AwardModule_Fuel, Expansions.Missions.AwardModule, Expansions.Missions.ScoreModule_Resource, Expansions.Missions.ScoreModule_Modifier, Expansions.Missions.Adjusters.AdjusterReactionWheelTorque, Expansions.Missions.Adjusters.AdjusterGimbalLimitControl, Expansions.Missions.Adjusters.FailureLightFlickering, Expansions.Missions.Adjusters.AdjusterDataTransmitterPower, Expansions.Missions.ScoreModule_Time, Expansions.Missions.Adjusters.FailureActiveRadiatorStuck, Expansions.Missions.AwardModule_LandedOn, Expansions.Missions.Adjusters.FailureCargoBayStuck, Expansions.Missions.Adjusters.AdjusterAlternatorOutput, Expansions.Missions.Adjusters.AdjusterActiveRadiatorMaxEnergyTransfer, Expansions.Missions.Adjusters.AdjusterDeployableSolarPanelEfficiency, Expansions.Missions.Adjusters.AdjusterLiftingSurfaceLiftForce, Expansions.Missions.Adjusters.AdjusterLightIntensity, Expansions.Missions.Adjusters.AdjusterWheelBrakesTorque, Expansions.Missions.Adjusters.AdjusterWheelMotorTorque, Expansions.Missions.Adjusters.FailureDeployablePartStuck, Expansions.Missions.Adjusters.AdjusterControlSurfaceActuatorSpeed, Expansions.Missions.Adjusters.AdjusterGeneratorEfficiency, Expansions.Missions.Adjusters.FailureReactionWheelStuck, Expansions.Missions.ScoreModule_Completion, Expansions.Missions.Adjusters.AdjusterEnginesThrottle, Expansions.Missions.ScoreModule, Expansions.Missions.Adjusters.AdjusterSASServiceLevel, Expansions.Missions.VesselRestriction_Cost, Expansions.Missions.Adjusters.FailureWheelDeploymentStuck, Expansions.Missions.AwardModule_PlanetsLanded, Expansions.Missions.AwardModule_TraveledLessThan, Expansions.Missions.AwardModule_TraveledMoreThan, Expansions.Missions.Adjusters.FailureCrossfeedStuck, Expansions.Missions.Adjusters.FailureLightStuck, Expansions.Missions.Adjusters.FailureResourceIntakeStuck, Expansions.Missions.AwardModule_VesselsUsed, Expansions.Missions.AwardModule_KerbalsSurvived, Expansions.Missions.VesselRestriction_Resource, Expansions.Missions.VesselRestriction_Size, Expansions.Missions.VesselRestriction_Crew, Expansions.Missions.AwardModule_Score, Expansions.Missions.VesselRestriction_Mass, Expansions.Missions.AwardModule_MissionTime, Expansions.Missions.VesselRestriction_Stages, Expansions.Missions.VesselRestriction_PartCount, and Expansions.Missions.VesselRestriction_RequiredParts.

virtual void Expansions.Missions.DynamicModule.ParameterSetupComplete ( )

inlinevirtual

Can be used as a hook once all the parameters in a module have been setup and/or displayed in the SAP.

Implements Expansions.Missions.IMENodeDisplay.

void Expansions.Missions.DynamicModule.RemoveParameterFromNodeBody ( string  parameter )

inline

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

Implements Expansions.Missions.IMENodeDisplay.

void Expansions.Missions.DynamicModule.RemoveParameterFromNodeBodyAndUpdateUI ( string  parameter )

inline

Removes a parameter to be displayed in the node body Then updates the UI on the node body

Implements Expansions.Missions.IMENodeDisplay.

void Expansions.Missions.DynamicModule.RemoveParameterFromSAP ( string  parameter )

inline

Remove a parameter to be displayed in the Settings Action Pane

Implements Expansions.Missions.IMENodeDisplay.

virtual void Expansions.Missions.DynamicModule.Save ( ConfigNode  node )

inlinevirtual

Implements IConfigNode.

Reimplemented in Expansions.Missions.Adjusters.AdjusterPartModuleBase, Expansions.Missions.AwardModule_Fuel, Expansions.Missions.ScoreModule_Accuracy, Expansions.Missions.ScoreModule_Resource, Expansions.Missions.AwardModule, Expansions.Missions.ScoreModule_Modifier, Expansions.Missions.ScoreModule_Time, Expansions.Missions.Adjusters.AdjusterReactionWheelTorque, Expansions.Missions.Adjusters.AdjusterGimbalLimitControl, Expansions.Missions.Adjusters.FailureLightFlickering, Expansions.Missions.AwardModule_LandedOn, Expansions.Missions.Adjusters.AdjusterDataTransmitterPower, Expansions.Missions.VesselRestriction_Cost, Expansions.Missions.Adjusters.FailureActiveRadiatorStuck, Expansions.Missions.AwardModule_VesselsUsed, Expansions.Missions.ScoreModule_Completion, Expansions.Missions.AwardModule_PlanetsLanded, Expansions.Missions.AwardModule_TraveledLessThan, Expansions.Missions.AwardModule_TraveledMoreThan, Expansions.Missions.ScoreModule, Expansions.Missions.Adjusters.FailureCargoBayStuck, Expansions.Missions.VesselRestriction_Resource, Expansions.Missions.VesselRestriction_Size, Expansions.Missions.AwardModule_KerbalsSurvived, Expansions.Missions.Adjusters.AdjusterAlternatorOutput, Expansions.Missions.Adjusters.FailureDeployablePartStuck, Expansions.Missions.Adjusters.AdjusterActiveRadiatorMaxEnergyTransfer, Expansions.Missions.Adjusters.AdjusterDeployableSolarPanelEfficiency, Expansions.Missions.Adjusters.AdjusterLiftingSurfaceLiftForce, Expansions.Missions.Adjusters.AdjusterLightIntensity, Expansions.Missions.Adjusters.AdjusterWheelBrakesTorque, Expansions.Missions.Adjusters.AdjusterWheelMotorTorque, Expansions.Missions.Adjusters.FailureReactionWheelStuck, Expansions.Missions.Adjusters.AdjusterControlSurfaceActuatorSpeed, Expansions.Missions.Adjusters.AdjusterGeneratorEfficiency, Expansions.Missions.Adjusters.AdjusterEnginesThrottle, Expansions.Missions.Adjusters.AdjusterSASServiceLevel, Expansions.Missions.VesselRestriction_Crew, Expansions.Missions.Adjusters.FailureWheelDeploymentStuck, Expansions.Missions.Adjusters.FailureCrossfeedStuck, Expansions.Missions.Adjusters.FailureLightStuck, Expansions.Missions.Adjusters.FailureResourceIntakeStuck, Expansions.Missions.VesselRestriction_Mass, Expansions.Missions.VesselRestriction_Stages, Expansions.Missions.VesselRestriction_PartCount, Expansions.Missions.AwardModule_Score, Expansions.Missions.AwardModule_MissionTime, and Expansions.Missions.VesselRestriction_RequiredParts.

void Expansions.Missions.DynamicModule.SetNode ( MENode  node )

inline

Sets the linked Mission Node

void Expansions.Missions.DynamicModule.UpdateNodeBodyUI ( )

inline

Updates the node body parameters

Implements Expansions.Missions.IMENodeDisplay.

Member Data Documentation

MENode Expansions.Missions.DynamicModule.node

protected

Refernce to the Node that the action is part of

List<string> Expansions.Missions.DynamicModule.parametersDisplayedInSAP

The parameters displayed in the Settings Action Pane

Property Documentation

virtual bool Expansions.Missions.DynamicModule.canBeDisplayedInEditor

get

Does this dynamic module can be displayed in the editor

string Expansions.Missions.DynamicModule.id

getset

Id of this dynamic module instance, this is a unique autogenerated number to diferenciate mutliple instance of the same type

string Expansions.Missions.DynamicModule.name

getset

the name of the module class

---

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

• KSP/Assets/Expansions/Missions/Scripts/DynamicModule.cs