Test for plant flag. This test when a plant flag event is triggered in the specified body name and (optional)biome. More...

Inheritance diagram for Expansions.Missions.Tests.TestPlantFlag:

Public Member Functions
override void	Awake ()

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

string	GetExtraText ()
	Get extra text to be appended at the end of the node label caption. More...

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

Waypoint	GetNodeWaypoint ()
	Get the waypoint marker to show the location of the current test module. More...

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

Vector3	GetWorldPosition ()
	Get location where the marker for the node should be displayed in world. More...

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

bool	HasNodeLabel ()
	Should we create a node label for this object or not? More...

bool	HasNodeWaypoint ()
	Should we create a waypoint for this object or not? More...

bool	HasWorldPosition ()
	Does the label represent an actual world position? For example, biomes won't have a world position, but a point in space will. More...

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

override void	Load (ConfigNode node)

override void	Save (ConfigNode node)

override bool	Test ()
	Test active vessel to see if there is a flag placed 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...

virtual string	GetAppObjectiveInfo ()

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

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

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)

Additional Inherited Members
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...

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

Properties inherited from Expansions.Missions.ITestNodeLabel
MENode	node `[get]`
	The node related to this test More...

Detailed Description

Test for plant flag. This test when a plant flag event is triggered in the specified body name and (optional)biome.

Member Function Documentation

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

inlinevirtual

Reimplemented from Expansions.Missions.TestModule.

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

inlinevirtual

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

Reimplemented from Expansions.Missions.TestModule.

string Expansions.Missions.Tests.TestPlantFlag.GetExtraText ( )

inline

Get extra text to be appended at the end of the node label caption.

Returns: Text to be appended at the end of the node label caption.

Implements Expansions.Missions.ITestNodeLabel.

override string Expansions.Missions.Tests.TestPlantFlag.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.TestPlantFlag.GetNodeBody ( )

inline

Get the CelestialBody associated with this node.

Returns: CelestialBody or Null

Implements Expansions.Missions.INodeBody.

Waypoint Expansions.Missions.Tests.TestPlantFlag.GetNodeWaypoint ( )

inline

Get the waypoint marker to show the location of the current test module.

Returns: Waypoint marker representing the current test module.

Implements Expansions.Missions.INodeWaypoint.

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

inline

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

Parameters

scoreModule

Returns

Implements Expansions.Missions.IScoreableObjective.

Vector3 Expansions.Missions.Tests.TestPlantFlag.GetWorldPosition ( )

inline

Get location where the marker for the node should be displayed in world.

Returns: Location of the node.

Implements Expansions.Missions.ITestNodeLabel.

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

inline

Does this Node have a CelestialBody associated with it?

Returns: True or False.

Implements Expansions.Missions.INodeBody.

bool Expansions.Missions.Tests.TestPlantFlag.HasNodeLabel ( )

inline

Should we create a node label for this object or not?

Returns: True if we should create a node label, false otherwise.

Implements Expansions.Missions.ITestNodeLabel.

bool Expansions.Missions.Tests.TestPlantFlag.HasNodeWaypoint ( )

inline

Should we create a waypoint for this object or not?

Returns: True if we should create a waypoint, false otherwise.

Implements Expansions.Missions.INodeWaypoint.

bool Expansions.Missions.Tests.TestPlantFlag.HasWorldPosition ( )

inline

Does the label represent an actual world position? For example, biomes won't have a world position, but a point in space will.

Returns: True if the node has a world position, false otherwise.

Implements Expansions.Missions.ITestNodeLabel.

override void Expansions.Missions.Tests.TestPlantFlag.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.TestPlantFlag.Load ( ConfigNode node )

inlinevirtual

Reimplemented from Expansions.Missions.TestModule.

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

inlinevirtual

Reimplemented from Expansions.Missions.TestModule.

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

inlinevirtual

Test active vessel to see if there is a flag placed

Returns

Reimplemented from Expansions.Missions.TestModule.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation