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.VesselRestriction_Mass Class Reference
Inheritance diagram for Expansions.Missions.VesselRestriction_Mass:
Expansions.Missions.VesselRestriction Expansions.Missions.DynamicModule IConfigNode Expansions.Missions.IMENodeDisplay

Public Member Functions

override void ClearEvents ()
 
float GetCurrentMass ()
 
override string GetDisplayName ()
 The name to be displayed on the SAP window when adding the module or on its header once its added. More...
 
override string GetStateMessage ()
 Returns the text that will be displayed on the mission app. More...
 
override bool IsComplete ()
 Returns true if the restriction conditions have been met. More...
 
override void Load (ConfigNode node)
 
override bool SameComparator (VesselRestriction otherRestriction)
 checks whether this restriction is making the same comparison as another More...
 
override void Save (ConfigNode node)
 
override void SuscribeToEvents ()
 
 VesselRestriction_Mass ()
 
 VesselRestriction_Mass (MENode node)
 
- Public Member Functions inherited from Expansions.Missions.VesselRestriction
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
PreFlightTests.IPreFlightTest 
GetPreflightCheck ()
 Returns an instance of a PreFlightCheck linked with this restriction, this will allow it to be checked before launch. More...
 
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 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

TestComparisonLessGreaterEqual comparisonOperator = TestComparisonLessGreaterEqual.GreaterOrEqual
 
float targetMass = 0
 
- Public Attributes inherited from Expansions.Missions.DynamicModule
List< string > parametersDisplayedInSAP
 The parameters displayed in the Settings Action Pane More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Expansions.Missions.VesselRestriction
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 inherited from Expansions.Missions.VesselRestriction
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 inherited from Expansions.Missions.VesselRestriction
UIListItem UIEntry
 
- Protected Attributes inherited from Expansions.Missions.DynamicModule
MENode node
 Refernce to the Node that the action is part of 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_Mass.VesselRestriction_Mass ( )
inline
Expansions.Missions.VesselRestriction_Mass.VesselRestriction_Mass ( MENode  node)
inline

Member Function Documentation

override void Expansions.Missions.VesselRestriction_Mass.ClearEvents ( )
inlinevirtual
float Expansions.Missions.VesselRestriction_Mass.GetCurrentMass ( )
inline
override string Expansions.Missions.VesselRestriction_Mass.GetDisplayName ( )
inlinevirtual

The name to be displayed on the SAP window when adding the module or on its header once its added.

Returns

Reimplemented from Expansions.Missions.VesselRestriction.

override string Expansions.Missions.VesselRestriction_Mass.GetStateMessage ( )
inlinevirtual

Returns the text that will be displayed on the mission app.

Reimplemented from Expansions.Missions.VesselRestriction.

override bool Expansions.Missions.VesselRestriction_Mass.IsComplete ( )
inlinevirtual

Returns true if the restriction conditions have been met.

Reimplemented from Expansions.Missions.VesselRestriction.

override void Expansions.Missions.VesselRestriction_Mass.Load ( ConfigNode  node)
inlinevirtual

Reimplemented from Expansions.Missions.DynamicModule.

override bool Expansions.Missions.VesselRestriction_Mass.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 from Expansions.Missions.VesselRestriction.

override void Expansions.Missions.VesselRestriction_Mass.Save ( ConfigNode  node)
inlinevirtual

Reimplemented from Expansions.Missions.DynamicModule.

override void Expansions.Missions.VesselRestriction_Mass.SuscribeToEvents ( )
inlinevirtual

Member Data Documentation

TestComparisonLessGreaterEqual Expansions.Missions.VesselRestriction_Mass.comparisonOperator = TestComparisonLessGreaterEqual.GreaterOrEqual
float Expansions.Missions.VesselRestriction_Mass.targetMass = 0

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