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.TestDistance Class Reference
Inheritance diagram for Expansions.Missions.Tests.TestDistance:
Expansions.Missions.TestModule Expansions.Missions.IScoreableObjective IConfigNode Expansions.Missions.ITestModule IConfigNode Expansions.Missions.IMENodeDisplay

Public Types

enum  DistanceCalculationType { DistanceCalculationType.StraightLine, DistanceCalculationType.GreatCircle }
 
enum  DistanceFromChoices { DistanceFromChoices.Kerbal, DistanceFromChoices.Vessel }
 
enum  DistanceToChoices {
  DistanceToChoices.Asteroid, DistanceToChoices.Comet, DistanceToChoices.CelestialBody, DistanceToChoices.Flag,
  DistanceToChoices.Kerbal, DistanceToChoices.LaunchSite, DistanceToChoices.Location, DistanceToChoices.NodeLabelNode,
  DistanceToChoices.Vessel
}
 

Public Member Functions

override void Awake ()
 
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...
 
object GetScoreModifier (Type scoreModule)
 Gets the modifier value to be applied on a certain score module 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 Load (ConfigNode node)
 
override 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...
 
override void ParameterSetupComplete ()
 Can be used as a hook once all the parameters in a module have been setup. 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 ()
 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...
 
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 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...
 
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 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 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...
 
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

DistanceCalculationType calculationType = DistanceCalculationType.StraightLine
 The distance calculation type for the test. More...
 
TestComparisonLessGreaterOnly comparisonOperator = TestComparisonLessGreaterOnly.LessThan
 The comparison operator for the test. More...
 
double distance = 0
 The distance to test against. More...
 
MissionKerbal distanceFromKerbal
 Kerbal to Check More...
 
DistanceFromChoices distanceFromTarget = DistanceFromChoices.Vessel
 An enum to choose from the fields below More...
 
uint distanceFromVesselID = 0u
 Vessel to Check More...
 
uint distanceToAsteroidID = 0u
 The asteroid to test More...
 
MissionCelestialBody distanceToCelestialBody
 The celestial body to test More...
 
uint distanceToCometID = 0u
 The asteroid to test More...
 
uint distanceToFlagID = 0u
 The flag to test More...
 
MissionKerbal distanceToKerbal
 Kerbal to Check More...
 
string distanceToLaunchSiteName = "LaunchPad"
 The launch site to test More...
 
VesselGroundLocation distanceToLocation
 The location to test More...
 
Guid distanceToNode = Guid.Empty
 
DistanceToChoices distanceToTarget = DistanceToChoices.Vessel
 An enum to choose from the fields below More...
 
uint distanceToVesselID = 0u
 Vessel to Check 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...
 

Member Enumeration Documentation

Enumerator
StraightLine 
GreatCircle 
Enumerator
Kerbal 
Vessel 
Enumerator
Asteroid 
Comet 
CelestialBody 
Flag 
Kerbal 
LaunchSite 
Location 
NodeLabelNode 
Vessel 

Member Function Documentation

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

Reimplemented from Expansions.Missions.TestModule.

override string Expansions.Missions.Tests.TestDistance.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.TestDistance.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.TestDistance.GetScoreModifier ( Type  scoreModule)
inline

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

Parameters
scoreModule
Returns

Implements Expansions.Missions.IScoreableObjective.

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

Reimplemented from Expansions.Missions.TestModule.

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

Override this function to catch when a vessels persistentId is changed, you should use this to update any vesselID references in your action

An example of this occuring is when a vessel is launched from a craft file if there is an existing vessel in the game

Parameters
oldIdold Persistent ID
newIdnew Persistent ID

Reimplemented from Expansions.Missions.TestModule.

override void Expansions.Missions.Tests.TestDistance.ParameterSetupComplete ( )
inlinevirtual

Can be used as a hook once all the parameters in a module have been setup.

Reimplemented from Expansions.Missions.TestModule.

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

Reimplemented from Expansions.Missions.TestModule.

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

Tests the parameters needed for this

Returns
Result of test

Reimplemented from Expansions.Missions.TestModule.

Member Data Documentation

DistanceCalculationType Expansions.Missions.Tests.TestDistance.calculationType = DistanceCalculationType.StraightLine

The distance calculation type for the test.

TestComparisonLessGreaterOnly Expansions.Missions.Tests.TestDistance.comparisonOperator = TestComparisonLessGreaterOnly.LessThan

The comparison operator for the test.

double Expansions.Missions.Tests.TestDistance.distance = 0

The distance to test against.

MissionKerbal Expansions.Missions.Tests.TestDistance.distanceFromKerbal

Kerbal to Check

DistanceFromChoices Expansions.Missions.Tests.TestDistance.distanceFromTarget = DistanceFromChoices.Vessel

An enum to choose from the fields below

uint Expansions.Missions.Tests.TestDistance.distanceFromVesselID = 0u

Vessel to Check

uint Expansions.Missions.Tests.TestDistance.distanceToAsteroidID = 0u

The asteroid to test

MissionCelestialBody Expansions.Missions.Tests.TestDistance.distanceToCelestialBody

The celestial body to test

uint Expansions.Missions.Tests.TestDistance.distanceToCometID = 0u

The asteroid to test

uint Expansions.Missions.Tests.TestDistance.distanceToFlagID = 0u

The flag to test

MissionKerbal Expansions.Missions.Tests.TestDistance.distanceToKerbal

Kerbal to Check

string Expansions.Missions.Tests.TestDistance.distanceToLaunchSiteName = "LaunchPad"

The launch site to test

VesselGroundLocation Expansions.Missions.Tests.TestDistance.distanceToLocation

The location to test

Guid Expansions.Missions.Tests.TestDistance.distanceToNode = Guid.Empty
DistanceToChoices Expansions.Missions.Tests.TestDistance.distanceToTarget = DistanceToChoices.Vessel

An enum to choose from the fields below

uint Expansions.Missions.Tests.TestDistance.distanceToVesselID = 0u

Vessel to Check


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