Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
ModuleResourceDrain Class Reference

Perform an Action on a Part to drain a resource from it over time. More...

Inheritance diagram for ModuleResourceDrain:
PartModule IConstruction

Classes

class  ResourceDrainStatus
 

Public Member Functions

virtual bool CanBeDetached ()
 Returns true if not draining More...
 
virtual bool CanBeOffset ()
 Returns true if not draining More...
 
virtual bool CanBeRotated ()
 Returns true if not draining More...
 
virtual void DrainPart ()
 This will drain the Part or ProtoPartSnapShot every frame (fixed frame rate, within the physiscs system) until we have drained all that is required or we run out of the resource. More...
 
void ForceUpdateResourcePAW (string resourceName, bool status)
 Refresh the resources list status in the PAW More...
 
bool IsResourceDraining (PartResource pR)
 Check if a resource is being marked for draining. More...
 
override void OnAwake ()
 Method fires once the module has been added to the part. Use for first time setup. Module will not have loaded fully by this point More...
 
override void OnLoad (ConfigNode node)
 Use OnLoad to load any additional data from the ConfigNode provided More...
 
override void OnSave (ConfigNode node)
 Use OnSave to serialize additional module information into the ConfigNode provided More...
 
override void OnStart (StartState state)
 Called when the part starts. The StartState gives an indication of where in flight you are. All values may not be plugged in! More...
 
override void OnStartFinished (StartState state)
 Called when the part finishes starting. The StartState gives an indication of where in flight you are. All values may not be plugged in! More...
 
void StartResourceDrainAction (KSPActionParam param)
 Starts draining the assigned resource until stopped or depleted. More...
 
void StopResourceDrainAction (KSPActionParam param)
 Stops draining the assigned resource. More...
 
void ToggleDrain ()
 Start or stops draining resources. More...
 
void TogglePartResource (PartResource resource, bool status)
 Adds or removes a part resource depending on the status received. More...
 
void ToggleResourceDrainAction (KSPActionParam param)
 Toggle draining the assigned resource. More...
 
void ToggleResourceDrainFlowAction (KSPActionParam param)
 Toggle draining mode for the single part of the vessel through the flow mode. More...
 
void TurnOffDrain ()
 Stops draining resources. More...
 
void TurnOffDrain (List< string > resourcesToStopDraining)
 Stops draining selected resources. More...
 
void TurnOnDrain ()
 Starts draining all the part's resources. More...
 
void UpdateResourcesToRelease (List< string > resourceNames, bool exclude=false)
 Updates the list for the resources to release More...
 
- Public Member Functions inherited from PartModule
void AddPartModuleAdjuster (AdjusterPartModuleBase newAdjuster)
 Call this to add an adjuster to this part module. More...
 
void AddPartModuleAdjusterList (List< AdjusterPartModuleBase > moduleAdjusters)
 Applies the appropriate module adjusters. Performs checks to make sure that the adjusters are valid too. More...
 
bool AppliedUpgrades ()
 Returns true if upgrades are applied More...
 
void ApplyAdjustersOnStart ()
 Called when a part module is loaded and applies all of the currently loaded adjusters. More...
 
virtual void ApplyUpgradeNode (List< string > appliedUps, ConfigNode node, bool doLoad)
 Applies the upgrades to a confignode. Will either copy the upgrades back to the node or (if doLoad) calls load/onload on it. More...
 
virtual bool ApplyUpgrades (StartState state)
 Will find and apply upgrades. Called during Part's ModulesOnStart, before a module's OnStart. More...
 
void Awake ()
 
delegate bool boolPMApplyUpgrades (PartModule pm, StartState state)
 
delegate bool boolPMBoolDelegate (PartModule pm, bool apply)
 
void ClearPersistentId ()
 Clear the modules persistentId More...
 
void Copy (PartModule fromModule)
 
virtual void DemoteToPhysicslessPart ()
 This method will be called from Part class DemoteToPhysicslessPart when the part is being converted from physical to physicsless part. It is called before the joints and rigidbodies are destroyed. More...
 
virtual bool FindUpgrades (bool fillApplied, ConfigNode node=null)
 Find applicable upgrades to the partmodule (isunlocked and isenabled) and add to the upgradesApplied list. Pass true if you want to add the upgrades to upgradesApplied, false if you just want to know if at least one upgrade is applicable (unlocked rather than enabled) More...
 
virtual Color GetCurrentColor ()
 Returns the current part module color. More...
 
virtual Color GetCurrentColor (string fieldName)
 Returns the current part module color for a field where usespe. More...
 
virtual string GetInfo ()
 Returns formatted string of additional data for use in the VAB and SPH More...
 
virtual string GetModuleDisplayName ()
 Override this to provide a Localized version of the PartModules Name for UI components More...
 
uint GetPersistenActiontId ()
 Get the modules persistentID, and create one if it doesnt already have one More...
 
uint GetPersistentId ()
 Get the modules persistentID, and create one if it doesnt already have one More...
 
virtual string GetStagingDisableText ()
 
virtual string GetStagingEnableText ()
 
virtual string GetUpgradeInfo ()
 Called by Upgrade Stats dialog More...
 
bool HasUpgrades ()
 Returns true if upgrades exist for the partmodule More...
 
virtual bool IsStageable ()
 Should this module be counted when seeing whether to have a stack icon present? Override in a module for custom behavior; otherwise returns true if the module (or something the module inherits from above PartModule itself) overrides OnActive() More...
 
bool IsValidContractObjective (string objectiveType)
 Returns if, for example, an antenna part module qualifies as an antenna for contracts. More...
 
void Load (ConfigNode node)
 
virtual void LoadUpgrades (ConfigNode node)
 Loads module-relevant upgrades from the partmodule confignode More...
 
uint NewPersistentId ()
 Reset the modules persistentId to a new number More...
 
virtual void OnActive ()
 Called when the part is set active (after unpacking etc) More...
 
virtual void OnColorChanged (Color color)
 Meant to be overwritten by part modules implementing color changes. In this case, it doesn't matter which color picker changed specifically. More...
 
virtual void OnColorChanged (Color color, string pickerID="")
 Meant to be overwritten by part modules implementing color changes More...
 
virtual void OnConstructionModeFixedUpdate ()
 This method will be called when in EVA Construction mode and this part and itself is disabled (when it is not attached to a vessel) every FixedUpdate(). More...
 
virtual void OnConstructionModeUpdate ()
 This method will be called when in EVA Construction mode and this part and itself is disabled (when it is not attached to a vessel) every Update(). More...
 
virtual void OnCopy (PartModule fromModule)
 Use OnCopy to copy any additional data from the PartModule provided More...
 
virtual void OnFixedUpdate ()
 Called every physics/fixed frame that the part is active More...
 
virtual void OnIconCreate ()
 Method fires just before components are stripped from the gameobject to make it an icon. (The part is instantiated and then various components like Part, PartModule, EffectBehaviour, Colliders, Particles, etc are stripped and then it's set as the icon prefab. This lets PartModules do stuff to the model right before that happens. More...
 
virtual void OnInactive ()
 Called before the part goes inactive (after packing etc) More...
 
virtual void OnInitialize ()
 Called on all modules after all parts are loaded but before they give the ship to the game More...
 
virtual void OnInventoryModeDisable ()
 This method will be called when this modules part and itself is first disabled (when it is not attached to a vessel) when created in Inventory/Construction mode. More...
 
virtual void OnInventoryModeEnable ()
 This method will be called when this modules part and itself is first enabled (when it is attached to a vessel) when created in Inventory/Construction mode. More...
 
void OnModuleAdjusterAddedWrapper (AdjusterPartModuleBase adjuster)
 Wrapper to check the mission expansion availability before performing processing specific to this part module when an adjuster is added. More...
 
virtual void OnModuleAdjusterRemoved (AdjusterPartModuleBase adjuster)
 Perform processing specific to this part module when an adjuster is removed. By default this does nothing is up to each part module to implement it properly. More...
 
virtual void OnPartCreatedFomInventory (ModuleInventoryPart moduleInventoryPart)
 This method is called when a part is being taken out from a slot while being in EVAConstruction mode. More...
 
virtual void OnStartBeforePartAttachJoint (StartState state)
 Called in flight scene in Part.Start just before the Part attachnode joints are created. More...
 
virtual void OnStoredInInventory (ModuleInventoryPart moduleInventoryPart)
 Called when the part is stored in an inventory. More...
 
virtual void OnUpdate ()
 Called every frame that the part is active More...
 
virtual void OnWasCopied (PartModule copyPartModule, bool asSymCounterpart)
 Called when the PartModule was copied, through Alt+Copy or symmetry More...
 
virtual void OnWillBeCopied (bool asSymCounterpart)
 Called when the PartModule is about to be copied, through Alt+Copy or symmetry More...
 
virtual bool OnWillBeMirrored (ref Quaternion rotation, AttachNode selPartNode, Part partParent)
 This is called in the Editor scene when a symmetry copy of a part is being positioned. Only called on the symmetry parts and only when symmetry mode is set to Mirror. It allows the mirror rotation to be changed and returned before being applied to the symmetry copy part.

Parameters
rotationThe current calculated rotation. Will be updated if method returns true.
selPartNodeThe attachnode.
partParentThe part that will become this part's parent.
Returns
True if the rotation was changed. Otherwise will return false.
More...
 
virtual List< Color > PresetColors ()
 Preset colors received for any part module. By default, returns only black, override to make your own selection. More...
 
virtual string PrintUpgrades ()
 
virtual void PromoteToPhysicalPart ()
 This method will be called from Part class PromoteToPhysicalPart when the part is being converted from physicsless to physical part. More...
 
void RemovePartModuleAdjuster (AdjusterPartModuleBase oldAdjuster)
 Call this to remove an adjuster from this part module. More...
 
void RemovePartModuleAdjusterList (List< AdjusterPartModuleBase > moduleAdjusters)
 Removes the appropriate module adjusters. Performs checks to make sure that the adjusters are valid too. More...
 
void Save (ConfigNode node)
 
virtual void SetStaging (bool newValue)
 Run by the part's staging toggle handler, sets staging on modules on symmetry counterparts. More...
 
void SetStagingState (bool newState)
 Set the staging enabled bool for this module. More...
 
virtual bool StagingEnabled ()
 Gets current staging status (is staging enabled for this module) Override me! More...
 
virtual bool StagingToggleEnabledEditor ()
 
virtual bool StagingToggleEnabledFlight ()
 
void ToggleStaging ()
 
virtual void UpdateStagingToggle ()
 Updates the staging toggle More...
 
delegate void voidPMApplyNodeDelegate (PartModule pm, List< string > appliedUps, ConfigNode node, bool doLoad)
 
delegate void voidPMDelegate (PartModule pm)
 
delegate void voidPMNodeDelegate (PartModule pm, ConfigNode node)
 

Static Public Member Functions

static void CacheLocalStrings ()
 
- Static Public Member Functions inherited from PartModule
static ReflectedAttributes GetReflectedAttributes (Type partModuleType)
 
static PartUpgradeState UpgradesAvailable (Part part)
 Returns true if at least one module on the part has at least one upgrade available (isUnlocked) More...
 
static PartUpgradeState UpgradesAvailable (Part part, ConfigNode node)
 Returns true if at least one module on the part has at least one upgrade available (isUnlocked) More...
 

Public Attributes

float drainRate = 10f
 Rate Percentage in which a resource is drained over time. More...
 
bool flowMode
 Flow mode flag in order to switch between Part only and Vessel resource flow modes. true - use flowmode (whole vessel) false - parent part only - no flow. More...
 
float maxDrainRate = 20f
 Maximum Resource Drain rate per Second More...
 
float minDrainRate = 1f
 Minimum Resource Drain rate per Second More...
 
string noResourceAvailable = string.Empty
 Display text for when there are no available resources to drain. More...
 
string resourceName
 The resources from this part to drain, set on the part's Config File. More...
 
List< PartResourceresourcesAvailable = null
 Available resources to release. More...
 
int resourcesDraining
 This is the number of resources being drained. More...
 
- Public Attributes inherited from PartModule
bool isEnabled = true
 
bool moduleIsEnabled = true
 
string moduleName
 
bool overrideStagingIconIfBlank = true
 
ModuleResourceHandler resHandler = new ModuleResourceHandler()
 
bool showUpgradesInModuleInfo = false
 
ProtoPartModuleSnapshot snapshot
 
string stagingDisableText = ""
 
bool stagingEnabled = true
 
string stagingEnableText = ""
 
bool stagingToggleEnabledEditor = false
 
bool stagingToggleEnabledFlight = false
 
List< ConfigNodeupgrades
 
List< string > upgradesApplied = new List<string>()
 
bool upgradesApply = true
 
bool upgradesAsk = true
 

Protected Member Functions

void OnPartMenuOpen (UIPartActionWindow window, Part inpPart)
 
- Protected Member Functions inherited from PartModule
ConfigNode GetUpgrade (string name)
 
virtual void LoadUpgradesApplied (List< string > applieds, ConfigNode node)
 Load the applied upgrade names More...
 
virtual void OnModuleAdjusterAdded (AdjusterPartModuleBase adjuster)
 Perform processing specific to this part module when an adjuster is added. By default this does nothing is up to each part module to implement it properly. More...
 
virtual void SaveUpgradesApplied (ConfigNode node)
 Save the applied upgrades. More...
 
IEnumerator UpgradeWaitForScenarioModules ()
 

Protected Attributes

List< FXGroupdrainFXGroups = null
 
FXGroup highestPriorityFXGroup
 
bool isDraining
 

Properties

bool IsDraining [get, set]
 Check if the part is currently draining it's own resource or resources. More...
 
bool IsInactive [get]
 Check if this module is active. More...
 
- Properties inherited from PartModule
BaseActionList Actions [get]
 
int ClassID [get]
 
string ClassName [get]
 
List< AdjusterPartModuleBaseCurrentModuleAdjusterList [get]
 List of all the module adjusters that are currently active on this part module. More...
 
BaseEventList Events [get]
 
BaseFieldList Fields [get]
 
string GUIName [get]
 
bool HasAdjusters [get]
 Has this part module been adjusted? More...
 
ReflectedAttributes ModuleAttributes [get, set]
 
Part part [get, set]
 
uint PersistentActionsId [get, set]
 A unique identifier for each vessel including from when it was Shipconstruct More...
 
uint PersistentId [get]
 A unique identifier for each vessel including from when it was Shipconstruct More...
 
Vessel vessel [get]
 

Additional Inherited Members

- Public Types inherited from PartModule
enum  PartUpgradeState { PartUpgradeState.NONE, PartUpgradeState.LOCKED, PartUpgradeState.AVAILABLE }
 
enum  StartState {
  StartState.None = 0, StartState.Editor = 1, StartState.PreLaunch = 2, StartState.Landed = 4,
  StartState.Docked = 8, StartState.Flying = 16, StartState.Splashed = 32, StartState.SubOrbital = 64,
  StartState.Orbital = 128
}
 
- Static Public Attributes inherited from PartModule
static voidPMApplyNodeDelegate ApplyUpgradeNodeDel
 
static boolPMApplyUpgrades ApplyUpgradesDel
 
static bool ApplyUpgradesEditorAuto = true
 
static boolPMBoolDelegate FindUpgradesDel
 
static voidPMNodeDelegate LoadExpansionNodes
 Hook for loading extra nodes common to all part modules. More...
 
static voidPMNodeDelegate LoadUpgradesDel
 
static voidPMNodeDelegate SaveExpansionNodes
 Hook for saving extra nodes common to all part modules. More...
 
static voidPMDelegate SetupExpansion
 Hook for performing extra setup common to all part modules. More...
 
static string UpgradesAvailableString = "#autoLOC_6002273"
 
static string UpgradesLockedString = "#autoLOC_6002274"
 
- Static Protected Attributes inherited from PartModule
static Dictionary< string,
ConfigNode
exclusives = new Dictionary<string, ConfigNode>()
 
static Dictionary< Type,
ReflectedAttributes
reflectedAttributeCache = new Dictionary<Type, ReflectedAttributes>()
 

Detailed Description

Perform an Action on a Part to drain a resource from it over time.

Member Function Documentation

static void ModuleResourceDrain.CacheLocalStrings ( )
inlinestatic
virtual bool ModuleResourceDrain.CanBeDetached ( )
inlinevirtual

Returns true if not draining

Returns

Implements IConstruction.

virtual bool ModuleResourceDrain.CanBeOffset ( )
inlinevirtual

Returns true if not draining

Returns

Implements IConstruction.

virtual bool ModuleResourceDrain.CanBeRotated ( )
inlinevirtual

Returns true if not draining

Returns

Implements IConstruction.

virtual void ModuleResourceDrain.DrainPart ( )
inlinevirtual

This will drain the Part or ProtoPartSnapShot every frame (fixed frame rate, within the physiscs system) until we have drained all that is required or we run out of the resource.

void ModuleResourceDrain.ForceUpdateResourcePAW ( string  resourceName,
bool  status 
)
inline

Refresh the resources list status in the PAW

bool ModuleResourceDrain.IsResourceDraining ( PartResource  pR)
inline

Check if a resource is being marked for draining.

Parameters
pR
Returns
override void ModuleResourceDrain.OnAwake ( )
inlinevirtual

Method fires once the module has been added to the part. Use for first time setup. Module will not have loaded fully by this point

Reimplemented from PartModule.

override void ModuleResourceDrain.OnLoad ( ConfigNode  node)
inlinevirtual

Use OnLoad to load any additional data from the ConfigNode provided

Parameters
node

Reimplemented from PartModule.

void ModuleResourceDrain.OnPartMenuOpen ( UIPartActionWindow  window,
Part  inpPart 
)
inlineprotected
override void ModuleResourceDrain.OnSave ( ConfigNode  node)
inlinevirtual

Use OnSave to serialize additional module information into the ConfigNode provided

Parameters
node

Reimplemented from PartModule.

override void ModuleResourceDrain.OnStart ( StartState  state)
inlinevirtual

Called when the part starts. The StartState gives an indication of where in flight you are. All values may not be plugged in!

Parameters
state

Reimplemented from PartModule.

override void ModuleResourceDrain.OnStartFinished ( StartState  state)
inlinevirtual

Called when the part finishes starting. The StartState gives an indication of where in flight you are. All values may not be plugged in!

Parameters
state

Reimplemented from PartModule.

void ModuleResourceDrain.StartResourceDrainAction ( KSPActionParam  param)
inline

Starts draining the assigned resource until stopped or depleted.

Parameters
param
void ModuleResourceDrain.StopResourceDrainAction ( KSPActionParam  param)
inline

Stops draining the assigned resource.

Parameters
param
void ModuleResourceDrain.ToggleDrain ( )
inline

Start or stops draining resources.

void ModuleResourceDrain.TogglePartResource ( PartResource  resource,
bool  status 
)
inline

Adds or removes a part resource depending on the status received.

Parameters
resourceNameResource name to add or remove.
void ModuleResourceDrain.ToggleResourceDrainAction ( KSPActionParam  param)
inline

Toggle draining the assigned resource.

Parameters
param
void ModuleResourceDrain.ToggleResourceDrainFlowAction ( KSPActionParam  param)
inline

Toggle draining mode for the single part of the vessel through the flow mode.

Parameters
param
void ModuleResourceDrain.TurnOffDrain ( )
inline

Stops draining resources.

void ModuleResourceDrain.TurnOffDrain ( List< string >  resourcesToStopDraining)
inline

Stops draining selected resources.

void ModuleResourceDrain.TurnOnDrain ( )
inline

Starts draining all the part's resources.

void ModuleResourceDrain.UpdateResourcesToRelease ( List< string >  resourceNames,
bool  exclude = false 
)
inline

Updates the list for the resources to release

Parameters
resourceNameslist of resources names to add or remove.
excludeThis will remove if true, and will add if false.

Member Data Documentation

List<FXGroup> ModuleResourceDrain.drainFXGroups = null
protected
float ModuleResourceDrain.drainRate = 10f

Rate Percentage in which a resource is drained over time.

bool ModuleResourceDrain.flowMode

Flow mode flag in order to switch between Part only and Vessel resource flow modes. true - use flowmode (whole vessel) false - parent part only - no flow.

FXGroup ModuleResourceDrain.highestPriorityFXGroup
protected
bool ModuleResourceDrain.isDraining
protected
float ModuleResourceDrain.maxDrainRate = 20f

Maximum Resource Drain rate per Second

float ModuleResourceDrain.minDrainRate = 1f

Minimum Resource Drain rate per Second

string ModuleResourceDrain.noResourceAvailable = string.Empty

Display text for when there are no available resources to drain.

string ModuleResourceDrain.resourceName

The resources from this part to drain, set on the part's Config File.

List<PartResource> ModuleResourceDrain.resourcesAvailable = null

Available resources to release.

int ModuleResourceDrain.resourcesDraining

This is the number of resources being drained.

Property Documentation

bool ModuleResourceDrain.IsDraining
getset

Check if the part is currently draining it's own resource or resources.

bool ModuleResourceDrain.IsInactive
get

Check if this module is active.


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