Action Vessel is a base class for any other Action that involves a single vessel as a target. It can have an optional vesselID on its parameters, if its not defined it will use the active vessel as the target. More...

Inheritance diagram for Expansions.Missions.Actions.ActionVessel:

Public Member Functions
override void	Awake ()

override string	GetNodeBodyParameterString (BaseAPField field)
	Returns the string to be displayed when the parameter is displayed in the node body More...

override void	Load (ConfigNode node)

override void	OnVesselPersistentIdChanged (uint oldId, uint newId)
	If a persistentId for a vessel changes Event occurs (GameEvents.onVesselPersistentIdChanged) this will check if the vessel Id on this action node is the one changing and change the reference to the new persistentId More...

override void	OnVesselsDocking (uint oldId, uint newId)
	If a GameEvents.onVesselDocking occurs we need to check if the old persistentId is the one referenced by this node and store the root Part persistentId for that vessel. Then later if an undock occurs we will find which vessel we are meant to be tracking in this node from the stored root Part persistentId. More...

override void	OnVesselsUndocking (Vessel oldVessel, Vessel newVessel)
	If a GameEvents.onVesselsUndocking occurs we need to check if one of the vessel PersistentId's involved is the one this node is tracking. If it is, we look for a stored root Part persistentId (if there was a docking event earlier) and find the correct Vessel persistentId to track. More...

override void	Save (ConfigNode node)

void	vesselSelectorCreated (MEGUIParameter parameter)

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 IEnumerator	Fire ()
	Run this action More...

virtual string	GetAppObjectiveInfo ()

string	GetDisplayName ()
	Get the localized name of the node More...

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

virtual List< IMENodeDisplay >	GetInternalParametersToDisplay ()
	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	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	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...

virtual void	RunValidation (MissionEditorValidator validator)
	Override this to add custom Validation checks and results to this object 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
uint	vesselID = 0u

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

Protected Attributes
bool	useActiveVessel

Properties
Vessel	vessel `[get]`
	Vessel selected for this action More...

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

Detailed Description

Action Vessel is a base class for any other Action that involves a single vessel as a target. It can have an optional vesselID on its parameters, if its not defined it will use the active vessel as the target.

Member Function Documentation

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

inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

Reimplemented in Expansions.Missions.Actions.ActionVesselExplode.

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

Reimplemented in Expansions.Missions.Actions.ActionVesselExplode.

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

inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

Reimplemented in Expansions.Missions.Actions.ActionVesselExplode.

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

inlinevirtual

If a persistentId for a vessel changes Event occurs (GameEvents.onVesselPersistentIdChanged) this will check if the vessel Id on this action node is the one changing and change the reference to the new persistentId

Parameters

oldId
newId

Reimplemented from Expansions.Missions.ActionModule.

override void Expansions.Missions.Actions.ActionVessel.OnVesselsDocking	(	uint	oldId,
		uint	newId
	)

inlinevirtual

If a GameEvents.onVesselDocking occurs we need to check if the old persistentId is the one referenced by this node and store the root Part persistentId for that vessel. Then later if an undock occurs we will find which vessel we are meant to be tracking in this node from the stored root Part persistentId.

Parameters

oldId
newId

Reimplemented from Expansions.Missions.ActionModule.

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

inlinevirtual

If a GameEvents.onVesselsUndocking occurs we need to check if one of the vessel PersistentId's involved is the one this node is tracking. If it is, we look for a stored root Part persistentId (if there was a docking event earlier) and find the correct Vessel persistentId to track.

Parameters

oldVessel
newVessel

Reimplemented from Expansions.Missions.ActionModule.

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

inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

Reimplemented in Expansions.Missions.Actions.ActionVesselExplode.

void Expansions.Missions.Actions.ActionVessel.vesselSelectorCreated ( MEGUIParameter parameter )

inline

Member Data Documentation

bool Expansions.Missions.Actions.ActionVessel.useActiveVessel

protected

uint Expansions.Missions.Actions.ActionVessel.vesselID = 0u

Property Documentation

Vessel Expansions.Missions.Actions.ActionVessel.vessel

get

Vessel selected for this action

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

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

Public Member Functions

Public Attributes

Protected Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation