Inheritance diagram for ModuleCommand:

Public Types
enum	ModuleControlState { ModuleControlState.NotEnoughCrew, ModuleControlState.NotEnoughResources, ModuleControlState.PartialManned, ModuleControlState.NoControlPoint, ModuleControlState.TouristCrew, ModuleControlState.PartialProbe, ModuleControlState.Nominal }

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 }

Public Member Functions

void ChangeControlPoint ()

Cycle to the next control point More...

bool ControlPointsExist ()

Test for if CPs exist More...

List< PartResourceDefinition > GetConsumedResources ()

ControlPoint GetControlPoint (string name)

Returns the control point with the supplied name More...

VesselControlState GetControlSourceState ()

Get the control state. More...

override string GetInfo ()

Returns formatted string of additional data for use in the VAB and SPH More...

override string GetModuleDisplayName ()

Override this to provide a Localized version of the PartModules Name for UI components More...

virtual void HibernateToggle (KSPActionParam param)

bool IsCommCapable ()

virtual void MakeReference ()

void MakeReferenceToggle (KSPActionParam act)

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

virtual void RenameVessel ()

void SetControlPoint (string newControlPointName="_default")

Sets the control point to one of the alternates More...

virtual void Start ()

void ToggleControlPointVisual ()

virtual void UpdateControlPointVisuals ()

virtual VesselControlState UpdateControlSourceState ()

Actually figure out what control state we have (and request any resources) Check connection state if commnet is on More...

void UpdateControlState ()

Update the control state. More...

virtual void UpdateNetwork ()

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

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

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)

Public Attributes
string	commNetFirstHopDistance = Localizer.Format("#autoLOC_217149")

string	commNetSignal = Localizer.Format("#autoLOC_217146")

DictionaryValueList< string, ControlPoint >	controlPoints

string	controlSrcStatusText = "NA"

float	cpArrowLength = 2.0f

ArrowPointer	cpforwardArrow = null

ArrowPointer	cpRightArrow = null

ArrowPointer	cpUpArrow = null

string	defaultControlPointDisplayName = Localizer.Format("#autoLOC_6011000")

bool	hasHibernation = false
	Is the module capable of switching to low-power mode More...

bool	hibernateOnWarp = false
	Do we automatically hibernate in warp More...

bool	hibernation = false
	Ingame toggle for hibernate mode More...

double	hibernationMultiplier = 0.01d
	Multiplier to all resource requests when hibernating More...

int	minimumCrew = 0
	The minimum crew/pilots (see requiresPilot above) More...

bool	remoteControl = true
	Can this module be remote-controlled, granting full control with a valid connection home/to a control point? More...

bool	requiresPilot = true
	Does this module require a pilot to fulfill crew requirements or is a simple crew member enough? More...

bool	requiresTelemetry = true
	Does this require telemetry, if comment is enabled? 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< ConfigNode >	upgrades

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

bool	upgradesApply = true

bool	upgradesAsk = true

Protected Member Functions
virtual void	FixedUpdate ()
	Update control state. Done in fixed update because it involves resource requests. Then pass on to the part's isControlSource field More...

virtual void	OnDestroy ()

virtual void	OnNetworkInitialised ()

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
bool	commCapable = true

int	crewCount

ModuleResource	lackingResource

VesselControlState	localVesselControlState = VesselControlState.None

ModuleControlState	moduleState

bool	networkInitialised = false

Properties
string	ActiveControlPointName `[get]`
	The name of the currently active CP More...

CommNetVessel	Connection `[get]`

bool	IsHibernating `[get]`

ModuleControlState	ModuleState `[get]`

bool	SignalRequired `[get]`
	i.e. is comment on and is requiresSignalForControl on More...

CommPath	VesselControlPath `[get]`

VesselControlState	VesselControlState `[get]`

SignalStrength	VesselSignal `[get]`

