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.Actions.ActionPartRepair Class Reference

Perform an Action on a Part to remove some adjusters. More...

Inheritance diagram for Expansions.Missions.Actions.ActionPartRepair:
Expansions.Missions.ActionModule IConfigNode Expansions.Missions.IActionModule IConfigNode Expansions.Missions.IMENodeDisplay

Public Types

enum  RepairChoices { RepairChoices.entireVessel, RepairChoices.onePart, RepairChoices.partModule, RepairChoices.failureID }
 

Public Member Functions

override void Awake ()
 
override IEnumerator Fire ()
 Repairs the adjusters. More...
 
override string GetInfo ()
 Get the information to be displayed about the module in the tooltip. More...
 
override string GetNodeBodyParameterString (BaseAPField field)
 Get the string to be displayed in the node body. More...
 
override void Load (ConfigNode node)
 
override void OnDestroy ()
 
override void RunValidation (MissionEditorValidator validator)
 Override this to add custom Validation checks and results to this object More...
 
override void Save (ConfigNode node)
 
void VesselPartSelectorControlCreated (MEGUIParameterVesselPartSelector sender)
 Handle setup of the part selector when it has been created. More...
 
- Public Member Functions inherited from Expansions.Missions.ActionModule
virtual Vector3 ActionLocation ()
 Get the Location in world space for this ActionModule. Default will return Vector3.zero. Override to return actual location. More...
 
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 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 (MENode node)
 This is called Once when an ActionModule 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 OnCloned (ref ActionModule actionModuleBase)
 
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 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 OnVesselsDocking (uint oldId, uint newId)
 Override this function to catch when a Vessel Dock, you should use this to update any partID/Vessel 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...
 
virtual void ParameterSetupComplete ()
 Can be used as a hook once all the parameters in a module have been setup. 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...
 
void UpdateNodeBodyUI ()
 Updates the node body parameters More...
 
- Public Member Functions inherited from Expansions.Missions.IActionModule
void RunValidationWrapper (Editor.MissionEditorValidator validator)
 

Public Attributes

Guid failureID
 Saved reference to the part module dropdown list parameter. More...
 
string partModule
 Part module to be repaired. More...
 
RepairChoices repairType = RepairChoices.entireVessel
 An enum to choose from the fields below More...
 
VesselPartIDPair vesselPartIDs
 Part to be repaired. More...
 
- Public Attributes inherited from Expansions.Missions.ActionModule
bool isRunning = false
 Indicates if the coroutine is running. Set to true when Fire() method starts and set to false when it is finished. Used when restartOnSceneLoad is true to restart coroutine for an ActionModule. More...
 
MENode node
 Refernce to the Node that the action is part of More...
 
List< string > parametersDisplayedInSAP
 The parameters displayed in the Settings Action Pane More...
 
bool restartOnSceneLoad = false
 Set to true if this module requires the MissionSystem to restart a Fire() coroutine on scene change. It will only do this if the coroutine was already running before the scene change. More...
 
string title = ""
 The display name for this More...
 

Additional Inherited Members

- Properties inherited from Expansions.Missions.ActionModule
string name [get, set]
 the name of the module class More...
 

Detailed Description

Perform an Action on a Part to remove some adjusters.

Member Enumeration Documentation

Enumerator
entireVessel 
onePart 
partModule 
failureID 

Member Function Documentation

override void Expansions.Missions.Actions.ActionPartRepair.Awake ( )
inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

override IEnumerator Expansions.Missions.Actions.ActionPartRepair.Fire ( )
inlinevirtual

Repairs the adjusters.

Returns

Reimplemented from Expansions.Missions.ActionModule.

override string Expansions.Missions.Actions.ActionPartRepair.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.ActionModule.

override string Expansions.Missions.Actions.ActionPartRepair.GetNodeBodyParameterString ( BaseAPField  field)
inlinevirtual

Get the string to be displayed in the node body.

Returns
The string to be displayed in the node body

Reimplemented from Expansions.Missions.ActionModule.

override void Expansions.Missions.Actions.ActionPartRepair.Load ( ConfigNode  node)
inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

override void Expansions.Missions.Actions.ActionPartRepair.OnDestroy ( )
inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

override void Expansions.Missions.Actions.ActionPartRepair.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.ActionModule.

override void Expansions.Missions.Actions.ActionPartRepair.Save ( ConfigNode  node)
inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

void Expansions.Missions.Actions.ActionPartRepair.VesselPartSelectorControlCreated ( MEGUIParameterVesselPartSelector  sender)
inline

Handle setup of the part selector when it has been created.

Member Data Documentation

Guid Expansions.Missions.Actions.ActionPartRepair.failureID

Saved reference to the part module dropdown list parameter.

string Expansions.Missions.Actions.ActionPartRepair.partModule

Part module to be repaired.

RepairChoices Expansions.Missions.Actions.ActionPartRepair.repairType = RepairChoices.entireVessel

An enum to choose from the fields below

VesselPartIDPair Expansions.Missions.Actions.ActionPartRepair.vesselPartIDs

Part to be repaired.


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