Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | List of all members
Expansions.Missions.Adjusters.AdjusterReactionWheelBase Class Reference
Inheritance diagram for Expansions.Missions.Adjusters.AdjusterReactionWheelBase:
Expansions.Missions.Adjusters.AdjusterPartModuleBase Expansions.Missions.DynamicModule IConfigNode Expansions.Missions.Adjusters.IPartModuleAdjuster IConfigNode Expansions.Missions.IMENodeDisplay Expansions.Missions.Adjusters.AdjusterReactionWheelTorque Expansions.Missions.Adjusters.FailureReactionWheelBroken Expansions.Missions.Adjusters.FailureReactionWheelStuck

Public Member Functions

 AdjusterReactionWheelBase ()
 Constructor More...
 
 AdjusterReactionWheelBase (MENode node)
 Constructor More...
 
virtual Vector3 ApplyTorqueAdjustment (Vector3 torque)
 Called by the Reaction Wheel Module to apply our adjustments. More...
 
override Type GetTargetPartModule ()
 Get the PartModule Type that is the Target for this Adjuster Class. More...
 
virtual bool IsReactionWheelBroken ()
 Called by the reaction wheel module to check whether it is being broken by the adjuster. More...
 
- Public Member Functions inherited from Expansions.Missions.Adjusters.AdjusterPartModuleBase
virtual void Activate ()
 Activate this adjuster. More...
 
 AdjusterPartModuleBase ()
 Constructor More...
 
 AdjusterPartModuleBase (MENode node)
 Constructor More...
 
void CleanUp ()
 Call this to clean up all the bits and bobs from the part module adjuster. More...
 
virtual void Deactivate ()
 Deactivate this adjuster. More...
 
override string GetDisplayName ()
 Get the display name for this module More...
 
override string GetNodeBodyParameterString (BaseAPField field)
 Returns the string to be displayed when the parameter is displayed in the node body More...
 
List< Type > GetPartModulesThatCanBeAffected ()
 Get a list of all the part modules that can be affected by this adjuster. This method controls the manner in which we work out the part modules that can be affected. We take a list of the target classes, then figure out all of their children and add them all to a list of part modules that can be affected. If you just want to add an extra class or two to the list, override GetPartModuleTarget() or GetPartModuleTargetList() instead. More...
 
virtual List< Type > GetPartModuleTargetList ()
 Get a list of all the target part modules that can be affected by this adjuster. We'll use the information in GetPartModulesThatCanBeAffected() and search for all the child classes too. More...
 
override void Load (ConfigNode node)
 
virtual void OnPartModuleAdjusterListModified ()
 Another part module adjuster has been added or removed to the affected part module. More...
 
void RemoveAdjuster ()
 
override void Save (ConfigNode node)
 
void Setup (PartModule newPartModule)
 Call this to set up this part module adjuster. More...
 
void UpdateStatusMessage (string newStatusMessage)
 Changes the status message for this adjuster to be displayed in the PAW. The status message stays the same until this method is called, so you don't have to call it every frame. 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...
 
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...
 

Additional Inherited Members

- Public Types inherited from Expansions.Missions.Adjusters.AdjusterPartModuleBase
enum  FailureActivationState : int { FailureActivationState.CurrentState, FailureActivationState.On, FailureActivationState.Off }
 We use this to specify the failure state for any part that can turn on and off More...
 
enum  FailureDeploymentState : int { FailureDeploymentState.CurrentState, FailureDeploymentState.Deployed, FailureDeploymentState.Retracted }
 We use this to specify the failure state for any part that can deploy More...
 
enum  FailureOpenState : int { FailureOpenState.CurrentState, FailureOpenState.Open, FailureOpenState.Closed }
 We use this to specify the failure state for any part that can open and close More...
 
- Static Public Member Functions inherited from Expansions.Missions.Adjusters.AdjusterPartModuleBase
static AdjusterPartModuleBase CreateInstanceOfModuleAdjuster (ConfigNode node)
 Creates a new part module adjuster, then loads the node information into it. More...
 
static AdjusterPartModuleBase CreateInstanceOfModuleAdjuster (string className)
 Creates a new part module adjuster. More...
 
static List
< AdjusterPartModuleBase
CreateModuleAdjusterList (ConfigNode node)
 
- Public Attributes inherited from Expansions.Missions.Adjusters.AdjusterPartModuleBase
Guid adjusterID
 Unique ID to identify this part adjuster More...
 
string AdjusterState = "#autoLOC_8100276"
 Field which is displayed in the PAW to show the status of the module adjuster. More...
 
bool canBeRepaired
 Is this adjuster a failure that can be repaired? More...
 
bool disableKSPActions
 Should all the part module KSP actions be disabled? More...
 
bool disableKSPEvents
 Should all the part module KSP events be disabled? More...
 
bool disableKSPFields
 Should all the part module KSP Fields be disabled? More...
 
- Public Attributes inherited from Expansions.Missions.DynamicModule
List< string > parametersDisplayedInSAP
 The parameters displayed in the Settings Action Pane More...
 
- Protected Attributes inherited from Expansions.Missions.Adjusters.AdjusterPartModuleBase
PartModule adjustedModule
 
string guiName = "#autoLOC_8000002"
 Name for this adjuster used in all the displays More...
 
- 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.Adjusters.AdjusterPartModuleBase
int ClassID [get]
 Hash code of the class name. More...
 
string ClassName [get]
 Class name. More...
 
BaseEventList Events [get]
 All the PAW events supported by the adjuster More...
 
BaseFieldList Fields [get]
 All the PAW fields supported by the adjuster 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.Adjusters.AdjusterReactionWheelBase.AdjusterReactionWheelBase ( )
inline

Constructor

Expansions.Missions.Adjusters.AdjusterReactionWheelBase.AdjusterReactionWheelBase ( MENode  node)
inline

Constructor

Member Function Documentation

virtual Vector3 Expansions.Missions.Adjusters.AdjusterReactionWheelBase.ApplyTorqueAdjustment ( Vector3  torque)
inlinevirtual

Called by the Reaction Wheel Module to apply our adjustments.

Parameters
torqueCurrent torque to adjust.
Returns
The adjusted value

Reimplemented in Expansions.Missions.Adjusters.AdjusterReactionWheelTorque, and Expansions.Missions.Adjusters.FailureReactionWheelStuck.

override Type Expansions.Missions.Adjusters.AdjusterReactionWheelBase.GetTargetPartModule ( )
inlinevirtual

Get the PartModule Type that is the Target for this Adjuster Class.

Returns
Type of the PartModule

Reimplemented from Expansions.Missions.Adjusters.AdjusterPartModuleBase.

virtual bool Expansions.Missions.Adjusters.AdjusterReactionWheelBase.IsReactionWheelBroken ( )
inlinevirtual

Called by the reaction wheel module to check whether it is being broken by the adjuster.

returns>True if the grapple node is being broken, false otherwise.

Reimplemented in Expansions.Missions.Adjusters.FailureReactionWheelBroken.


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