Test for Science Experiments. Two situations are catered for. Experiments transmitted successfully to RnD and Experiments when deployed. More...

Inheritance diagram for Expansions.Missions.Tests.TestScienceExperiment:

Public Member Functions
override void	Awake ()

override void	Cleared ()
	Method to overide if you want to do stuff when a node is deactivated More...

override string	GetAppObjectiveInfo ()

override string	GetInfo ()
	Get the information to be displayed about the module in the tooltip. More...

CelestialBody	GetNodeBody ()
	Get the CelestialBody associated with this node. More...

override string	GetNodeBodyParameterString (BaseAPField field)
	Returns the string to be displayed when the parameter is displayed in the node body More...

object	GetScoreModifier (Type scoreModule)
	Gets the modifier value to be applied on a certain score module More...

bool	HasNodeBody ()
	Does this Node have a CelestialBody associated with it? More...

override void	Initialized ()
	Method to overide if you want to do stuff when a node is activated More...

override void	Load (ConfigNode node)

void	OnExperimentDeployed (ScienceData scienceDataIn)
	Fires when a Science report is generated Will test experimentID, biome, situation, celestialbody Name as appropriate for those that are not set to null. More...

void	OnScienceReceived (float scienceValue, ScienceSubject scienceSubjectIn, ProtoVessel vessel, bool reverseEngineered)
	Fires when Science is Received by RnD Will test experimentID, biome, situation, celestialbody Name as appropriate for those that are not set to null. More...

override void	RunValidation (MissionEditorValidator validator)
	Override this to add custom Validation checks and results to this object More...

override void	Save (ConfigNode node)

override bool	Test ()
	Execute the test of the base TestModule More...

Public Member Functions inherited from Expansions.Missions.TestModule
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...

TestModule	ClearTest ()
	Run anything we need on Deactivating a Test More...

string	GetDisplayName ()
	Get the localized name of the node More...

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

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 (TestGroup testGroup, string title="")
	This is called Once when a TestModule component is instantiated. This is a mandatory Method and will set the MENode reference. Override this method in any action modules that require the MENode reference prior to Awake, but always call the base.Initialize More...

TestModule	InitializeTest ()
	Run anything we need on Activating a Test More...

virtual void	OnDestroy ()

virtual void	OnPartPersistentIdChanged (uint vesselID, uint oldId, uint newId)
	Override this function to catch when a parts persistentId is changed, you should use this to update any partID references in your action where the part is in the correct vessel More...

virtual void	OnVesselDocking (uint oldId, uint newId)
	Override this function to catch when a vessels persistentId is about to change as a result of a vessel docking event. More...

virtual void	OnVesselPersistentIdChanged (uint oldId, uint newId)
	Override this function to catch when a vessels persistentId is changed, you should use this to update any vesselID references in your action More...

virtual void	OnVesselsUndocking (Vessel oldVessel, Vessel newVessel)
	Override this function to catch when a parts Vessel is changed, you should use this to update any partID/Vessel references in your action where the part is in the correct vessel More...

virtual void	ParameterSetupComplete ()
	Perform all the setup operations that we need when the module is initialised in the mission builder. 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	RunValidationWrapper (MissionEditorValidator validator)
	Called to run the Validation checks for this object. More...

virtual bool	ShouldCreateCheckpoint ()
	Used by the Test Mission checkpoint system to determine whether to create a checkpoint when this module fires or not. More...

void	UpdateNodeBodyUI ()
	Updates the node body parameters More...

Public Member Functions inherited from Expansions.Missions.ITestModule
void	RunValidationWrapper (Editor.MissionEditorValidator validator)

Public Attributes
MissionBiome	biomeData
	Biome where the experiment should occur, this value can be empty to test agains all biomes. More...

string	DeployorReceived = ""
	Set to Deployed or Received indicating if the test is considered successful when the science experiement is deployed (conducted) or Received (transmitted back to Kerbin) More...

string	experimentID = ""
	Any particular experimentID we are interested in testing. Set to null if not to be tested. More...

string	experimentSituation = ""
	Any particular ExperimentSituation we are interested in testing. This is stored as a string because enums can't have null values. Set to null if not to be tested. More...

Public Attributes inherited from Expansions.Missions.TestModule
bool	hasOrbit = false

bool	hasWaypoint = false
	True if a WayPoint exists for this module. More...

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

string	title = ""
	The display name for this More...

Additional Inherited Members
Properties inherited from Expansions.Missions.TestModule
string	name `[get, set]`
	the name of the module class More...

