Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
Expansions.Missions.VesselRestriction Class Reference
Inheritance diagram for Expansions.Missions.VesselRestriction:
Expansions.Missions.DynamicModule IConfigNode Expansions.Missions.IMENodeDisplay Expansions.Missions.VesselRestriction_Cost Expansions.Missions.VesselRestriction_Crew Expansions.Missions.VesselRestriction_Mass Expansions.Missions.VesselRestriction_PartCount Expansions.Missions.VesselRestriction_RequiredParts Expansions.Missions.VesselRestriction_Resource Expansions.Missions.VesselRestriction_Size Expansions.Missions.VesselRestriction_Stages

Public Member Functions

void AddAppUIReference (ref UIListItem listItem, ref UIStateImage listItemState)
 Links the MisssionAPP UI elements to this vessel restriction, this will allow it to update its own values when the appropiate GameEvents fire. More...
 
void ClearAppUIREference ()
 Clears the UI references from the MissionApp More...
 
virtual void ClearEvents ()
 
override string GetDisplayName ()
 The name to be displayed on the SAP window when adding the module or on its header once its added. More...
 
virtual
PreFlightTests.IPreFlightTest 
GetPreflightCheck ()
 Returns an instance of a PreFlightCheck linked with this restriction, this will allow it to be checked before launch. More...
 
virtual string GetStateMessage ()
 Returns the text that will be displayed on the mission app. More...
 
virtual bool IsComplete ()
 Returns true if the restriction conditions have been met. More...
 
virtual bool SameComparator (VesselRestriction otherRestriction)
 checks whether this restriction is making the same comparison as another More...
 
virtual void SuscribeToEvents ()
 
virtual void UpdateAppEntry ()
 Updates the text on the restriction entry in the Missions App with the appropiate text. It will also change the state of the icon in the App and will set the Vessel ready to Launch indicator in the App based on the state. If you replace this virtual method you MUST call the base method. More...
 
 VesselRestriction ()
 
 VesselRestriction (MENode node)
 
- 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 Load (ConfigNode node)
 
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...
 
virtual void Save (ConfigNode node)
 
void SetNode (MENode node)
 Sets the linked Mission Node More...
 
void UpdateNodeBodyUI ()
 Updates the node body parameters More...
 

Static Public Member Functions

static bool TestInt (int currentValue, int targetValue, TestComparisonLessGreaterEqual comparisonOperator)
 Tests a integer value against another, will return true if the the comparison operator conditions are met. More...
 

Static Protected Member Functions

static bool TestFloat (float currentValue, float targetValue, TestComparisonLessGreaterEqual comparisonOperator)
 Tests a float value against another, will return true if the the comparison operator conditions are met. More...
 

Protected Attributes

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

Additional Inherited Members

- Public Attributes inherited from Expansions.Missions.DynamicModule
List< string > parametersDisplayedInSAP
 The parameters displayed in the Settings Action Pane 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.VesselRestriction.VesselRestriction ( )
inline
Expansions.Missions.VesselRestriction.VesselRestriction ( MENode  node)
inline

Member Function Documentation

void Expansions.Missions.VesselRestriction.AddAppUIReference ( ref UIListItem  listItem,
ref UIStateImage  listItemState 
)
inline

Links the MisssionAPP UI elements to this vessel restriction, this will allow it to update its own values when the appropiate GameEvents fire.

Parameters
listItemThe body of the UI entry in the mission app
listItemStateThe image icon that will display the status of the restriction
void Expansions.Missions.VesselRestriction.ClearAppUIREference ( )
inline

Clears the UI references from the MissionApp

virtual void Expansions.Missions.VesselRestriction.ClearEvents ( )
inlinevirtual
override string Expansions.Missions.VesselRestriction.GetDisplayName ( )
inlinevirtual
virtual PreFlightTests.IPreFlightTest Expansions.Missions.VesselRestriction.GetPreflightCheck ( )
inlinevirtual

Returns an instance of a PreFlightCheck linked with this restriction, this will allow it to be checked before launch.

Returns
virtual string Expansions.Missions.VesselRestriction.GetStateMessage ( )
inlinevirtual
virtual bool Expansions.Missions.VesselRestriction.IsComplete ( )
inlinevirtual
virtual bool Expansions.Missions.VesselRestriction.SameComparator ( VesselRestriction  otherRestriction)
inlinevirtual

checks whether this restriction is making the same comparison as another

only gets called when the type of the restriction is the same as the other one

Parameters
otherRestrictionThe restriction to test against
Returns
Returns true if they are making the same comparison

Reimplemented in Expansions.Missions.VesselRestriction_Resource, Expansions.Missions.VesselRestriction_Size, Expansions.Missions.VesselRestriction_Crew, Expansions.Missions.VesselRestriction_Mass, Expansions.Missions.VesselRestriction_Stages, Expansions.Missions.VesselRestriction_Cost, and Expansions.Missions.VesselRestriction_PartCount.

virtual void Expansions.Missions.VesselRestriction.SuscribeToEvents ( )
inlinevirtual
static bool Expansions.Missions.VesselRestriction.TestFloat ( float  currentValue,
float  targetValue,
TestComparisonLessGreaterEqual  comparisonOperator 
)
inlinestaticprotected

Tests a float value against another, will return true if the the comparison operator conditions are met.

static bool Expansions.Missions.VesselRestriction.TestInt ( int  currentValue,
int  targetValue,
TestComparisonLessGreaterEqual  comparisonOperator 
)
inlinestatic

Tests a integer value against another, will return true if the the comparison operator conditions are met.

virtual void Expansions.Missions.VesselRestriction.UpdateAppEntry ( )
inlinevirtual

Updates the text on the restriction entry in the Missions App with the appropiate text. It will also change the state of the icon in the App and will set the Vessel ready to Launch indicator in the App based on the state. If you replace this virtual method you MUST call the base method.

Member Data Documentation

UIListItem Expansions.Missions.VesselRestriction.UIEntry
protected

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