Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
Expansions.Missions.AwardModule Class Reference
Inheritance diagram for Expansions.Missions.AwardModule:
Expansions.Missions.DynamicModule IConfigNode Expansions.Missions.IMENodeDisplay Expansions.Missions.AwardModule_Fuel Expansions.Missions.AwardModule_KerbalsDied Expansions.Missions.AwardModule_KerbalsSurvived Expansions.Missions.AwardModule_LandedOn Expansions.Missions.AwardModule_MissionTime Expansions.Missions.AwardModule_PlanetsLanded Expansions.Missions.AwardModule_Score Expansions.Missions.AwardModule_TraveledLessThan Expansions.Missions.AwardModule_TraveledMoreThan Expansions.Missions.AwardModule_VesselsUsed

Public Member Functions

 AwardModule (MENode node)
 Creates a new instance of this AwardModule More...
 
 AwardModule (MENode node, AwardDefinition definition)
 Creates a new instance of this AwardModule More...
 
void EvaluateAward (Mission mission, ref List< string > awards)
 Evaluates if this award has been awarded, updates the mission score and updates the awards list for this mission More...
 
override string GetDisplayName ()
 Get the display name of this award More...
 
override void Load (ConfigNode node)
 
override void Save (ConfigNode node)
 
virtual void StartTracking ()
 Start the awards progress tracking More...
 
virtual void StopTracking ()
 Stop the awards progress tracking 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 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< 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...
 
virtual string GetNodeBodyParameterString (BaseAPField field)
 Returns the string to be displayed when the parameter is displayed in the node body 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...
 

Public Attributes

bool enabled
 Is this award enabled More...
 
float score
 Bonus score granted for this award More...
 
- Public Attributes inherited from Expansions.Missions.DynamicModule
List< string > parametersDisplayedInSAP
 The parameters displayed in the Settings Action Pane More...
 

Protected Member Functions

virtual bool EvaluateCondition (Mission mission)
 Evaluates the internal condition for this award More...
 

Protected Attributes

string awardID
 
- Protected Attributes inherited from Expansions.Missions.DynamicModule
MENode node
 Refernce to the Node that the action is part of More...
 

Properties

AwardDefinition Definition [get]
 Award defintition for this award 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...
 

Constructor & Destructor Documentation

Expansions.Missions.AwardModule.AwardModule ( MENode  node)
inline

Creates a new instance of this AwardModule

Parameters
missionScoreable
Expansions.Missions.AwardModule.AwardModule ( MENode  node,
AwardDefinition  definition 
)
inline

Creates a new instance of this AwardModule

Parameters
missionScoreable

Member Function Documentation

void Expansions.Missions.AwardModule.EvaluateAward ( Mission  mission,
ref List< string >  awards 
)
inline

Evaluates if this award has been awarded, updates the mission score and updates the awards list for this mission

Parameters
missionCurrent mission
awardsList of earned awards
Returns
virtual bool Expansions.Missions.AwardModule.EvaluateCondition ( Mission  mission)
inlineprotectedvirtual
override string Expansions.Missions.AwardModule.GetDisplayName ( )
inlinevirtual

Get the display name of this award

Returns

Reimplemented from Expansions.Missions.DynamicModule.

override void Expansions.Missions.AwardModule.Load ( ConfigNode  node)
inlinevirtual
override void Expansions.Missions.AwardModule.Save ( ConfigNode  node)
inlinevirtual
virtual void Expansions.Missions.AwardModule.StartTracking ( )
inlinevirtual
virtual void Expansions.Missions.AwardModule.StopTracking ( )
inlinevirtual

Member Data Documentation

string Expansions.Missions.AwardModule.awardID
protected
bool Expansions.Missions.AwardModule.enabled

Is this award enabled

float Expansions.Missions.AwardModule.score

Bonus score granted for this award

Property Documentation

AwardDefinition Expansions.Missions.AwardModule.Definition
get

Award defintition for this award


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