double	VesselSignalStrength `[get]`

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]`

Properties inherited from CommNet.ICommNetControlSource
string	name `[get]`

Additional Inherited Members
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 Enumeration Documentation

enum ModuleCommand.ModuleControlState

Enumerator
NotEnoughCrew
NotEnoughResources
PartialManned
NoControlPoint
TouristCrew
PartialProbe
Nominal

Member Function Documentation

void ModuleCommand.ChangeControlPoint ( )

inline

Cycle to the next control point

bool ModuleCommand.ControlPointsExist ( )

inline

Test for if CPs exist

Returns: True if there are any CPs in this module

virtual void ModuleCommand.FixedUpdate ( )

inlineprotectedvirtual

Update control state. Done in fixed update because it involves resource requests. Then pass on to the part's isControlSource field

List<PartResourceDefinition> ModuleCommand.GetConsumedResources ( )

inline

Implements IResourceConsumer.

ControlPoint ModuleCommand.GetControlPoint ( string name )

inline

Returns the control point with the supplied name

Parameters

name	name of control point

Returns: The control point or null if none is found with that name

VesselControlState ModuleCommand.GetControlSourceState ( )

inline

Get the control state.

Returns

Implements CommNet.ICommNetControlSource.

override string ModuleCommand.GetInfo ( )

inlinevirtual

Returns formatted string of additional data for use in the VAB and SPH

Returns

Reimplemented from PartModule.

override string ModuleCommand.GetModuleDisplayName ( )

inlinevirtual

Override this to provide a Localized version of the PartModules Name for UI components

Returns

Reimplemented from PartModule.

virtual void ModuleCommand.HibernateToggle ( KSPActionParam param )

inlinevirtual

bool ModuleCommand.IsCommCapable ( )

inline

Implements CommNet.ICommNetControlSource.

virtual void ModuleCommand.MakeReference ( )

inlinevirtual

void ModuleCommand.MakeReferenceToggle ( KSPActionParam act )

inline

override void ModuleCommand.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 ModuleCommand.OnDestroy ( )

inlineprotectedvirtual

override void ModuleCommand.OnLoad ( ConfigNode node )

inlinevirtual

Use OnLoad to load any additional data from the ConfigNode provided

Parameters

node

Reimplemented from PartModule.

virtual void ModuleCommand.OnNetworkInitialised ( )

inlineprotectedvirtual

override void ModuleCommand.OnSave ( ConfigNode node )

inlinevirtual

Use OnSave to serialize additional module information into the ConfigNode provided

Parameters

node

Reimplemented from PartModule.

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

virtual void ModuleCommand.RenameVessel ( )

inlinevirtual

void ModuleCommand.SetControlPoint ( string newControlPointName = "_default" )

inline

Sets the control point to one of the alternates

Parameters

newControlPointName name of the control point, or _default for the default one

virtual void ModuleCommand.Start ( )

inlinevirtual

void ModuleCommand.ToggleControlPointVisual ( )

inline

virtual void ModuleCommand.UpdateControlPointVisuals ( )

inlinevirtual

virtual VesselControlState ModuleCommand.UpdateControlSourceState ( )

inlinevirtual

Actually figure out what control state we have (and request any resources) Check connection state if commnet is on

Returns

void ModuleCommand.UpdateControlState ( )

inline

Update the control state.

virtual void ModuleCommand.UpdateNetwork ( )

inlinevirtual

Implements CommNet.ICommNetControlSource.

Member Data Documentation

bool ModuleCommand.commCapable = true

protected

string ModuleCommand.commNetFirstHopDistance = Localizer.Format("#autoLOC_217149")

string ModuleCommand.commNetSignal = Localizer.Format("#autoLOC_217146")

DictionaryValueList<string, ControlPoint> ModuleCommand.controlPoints

string ModuleCommand.controlSrcStatusText = "NA"

float ModuleCommand.cpArrowLength = 2.0f

ArrowPointer ModuleCommand.cpforwardArrow = null

ArrowPointer ModuleCommand.cpRightArrow = null

ArrowPointer ModuleCommand.cpUpArrow = null

int ModuleCommand.crewCount

protected

string ModuleCommand.defaultControlPointDisplayName = Localizer.Format("#autoLOC_6011000")

bool ModuleCommand.hasHibernation = false

Is the module capable of switching to low-power mode

bool ModuleCommand.hibernateOnWarp = false

Do we automatically hibernate in warp

bool ModuleCommand.hibernation = false

Ingame toggle for hibernate mode

double ModuleCommand.hibernationMultiplier = 0.01d

Multiplier to all resource requests when hibernating

ModuleResource ModuleCommand.lackingResource

protected

VesselControlState ModuleCommand.localVesselControlState = VesselControlState.None

protected

int ModuleCommand.minimumCrew = 0

The minimum crew/pilots (see requiresPilot above)

ModuleControlState ModuleCommand.moduleState

protected

bool ModuleCommand.networkInitialised = false

protected

bool ModuleCommand.remoteControl = true

Can this module be remote-controlled, granting full control with a valid connection home/to a control point?

bool ModuleCommand.requiresPilot = true

Does this module require a pilot to fulfill crew requirements or is a simple crew member enough?

bool ModuleCommand.requiresTelemetry = true

Does this require telemetry, if comment is enabled?

Property Documentation

string ModuleCommand.ActiveControlPointName

get

The name of the currently active CP

CommNetVessel ModuleCommand.Connection

getprotected

bool ModuleCommand.IsHibernating

get

ModuleControlState ModuleCommand.ModuleState

get

bool ModuleCommand.SignalRequired

get

i.e. is comment on and is requiresSignalForControl on

CommPath ModuleCommand.VesselControlPath

get

VesselControlState ModuleCommand.VesselControlState

get

SignalStrength ModuleCommand.VesselSignal

get

double ModuleCommand.VesselSignalStrength

get

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

KSP/Assets/Scripts/Part Scripts/PartModules/Control/ModuleCommand.cs

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation

Property Documentation