Inheritance diagram for Expansions.Missions.Actions.ActionDialogMessage:

Public Types
enum	DialogMessageArea { DialogMessageArea.Left, DialogMessageArea.Center, DialogMessageArea.Right }

Public Member Functions
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...

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	ParameterSetupComplete ()
	Can be used as a hook once all the parameters in a module have been setup. More...

override void	Save (ConfigNode node)

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

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
bool	autoClose

int	autoCloseTimeOut

bool	autoGrowDialogHeight = false
	If set to true the node dialog height is calculated based on the text content and grows the nodeText preferred height up to the max. More...

bool	isBriefingMessage = false
	Set to true to indicate this ActionModule instance is for the Mission Briefing at the start of the mission. More...

string	message
	The Text of the message dialog More...

string	messageHeading
	The Header/Title of the Message dialog More...

MissionInstructor	missionInstructor
	The Instructor that will appear in the dialog More...

bool	pauseMission

DialogMessageArea	screenArea

int	textAreaSize
	The vertical height of the dialog. 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...

Protected Member Functions
void	SendStateMessage (string title, string message, MessageSystemButton.MessageButtonColor color, MessageSystemButton.ButtonIcons icon)
	Sends user a text message via messaging system More...

Protected Attributes
MEGUIParameterNumberRange	autoCloseTimeOutRange = null

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

Member Enumeration Documentation

enum Expansions.Missions.Actions.ActionDialogMessage.DialogMessageArea

Enumerator
Left
Center
Right

Member Function Documentation

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

inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

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

inlinevirtual

Run this action

Reimplemented from Expansions.Missions.ActionModule.

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

override void Expansions.Missions.Actions.ActionDialogMessage.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.ActionDialogMessage.Load ( ConfigNode node )

inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

override void Expansions.Missions.Actions.ActionDialogMessage.ParameterSetupComplete ( )

inlinevirtual

Can be used as a hook once all the parameters in a module have been setup.

Reimplemented from Expansions.Missions.ActionModule.

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

inlinevirtual

Reimplemented from Expansions.Missions.ActionModule.

void Expansions.Missions.Actions.ActionDialogMessage.SendStateMessage	(	string	title,
		string	message,
		MessageSystemButton.MessageButtonColor	color,
		MessageSystemButton.ButtonIcons	icon
	)

inlineprotected

Sends user a text message via messaging system

Member Data Documentation

bool Expansions.Missions.Actions.ActionDialogMessage.autoClose

int Expansions.Missions.Actions.ActionDialogMessage.autoCloseTimeOut

MEGUIParameterNumberRange Expansions.Missions.Actions.ActionDialogMessage.autoCloseTimeOutRange = null

protected

bool Expansions.Missions.Actions.ActionDialogMessage.autoGrowDialogHeight = false

If set to true the node dialog height is calculated based on the text content and grows the nodeText preferred height up to the max.

bool Expansions.Missions.Actions.ActionDialogMessage.isBriefingMessage = false

Set to true to indicate this ActionModule instance is for the Mission Briefing at the start of the mission.

string Expansions.Missions.Actions.ActionDialogMessage.message

The Text of the message dialog

string Expansions.Missions.Actions.ActionDialogMessage.messageHeading

The Header/Title of the Message dialog

MissionInstructor Expansions.Missions.Actions.ActionDialogMessage.missionInstructor

The Instructor that will appear in the dialog

bool Expansions.Missions.Actions.ActionDialogMessage.pauseMission

DialogMessageArea Expansions.Missions.Actions.ActionDialogMessage.screenArea

int Expansions.Missions.Actions.ActionDialogMessage.textAreaSize

The vertical height of the dialog.

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

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

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation