Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | List of all members
Expansions.Missions.Actions.ActionCreateFlag Class Reference

More...

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

Public Member Functions

override Vector3 ActionLocation ()
 Returns the Location for Create Flag in world space. More...
 
override void Awake ()
 
override IEnumerator Fire ()
 Run this action 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...
 
ConfigNode GetProtoVesselNode ()
 Generates a ProtoVessel ConfigNode for a flag More...
 
override void Load (ConfigNode node)
 
override void OnCloned (ref ActionModule actionModuleBase)
 
override void Save (ConfigNode node)
 
- Public Member Functions inherited from Expansions.Missions.ActionModule
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 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 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...
 
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

VesselGroundLocation location
 The location of the flag on the ground More...
 
uint persistentID = 0u
 We need to know the flag persistent id (and keep it in the actual mission) so that other nodes can refer to this particular flag. More...
 
string plaqueText
 The Text of the plaque More...
 
string siteName
 The name of the site 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

Member Function Documentation

override Vector3 Expansions.Missions.Actions.ActionCreateFlag.ActionLocation ( )
inlinevirtual

Returns the Location for Create Flag in world space.

Returns

Reimplemented from Expansions.Missions.ActionModule.

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

Reimplemented from Expansions.Missions.ActionModule.

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

Run this action

Reimplemented from Expansions.Missions.ActionModule.

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

ConfigNode Expansions.Missions.Actions.ActionCreateFlag.GetProtoVesselNode ( )
inline

Generates a ProtoVessel ConfigNode for a flag

Returns
ConfigNode containing the flag
override void Expansions.Missions.Actions.ActionCreateFlag.Load ( ConfigNode  node)
inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

override void Expansions.Missions.Actions.ActionCreateFlag.OnCloned ( ref ActionModule  actionModuleBase)
inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

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

Reimplemented from Expansions.Missions.ActionModule.

Member Data Documentation

VesselGroundLocation Expansions.Missions.Actions.ActionCreateFlag.location

The location of the flag on the ground

uint Expansions.Missions.Actions.ActionCreateFlag.persistentID = 0u

We need to know the flag persistent id (and keep it in the actual mission) so that other nodes can refer to this particular flag.

string Expansions.Missions.Actions.ActionCreateFlag.plaqueText

The Text of the plaque

string Expansions.Missions.Actions.ActionCreateFlag.siteName

The name of the site


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