Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Types | Public Member Functions | Public Attributes | List of all members
Expansions.Missions.Tests.TestTakeKerbal Class Reference
Inheritance diagram for Expansions.Missions.Tests.TestTakeKerbal:
Expansions.Missions.TestModule Expansions.Missions.IScoreableObjective Expansions.Missions.INodeWaypoint Expansions.Missions.ITestNodeLabel IConfigNode Expansions.Missions.ITestModule IConfigNode Expansions.Missions.IMENodeDisplay

Public Types

enum  TestType { TestType.AnyVesselAnyKerbal, TestType.AnyVesselSpecificKerbal, TestType.SpecificVesselAnyKerbal, TestType.SpecificVesselSpecificKerbal }
 

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...
 
override string GetNodeBodyParameterString (BaseAPField field)
 Returns the string to be displayed when the parameter is displayed in the node body 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 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 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...
 
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 RunValidation (MissionEditorValidator validator)
 Override this to add custom Validation checks and results to this object More...
 
override void Save (ConfigNode node)
 
override bool Test ()
 Tests the parameters needed for this 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< 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...
 
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

ParamChoices_CelestialBodySurface locationSituation
 
MissionKerbal missionKerbal
 Kerbal to Check More...
 
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...
 

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...
 
- Properties inherited from Expansions.Missions.ITestNodeLabel
MENode node [get]
 The node related to this test More...
 

Member Enumeration Documentation

Enumerator
AnyVesselAnyKerbal 
AnyVesselSpecificKerbal 
SpecificVesselAnyKerbal 
SpecificVesselSpecificKerbal 

Member Function Documentation

override void Expansions.Missions.Tests.TestTakeKerbal.Awake ( )
inlinevirtual

Reimplemented from Expansions.Missions.TestModule.

override void Expansions.Missions.Tests.TestTakeKerbal.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.TestTakeKerbal.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.TestTakeKerbal.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.

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

Waypoint Expansions.Missions.Tests.TestTakeKerbal.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.TestTakeKerbal.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.TestTakeKerbal.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.TestTakeKerbal.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.TestTakeKerbal.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.TestTakeKerbal.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.TestTakeKerbal.Initialize ( TestGroup  testGroup,
string  title 
)
inlinevirtual

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

Parameters
node

Reimplemented from Expansions.Missions.TestModule.

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

Reimplemented from Expansions.Missions.TestModule.

override void Expansions.Missions.Tests.TestTakeKerbal.RunValidation ( MissionEditorValidator  validator)
inlinevirtual

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

Parameters
validatorThe MissionValidator that the results will be added to

Reimplemented from Expansions.Missions.TestModule.

override void Expansions.Missions.Tests.TestTakeKerbal.Save ( ConfigNode  node)
inlinevirtual

Reimplemented from Expansions.Missions.TestModule.

override bool Expansions.Missions.Tests.TestTakeKerbal.Test ( )
inlinevirtual

Tests the parameters needed for this

Returns
Result of test

Reimplemented from Expansions.Missions.TestModule.

Member Data Documentation

ParamChoices_CelestialBodySurface Expansions.Missions.Tests.TestTakeKerbal.locationSituation
MissionKerbal Expansions.Missions.Tests.TestTakeKerbal.missionKerbal

Kerbal to Check

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

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