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.TestGrapple Class Reference

Test if a grappling device is grappling to anything. More...

Inheritance diagram for Expansions.Missions.Tests.TestGrapple:
Expansions.Missions.TestModule IConfigNode Expansions.Missions.ITestModule IConfigNode Expansions.Missions.IMENodeDisplay

Public Types

enum  SpaceObjectChoices { SpaceObjectChoices.Asteroid, SpaceObjectChoices.Comet, SpaceObjectChoices.Vessel }
 

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 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...
 
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 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...
 
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)
 
List< MEGUIDropDownItemSetDockedUndockedDropdown ()
 
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...
 
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 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

string dockedUndocked
 Whether this node is testing docking or undocking More...
 
uint grappleAsteroidID = 0u
 The asteroid to test More...
 
uint grappleCometID = 0u
 The comet to test More...
 
SpaceObjectChoices grappledSpaceObject = SpaceObjectChoices.Asteroid
 An enum to choose the reference body More...
 
uint grappleVesselID = 0u
 The comet to test More...
 
uint grapplingVesselID
 This is the first part to test the dock/undock against 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 if a grappling device is grappling to anything.

Member Enumeration Documentation

Enumerator
Asteroid 
Comet 
Vessel 

Member Function Documentation

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

Reimplemented from Expansions.Missions.TestModule.

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

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

Reimplemented from Expansions.Missions.TestModule.

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

Override this function to catch when a vessels persistentId is about to change as a result of a vessel docking event.

Parameters
oldIdold Persistent ID
newIdnew Persistent ID

Reimplemented from Expansions.Missions.TestModule.

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

Reimplemented from Expansions.Missions.TestModule.

List<MEGUIDropDownItem> Expansions.Missions.Tests.TestGrapple.SetDockedUndockedDropdown ( )
inline
override bool Expansions.Missions.Tests.TestGrapple.Test ( )
inlinevirtual

Tests the parameters needed for this

Returns
Result of test

Reimplemented from Expansions.Missions.TestModule.

Member Data Documentation

string Expansions.Missions.Tests.TestGrapple.dockedUndocked

Whether this node is testing docking or undocking

uint Expansions.Missions.Tests.TestGrapple.grappleAsteroidID = 0u

The asteroid to test

uint Expansions.Missions.Tests.TestGrapple.grappleCometID = 0u

The comet to test

SpaceObjectChoices Expansions.Missions.Tests.TestGrapple.grappledSpaceObject = SpaceObjectChoices.Asteroid

An enum to choose the reference body

uint Expansions.Missions.Tests.TestGrapple.grappleVesselID = 0u

The comet to test

uint Expansions.Missions.Tests.TestGrapple.grapplingVesselID

This is the first part to test the dock/undock against


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