MENode	node `[get, set]`
	Refernce to the Node that the test is part of More...

TestGroup	testGroup `[get, set]`
	Refernce to the Node that the test is part of More...

Detailed Description

Test for Science Experiments. Two situations are catered for. Experiments transmitted successfully to RnD and Experiments when deployed.

Member Function Documentation

override void Expansions.Missions.Tests.TestScienceExperiment.Awake ( )

inlinevirtual

Reimplemented from Expansions.Missions.TestModule.

override void Expansions.Missions.Tests.TestScienceExperiment.Cleared ( )

inlinevirtual

Method to overide if you want to do stuff when a node is deactivated

Reimplemented from Expansions.Missions.TestModule.

override string Expansions.Missions.Tests.TestScienceExperiment.GetAppObjectiveInfo ( )

inlinevirtual

Reimplemented from Expansions.Missions.TestModule.

override string Expansions.Missions.Tests.TestScienceExperiment.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

Reimplemented from Expansions.Missions.TestModule.

CelestialBody Expansions.Missions.Tests.TestScienceExperiment.GetNodeBody ( )

inline

Get the CelestialBody associated with this node.

Returns: CelestialBody or Null

Implements Expansions.Missions.INodeBody.

override string Expansions.Missions.Tests.TestScienceExperiment.GetNodeBodyParameterString ( BaseAPField field )

inlinevirtual

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

Parameters

field

Returns

Reimplemented from Expansions.Missions.TestModule.

object Expansions.Missions.Tests.TestScienceExperiment.GetScoreModifier ( Type scoreModule )

inline

Gets the modifier value to be applied on a certain score module

Parameters

scoreModule

Returns

Implements Expansions.Missions.IScoreableObjective.

bool Expansions.Missions.Tests.TestScienceExperiment.HasNodeBody ( )

inline

Does this Node have a CelestialBody associated with it?

Returns: True or False.

Implements Expansions.Missions.INodeBody.

override void Expansions.Missions.Tests.TestScienceExperiment.Initialized ( )

inlinevirtual

Method to overide if you want to do stuff when a node is activated

Reimplemented from Expansions.Missions.TestModule.

override void Expansions.Missions.Tests.TestScienceExperiment.Load ( ConfigNode node )

inlinevirtual

Reimplemented from Expansions.Missions.TestModule.

void Expansions.Missions.Tests.TestScienceExperiment.OnExperimentDeployed ( ScienceData scienceDataIn )

inline

Fires when a Science report is generated Will test experimentID, biome, situation, celestialbody Name as appropriate for those that are not set to null.

Parameters

scienceDataIn

void Expansions.Missions.Tests.TestScienceExperiment.OnScienceReceived	(	float	scienceValue,
		ScienceSubject	scienceSubjectIn,
		ProtoVessel	vessel,
		bool	reverseEngineered
	)

inline

Fires when Science is Received by RnD Will test experimentID, biome, situation, celestialbody Name as appropriate for those that are not set to null.

Parameters

scienceValue
scienceSubjectIn
vessel
reverseEngineered

override void Expansions.Missions.Tests.TestScienceExperiment.RunValidation ( MissionEditorValidator validator )

inlinevirtual

Override this to add custom Validation checks and results to this object

Parameters

validator The MissionValidator that the results will be added to

Reimplemented from Expansions.Missions.TestModule.

override void Expansions.Missions.Tests.TestScienceExperiment.Save ( ConfigNode node )

inlinevirtual

Reimplemented from Expansions.Missions.TestModule.

override bool Expansions.Missions.Tests.TestScienceExperiment.Test ( )

inlinevirtual

Execute the test of the base TestModule

Returns: Returns true or false

Reimplemented from Expansions.Missions.TestModule.

Member Data Documentation

MissionBiome Expansions.Missions.Tests.TestScienceExperiment.biomeData

Biome where the experiment should occur, this value can be empty to test agains all biomes.

string Expansions.Missions.Tests.TestScienceExperiment.DeployorReceived = ""

Set to Deployed or Received indicating if the test is considered successful when the science experiement is deployed (conducted) or Received (transmitted back to Kerbin)

string Expansions.Missions.Tests.TestScienceExperiment.experimentID = ""

Any particular experimentID we are interested in testing. Set to null if not to be tested.

string Expansions.Missions.Tests.TestScienceExperiment.experimentSituation = ""

Any particular ExperimentSituation we are interested in testing. This is stored as a string because enums can't have null values. Set to null if not to be tested.

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

KSP/Assets/Expansions/Missions/Scripts/TestModules/TestScienceExperiment.cs

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation