Expansions.Missions.ScoreModule Class Reference

Inheritance diagram for Expansions.Missions.ScoreModule:

Public Member Functions
virtual float	AwardScore (float currentScore)
	Update the mission score with the result of this score module More...
string	AwarededScoreDescription ()
	Get the awarded score description of this score module More...
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	Save (ConfigNode node)
virtual string	ScoreDescription ()
	Get the score description of this score module More...
	ScoreModule ()
	Creates a new instance of this score module More...
	ScoreModule (MENode node)
	Creates a new instance of this score module More...
Public Member Functions inherited from Expansions.Missions.DynamicModule
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 object	Clone ()
virtual void	Destroy ()
	Perform all the cleaning operations that we need before the module is destroyed. More...
	DynamicModule ()
	DynamicModule (MENode node)
	Creates a new instance of this dynamic module More...
override bool	Equals (object obj)
virtual List< string >	GetDefaultPinnedParameters ()
	Get a list of default node pinned parameters for this dynamic module More...
virtual string	GetDisplayName ()
	Get the display name for this module More...
virtual string	GetDisplayToolTip ()
	Get the tooltip for this module UI More...
override int	GetHashCode ()
virtual string	GetInfo ()
	Get the information to be displayed about the module in the tooltip. More...
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 ()
	Perform all the setup operations that we need when the module is initialised in the mission builder. More...
virtual void	ParameterSetupComplete ()
	Can be used as a hook once all the parameters in a module have been setup and/or displayed in the SAP. 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	SetNode (MENode node)
	Sets the linked Mission Node More...
void	UpdateNodeBodyUI ()
	Updates the node body parameters More...

Protected Attributes
string	awardedScoreDescription
	When you get an score in this module, this will store the details of that score More...
Protected Attributes inherited from Expansions.Missions.DynamicModule
MENode	node
	Refernce to the Node that the action is part of More...

Properties
IScoreableObjective	scoreableObjective [get]
	Get the reference to the docked node scoreable objective More...
Properties inherited from Expansions.Missions.DynamicModule
virtual bool	canBeDisplayedInEditor [get]
	Does this dynamic module can be displayed in the editor More...
string	id [get, set]
	Id of this dynamic module instance, this is a unique autogenerated number to diferenciate mutliple instance of the same type More...
string	name [get, set]
	the name of the module class More...

Additional Inherited Members
Public Attributes inherited from Expansions.Missions.DynamicModule
List< string >	parametersDisplayedInSAP
	The parameters displayed in the Settings Action Pane More...

Constructor & Destructor Documentation

Expansions.Missions.ScoreModule.ScoreModule ( )

inline

Creates a new instance of this score module

Expansions.Missions.ScoreModule.ScoreModule ( MENode  node )

inline

Creates a new instance of this score module

Member Function Documentation

virtual float Expansions.Missions.ScoreModule.AwardScore ( float  currentScore )

inlinevirtual

Update the mission score with the result of this score module

Parameters

currentScore

Returns

Reimplemented in Expansions.Missions.ScoreModule_Accuracy, Expansions.Missions.ScoreModule_Modifier, Expansions.Missions.ScoreModule_Resource, Expansions.Missions.ScoreModule_Completion, and Expansions.Missions.ScoreModule_Time.

string Expansions.Missions.ScoreModule.AwarededScoreDescription ( )

inline

Get the awarded score description of this score module

Returns

override string Expansions.Missions.ScoreModule.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.DynamicModule.

Reimplemented in Expansions.Missions.ScoreModule_Accuracy, Expansions.Missions.ScoreModule_Modifier, Expansions.Missions.ScoreModule_Resource, and Expansions.Missions.ScoreModule_Time.

override void Expansions.Missions.ScoreModule.Load ( ConfigNode  node )

inlinevirtual

Reimplemented from Expansions.Missions.DynamicModule.

Reimplemented in Expansions.Missions.ScoreModule_Accuracy, Expansions.Missions.ScoreModule_Resource, Expansions.Missions.ScoreModule_Modifier, Expansions.Missions.ScoreModule_Time, and Expansions.Missions.ScoreModule_Completion.

override void Expansions.Missions.ScoreModule.Save ( ConfigNode  node )

inlinevirtual

Reimplemented from Expansions.Missions.DynamicModule.

Reimplemented in Expansions.Missions.ScoreModule_Accuracy, Expansions.Missions.ScoreModule_Resource, Expansions.Missions.ScoreModule_Modifier, Expansions.Missions.ScoreModule_Time, and Expansions.Missions.ScoreModule_Completion.

virtual string Expansions.Missions.ScoreModule.ScoreDescription ( )

inlinevirtual

Get the score description of this score module

Returns

Reimplemented in Expansions.Missions.ScoreModule_Accuracy, Expansions.Missions.ScoreModule_Modifier, Expansions.Missions.ScoreModule_Resource, Expansions.Missions.ScoreModule_Time, and Expansions.Missions.ScoreModule_Completion.

Member Data Documentation

string Expansions.Missions.ScoreModule.awardedScoreDescription

protected

When you get an score in this module, this will store the details of that score

Property Documentation

IScoreableObjective Expansions.Missions.ScoreModule.scoreableObjective

getprotected

Get the reference to the docked node scoreable objective

---

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

• KSP/Assets/Expansions/Missions/Scripts/ScoreModule.cs