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

Inheritance diagram for Expansions.Missions.Actions.ActionPartFailure:

Public Member Functions
override void	Awake ()

void	DynamicModuleListControlCreated (MEGUIParameterDynamicModuleList sender)
	Handle setup of the dynamic module list when it has been created. More...

override IEnumerator	Fire ()
	Adds the list of adjusters to the part. More...

override string	GetInfo ()
	Get the information to be displayed about the module in the tooltip. More...

override List< IMENodeDisplay >	GetInternalParametersToDisplay ()
	Gets some more parameters to display. More...

override string	GetNodeBodyParameterString (BaseAPField field)
	Get the string to be displayed in the node body. More...

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

override void	Load (ConfigNode node)

override void	OnDestroy ()

override void	OnPartPersistentIdChanged (uint vesselID, uint oldId, uint newId)
	Handle part persistent ID being changed. More...

override void	OnVesselPersistentIdChanged (uint oldId, uint newId)
	Handle vessel persistent ID being changed. More...

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

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

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	OnCloned (ref ActionModule actionModuleBase)

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	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
DynamicModuleList	Modules
	List of part adjusters to add when the action fires. More...

VesselPartIDPair	vesselPartIDs
	Information about the vessel and part to be affected by the failure. 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 add some adjusters.

Member Function Documentation

override void Expansions.Missions.Actions.ActionPartFailure.Awake ( )

inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

void Expansions.Missions.Actions.ActionPartFailure.DynamicModuleListControlCreated ( MEGUIParameterDynamicModuleList sender )

inline

Handle setup of the dynamic module list when it has been created.

override IEnumerator Expansions.Missions.Actions.ActionPartFailure.Fire ( )

inlinevirtual

Adds the list of adjusters to the part.

Returns

Reimplemented from Expansions.Missions.ActionModule.

override string Expansions.Missions.Actions.ActionPartFailure.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 List<IMENodeDisplay> Expansions.Missions.Actions.ActionPartFailure.GetInternalParametersToDisplay ( )

inlinevirtual

Gets some more parameters to display.

Returns: Returns additional parameters that the module might want to display.

Reimplemented from Expansions.Missions.ActionModule.

override string Expansions.Missions.Actions.ActionPartFailure.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.ActionPartFailure.Initialize ( MENode node )

inlinevirtual

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

Parameters

node

Reimplemented from Expansions.Missions.ActionModule.

override void Expansions.Missions.Actions.ActionPartFailure.Load ( ConfigNode node )

inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

override void Expansions.Missions.Actions.ActionPartFailure.OnDestroy ( )

inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

override void Expansions.Missions.Actions.ActionPartFailure.OnPartPersistentIdChanged	(	uint	vesselID,
		uint	oldId,
		uint	newId
	)

inlinevirtual

Handle part persistent ID being changed.

Reimplemented from Expansions.Missions.ActionModule.

override void Expansions.Missions.Actions.ActionPartFailure.OnVesselPersistentIdChanged	(	uint	oldId,
		uint	newId
	)

inlinevirtual

Handle vessel persistent ID being changed.

Reimplemented from Expansions.Missions.ActionModule.

override void Expansions.Missions.Actions.ActionPartFailure.OnVesselsUndocking	(	Vessel	oldVessel,
		Vessel	newVessel
	)

inlinevirtual

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

An example of this occuring is when a vessel undocks and a new vessel is created.

param name="vessel">The Vessel that was created

Reimplemented from Expansions.Missions.ActionModule.

override void Expansions.Missions.Actions.ActionPartFailure.RunValidation ( MissionEditorValidator validator )

inlinevirtual

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

Parameters

validator The MissionValidator that the results will be added to

Reimplemented from Expansions.Missions.ActionModule.

override void Expansions.Missions.Actions.ActionPartFailure.Save ( ConfigNode node )

inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

void Expansions.Missions.Actions.ActionPartFailure.VesselPartSelectorControlCreated ( MEGUIParameterVesselPartSelector sender )

inline

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

Member Data Documentation

DynamicModuleList Expansions.Missions.Actions.ActionPartFailure.Modules

List of part adjusters to add when the action fires.

VesselPartIDPair Expansions.Missions.Actions.ActionPartFailure.vesselPartIDs

Information about the vessel and part to be affected by the failure.

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

KSP/Assets/Expansions/Missions/Scripts/ActionModules/ActionPartFailure.cs

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation