Test Vessel is a base class for any other Test that involves a single vessel as a target. It can have an optional vesselID on its parameters, if its not defined it will use the active vessel as the target. More...

Inheritance diagram for Expansions.Missions.Tests.TestVessel:

Public Member Functions
override void	Awake ()

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

override void	Load (ConfigNode node)

override void	OnVesselDocking (uint oldId, uint newId)
	If a GameEvents.onVesselDocking occurs we need to check if the old persistentId is the one referenced by this node and store the root Part persistentId for that vessel. Then later if an undock occurs we will find which vessel we are meant to be tracking in this node from the stored root Part persistentId. More...

override void	OnVesselPersistentIdChanged (uint oldId, uint newId)
	If a persistentId for a vessel changes Event occurs (GameEvents.onVesselPersistentIdChanged) this will check if the vessel Id on this action node is the one changing and change the reference to the new persistentId More...

override void	OnVesselsUndocking (Vessel oldVessel, Vessel newVessel)
	If a GameEvents.onVesselsUndocking occurs we need to check if one of the vessel PersistentId's involved is the one this node is tracking. If it is, we look for a stored root Part persistentId (if there was a docking event earlier) and find the correct Vessel persistentId to track. More...

override void	Save (ConfigNode node)

override bool	Test ()
	Tests the parameters needed for this More...

void	vesselSelectorCreated (MEGUIParameter parameter)

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

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

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

virtual string	GetAppObjectiveInfo ()

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

virtual string	GetInfo ()
	Get the information to be displayed about the module in the tooltip. 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...

virtual void	Initialized ()
	Method to overide if you want to do stuff when a node is activated 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	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...

virtual void	RunValidation (MissionEditorValidator validator)
	Override this to add custom Validation checks and results to this object 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
uint	vesselID = 0u

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

Protected Attributes
bool	useActiveVessel

Vessel	vessel

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 Vessel is a base class for any other Test that involves a single vessel as a target. It can have an optional vesselID on its parameters, if its not defined it will use the active vessel as the target.

Member Function Documentation

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

inlinevirtual

Reimplemented from Expansions.Missions.TestModule.

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

Reimplemented in Expansions.Missions.Tests.TestVesselVelocity, Expansions.Missions.Tests.TestVesselSituation, Expansions.Missions.Tests.TestVesselResource, Expansions.Missions.Tests.TestVesselCrewCount, Expansions.Missions.Tests.TestVesselPartCount, Expansions.Missions.Tests.TestVesselStage, Expansions.Missions.Tests.TestVesselAltitude, and Expansions.Missions.Tests.TestVesselMass.

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

inlinevirtual

Reimplemented from Expansions.Missions.TestModule.

override void Expansions.Missions.Tests.TestVessel.OnVesselDocking	(	uint	oldId,
		uint	newId
	)

inlinevirtual

If a GameEvents.onVesselDocking occurs we need to check if the old persistentId is the one referenced by this node and store the root Part persistentId for that vessel. Then later if an undock occurs we will find which vessel we are meant to be tracking in this node from the stored root Part persistentId.

Parameters

oldId
newId

Reimplemented from Expansions.Missions.TestModule.

override void Expansions.Missions.Tests.TestVessel.OnVesselPersistentIdChanged	(	uint	oldId,
		uint	newId
	)

inlinevirtual

If a persistentId for a vessel changes Event occurs (GameEvents.onVesselPersistentIdChanged) this will check if the vessel Id on this action node is the one changing and change the reference to the new persistentId

Parameters

oldId
newId

Reimplemented from Expansions.Missions.TestModule.

override void Expansions.Missions.Tests.TestVessel.OnVesselsUndocking	(	Vessel	oldVessel,
		Vessel	newVessel
	)

inlinevirtual

If a GameEvents.onVesselsUndocking occurs we need to check if one of the vessel PersistentId's involved is the one this node is tracking. If it is, we look for a stored root Part persistentId (if there was a docking event earlier) and find the correct Vessel persistentId to track.

Parameters

oldVessel
newVessel

Reimplemented from Expansions.Missions.TestModule.

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

inlinevirtual

Reimplemented from Expansions.Missions.TestModule.

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

inlinevirtual

Tests the parameters needed for this

Returns: Result of test

Reimplemented from Expansions.Missions.TestModule.

void Expansions.Missions.Tests.TestVessel.vesselSelectorCreated ( MEGUIParameter parameter )

inline

Member Data Documentation

bool Expansions.Missions.Tests.TestVessel.useActiveVessel

protected

Vessel Expansions.Missions.Tests.TestVessel.vessel

protected

uint Expansions.Missions.Tests.TestVessel.vesselID = 0u

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

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

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation