Inheritance diagram for ModuleDecouplerBase:

Public Member Functions

bool ClosedAndLocked ()

void Decouple ()

void DecoupleAction (KSPActionParam param)

Callback< Rect > GetDrawModulePanelCallback ()

Return a method delegate to draw a custom panel, or null if not necessary. More...

string GetModuleTitle ()

Return a string title for your module. More...

Part GetPart ()

string GetPrimaryField ()

Return a string to be displayed in the main information box on the tooltip, or null if nothing is that important to be up there. More...

int GetStageIndex (int fallback)

override string GetStagingDisableText ()

override string GetStagingEnableText ()

Vessel GetVessel ()

bool IsEnginePlate ()

Returns True if this Separator is an Engine Plate More...

override 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...

override void OnActive ()

Called when the part is set active (after unpacking etc) 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...

virtual void OnDecouple ()

override void OnModuleAdjusterRemoved (AdjusterPartModuleBase adjuster)

Perform processing specific to this part module when an adjuster is removed. More...

override void OnStart (PartModule.StartState state)

bool PartDetaches (out List< Part > decoupledParts)

Returns True or False to indicate if the whole Part Detaches when it is staged or not. eg: A decoupler returns true. But a Engine Plate returns false as only the child attached to the bottom of it is detached, not any engines attached to it. Must also set decoupledChild which would be the child part that IS detached. Or Null if there isn't one. More...

override bool StagingEnabled ()

Gets current staging status (is staging enabled for this module) Override me! More...

override bool StagingToggleEnabledEditor ()

override bool StagingToggleEnabledFlight ()

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 GetUpgradeInfo ()

Called by Upgrade Stats dialog More...

bool HasUpgrades ()

Returns true if upgrades exist for the partmodule 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 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...

virtual void OnLoad (ConfigNode node)

Use OnLoad to load any additional data from the ConfigNode provided 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 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 OnSave (ConfigNode node)

Use OnSave to serialize additional module information into the ConfigNode provided More...

virtual 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...

virtual void OnStartBeforePartAttachJoint (StartState state)

Called in flight scene in Part.Start just before the Part attachnode joints are created. More...

virtual 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...

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

rotation	The current calculated rotation. Will be updated if method returns true.
selPartNode	The attachnode.
partParent	The 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...

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)

Public Member Functions inherited from IModuleInfo

string GetInfo ()

return a simple string for the module info. Supports rich-text syntax. More...

Public Attributes
float	ejectionForce = 10f

float	ejectionForcePercent = 100f

string	explosiveNodeID = "top"

string	fxGroupName = "decouple"

bool	isDecoupled = false

bool	isEnginePlate = false

bool	isOmniDecoupler = false

bool	partDecoupled = true

bool	staged = true

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< ConfigNode >	upgrades

List< string >	upgradesApplied = new List<string>()

bool	upgradesApply = true

bool	upgradesAsk = true

Protected Member Functions
bool	IsAdjusterBlockingDecouple ()
	Is there an adjuster attached to this module that will prevent the decouple action More...

override void	OnModuleAdjusterAdded (AdjusterPartModuleBase adjuster)
	Perform processing specific to this part module when an adjuster is added. More...

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	SaveUpgradesApplied (ConfigNode node)
	Save the applied upgrades. More...

IEnumerator	UpgradeWaitForScenarioModules ()

Protected Attributes
AttachNode	explosiveNode

FXGroup	fx

ModuleJettison	jettisonModule

bool	refreshStaging = false

bool	shroudOn

Properties
AttachNode	ExplosiveNode `[get, set]`

Properties inherited from PartModule
BaseActionList	Actions `[get]`

int	ClassID `[get]`

string	ClassName `[get]`

List< AdjusterPartModuleBase >	CurrentModuleAdjusterList `[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 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...

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>()

Member Function Documentation

bool ModuleDecouplerBase.ClosedAndLocked ( )

inline

Implements IAirstreamShield.

void ModuleDecouplerBase.Decouple ( )

inline

void ModuleDecouplerBase.DecoupleAction ( KSPActionParam param )

inline

Callback<Rect> ModuleDecouplerBase.GetDrawModulePanelCallback ( )

inline

Return a method delegate to draw a custom panel, or null if not necessary.

Parameters

rect

Implements IModuleInfo.

string ModuleDecouplerBase.GetModuleTitle ( )

inline

Return a string title for your module.

Returns

Implements IModuleInfo.

Part ModuleDecouplerBase.GetPart ( )

inline

Implements IAirstreamShield.

string ModuleDecouplerBase.GetPrimaryField ( )

inline

Return a string to be displayed in the main information box on the tooltip, or null if nothing is that important to be up there.

Returns

Implements IModuleInfo.

int ModuleDecouplerBase.GetStageIndex ( int fallback )

inline

Implements IStageSeparator.

override string ModuleDecouplerBase.GetStagingDisableText ( )

inlinevirtual

Reimplemented from PartModule.

override string ModuleDecouplerBase.GetStagingEnableText ( )

inlinevirtual

Reimplemented from PartModule.

Vessel ModuleDecouplerBase.GetVessel ( )

inline

Implements IAirstreamShield.

bool ModuleDecouplerBase.IsAdjusterBlockingDecouple ( )

inlineprotected

Is there an adjuster attached to this module that will prevent the decouple action

Returns

bool ModuleDecouplerBase.IsEnginePlate ( )

inline

Returns True if this Separator is an Engine Plate

Returns

Implements IStageSeparatorChild.

override bool ModuleDecouplerBase.IsStageable ( )

inlinevirtual

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()

Reimplemented from PartModule.

override void ModuleDecouplerBase.OnActive ( )

inlinevirtual

Called when the part is set active (after unpacking etc)

Reimplemented from PartModule.

override void ModuleDecouplerBase.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.

virtual void ModuleDecouplerBase.OnDecouple ( )

inlinevirtual

Reimplemented in ModuleDecouple, and ModuleAnchoredDecoupler.

override void ModuleDecouplerBase.OnModuleAdjusterAdded ( AdjusterPartModuleBase adjuster )

inlineprotectedvirtual

Perform processing specific to this part module when an adjuster is added.

Parameters

adjuster Adjuster which will be applied to part module.

Reimplemented from PartModule.

override void ModuleDecouplerBase.OnModuleAdjusterRemoved ( AdjusterPartModuleBase adjuster )

inlinevirtual

Perform processing specific to this part module when an adjuster is removed.

Parameters

adjuster Adjuster which is being removed from part module.

Reimplemented from PartModule.

override void ModuleDecouplerBase.OnStart ( PartModule.StartState state )

inline

bool ModuleDecouplerBase.PartDetaches ( out List< Part > decoupledChildParts )

inline

Returns True or False to indicate if the whole Part Detaches when it is staged or not. eg: A decoupler returns true. But a Engine Plate returns false as only the child attached to the bottom of it is detached, not any engines attached to it. Must also set decoupledChild which would be the child part that IS detached. Or Null if there isn't one.

Parameters

decoupledChildParts Set to the Child Parts that will be detached or Null. Is ONLY required if the method returns false.

Returns

Implements IStageSeparatorChild.

override bool ModuleDecouplerBase.StagingEnabled ( )

inlinevirtual

Gets current staging status (is staging enabled for this module) Override me!

Returns: True iff staging enabled for this module

Reimplemented from PartModule.

override bool ModuleDecouplerBase.StagingToggleEnabledEditor ( )

inlinevirtual

Reimplemented from PartModule.

override bool ModuleDecouplerBase.StagingToggleEnabledFlight ( )

inlinevirtual

Reimplemented from PartModule.

Member Data Documentation

float ModuleDecouplerBase.ejectionForce = 10f

float ModuleDecouplerBase.ejectionForcePercent = 100f

AttachNode ModuleDecouplerBase.explosiveNode

protected

string ModuleDecouplerBase.explosiveNodeID = "top"

FXGroup ModuleDecouplerBase.fx

protected

string ModuleDecouplerBase.fxGroupName = "decouple"

bool ModuleDecouplerBase.isDecoupled = false

bool ModuleDecouplerBase.isEnginePlate = false

bool ModuleDecouplerBase.isOmniDecoupler = false

ModuleJettison ModuleDecouplerBase.jettisonModule

protected

bool ModuleDecouplerBase.partDecoupled = true

bool ModuleDecouplerBase.refreshStaging = false

protected

bool ModuleDecouplerBase.shroudOn

protected

bool ModuleDecouplerBase.staged = true

Property Documentation

AttachNode ModuleDecouplerBase.ExplosiveNode

getset

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

KSP/Assets/Scripts/Part Scripts/PartModules/Structural/ModuleDecouplerBase.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Member Function Documentation

Member Data Documentation

Property Documentation