Inheritance diagram for ModuleGrappleNode:

Public Member Functions

bool CheckContractObjectiveValidity ()

Whether this particular module is valid for this objective. For example, leg wheels versus rover wheels. More...

void Decouple ()

void DecoupleAction (KSPActionParam param)

string GetContractObjectiveType ()

Gets the string identifier for this contract type. Stock contracts use ContractDefs constants, but could be used for non-stock contracts. More...

Part GetHostPart ()

Return an instance of the part. More...

override string GetInfo ()

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

Transform GetLocalTransform ()

Return an instance of the module's transform. More...

override string GetModuleDisplayName ()

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

bool IsJointUnlocked ()

Return the part joint state More...

bool IsLoose ()

void LockPivot ()

void MakeReferenceToggle (KSPActionParam act)

void MakeReferenceTransform ()

bool NodeIsTooFar ()

void OnDriveModeChanged (ActiveJoint.DriveMode mode)

Called when the drive mode of the joint changes. Use to keep track of the drive mode in case it changes for external reasons (like joint being destroyed, or vessel going on rails which sets the drive on Park) More...

void OnJointInit (ActiveJoint joint)

Called whenever the activeJoint's joint is modified. Will be called when the joint is first started, when the joint is destroyed, and again if a new one is re-created. Use to toggle joint-dependent behaviour on the module. More...

override void OnLoad (ConfigNode node)

Use OnLoad to load any additional data from the ConfigNode provided More...

override void OnModuleAdjusterRemoved (AdjusterPartModuleBase adjuster)

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

void OnOtherNodeSameVesselDisconnect ()

override void OnSave (ConfigNode node)

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

override void OnStart (PartModule.StartState st)

bool OtherPartIsLost ()

void Release ()

void ReleaseAction (KSPActionParam param)

void ReleaseSameVessel ()

void RemoveAdjusterBlockingGrappleNodeAbilityToRelease ()

Removes an adjuster blocking the grapple node ability to release. More...

void SetLoose ()

void SetUpAdjusterBlockingGrappleNodeAbilityToRelease ()

Sets up an adjuster blocking the grapple node ability 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...

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

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
float	captureMaxRvel = 0.3f

float	captureMinFwdDot = 0.998f

float	captureRange = 0.06f

Transform	controlTransform

string	controlTransformName = ""

int	deployAnimationController = -1

float	deployAnimationTarget = 1f

uint	dockedPartUId

float	minDistanceToReEngage = 1f

Transform	nodeTransform

string	nodeTransformName = "grappleNode"

DockedVesselInfo	otherVesselInfo

float	pivotRange = 30f

string	state = "Ready"

float	undockEjectionForce = 5f

DockedVesselInfo	vesselInfo

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
int	CountAdjustersBlockingGrappleRelease ()
	Counts how many adjusters are attached to this partmodule and prevent release More...

bool	IsAdjusterBlockingGrappleGrab ()
	Is there an adjuster attached to this module that will prevent the grapple 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 ()

Properties
bool	IsDisabled `[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]`

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 ModuleGrappleNode.CheckContractObjectiveValidity ( )

inline

Whether this particular module is valid for this objective. For example, leg wheels versus rover wheels.

Returns: If the module is valid.

Implements IContractObjectiveModule.

int ModuleGrappleNode.CountAdjustersBlockingGrappleRelease ( )

inlineprotected

Counts how many adjusters are attached to this partmodule and prevent release

Returns

void ModuleGrappleNode.Decouple ( )

inline

void ModuleGrappleNode.DecoupleAction ( KSPActionParam param )

inline

string ModuleGrappleNode.GetContractObjectiveType ( )

inline

Gets the string identifier for this contract type. Stock contracts use ContractDefs constants, but could be used for non-stock contracts.

Returns: A string identifier for this type of objective.

Implements IContractObjectiveModule.

Part ModuleGrappleNode.GetHostPart ( )

inline

Return an instance of the part.

Returns

Implements IActiveJointHost.

override string ModuleGrappleNode.GetInfo ( )

inlinevirtual

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

Returns

Reimplemented from PartModule.

Transform ModuleGrappleNode.GetLocalTransform ( )

inline

Return an instance of the module's transform.

Returns

Implements IActiveJointHost.

override string ModuleGrappleNode.GetModuleDisplayName ( )

inlinevirtual

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

Returns

Reimplemented from PartModule.

bool ModuleGrappleNode.IsAdjusterBlockingGrappleGrab ( )

inlineprotected

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

Returns

bool ModuleGrappleNode.IsJointUnlocked ( )

inline

Return the part joint state

Returns

Implements IJointLockState.

bool ModuleGrappleNode.IsLoose ( )

inline

void ModuleGrappleNode.LockPivot ( )

inline

void ModuleGrappleNode.MakeReferenceToggle ( KSPActionParam act )

inline

void ModuleGrappleNode.MakeReferenceTransform ( )

inline

bool ModuleGrappleNode.NodeIsTooFar ( )

inline

void ModuleGrappleNode.OnDriveModeChanged ( ActiveJoint.DriveMode mode )

inline

Called when the drive mode of the joint changes. Use to keep track of the drive mode in case it changes for external reasons (like joint being destroyed, or vessel going on rails which sets the drive on Park)

Parameters

mode

Implements IActiveJointHost.

void ModuleGrappleNode.OnJointInit ( ActiveJoint joint )

inline

Called whenever the activeJoint's joint is modified. Will be called when the joint is first started, when the joint is destroyed, and again if a new one is re-created. Use to toggle joint-dependent behaviour on the module.

Parameters

joint a reference to the joint created, or null if the joint is lost

Implements IActiveJointHost.

override void ModuleGrappleNode.OnLoad ( ConfigNode node )

inlinevirtual

Use OnLoad to load any additional data from the ConfigNode provided

Parameters

node

Reimplemented from PartModule.

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

void ModuleGrappleNode.OnOtherNodeSameVesselDisconnect ( )

inline

override void ModuleGrappleNode.OnSave ( ConfigNode node )

inlinevirtual

Use OnSave to serialize additional module information into the ConfigNode provided

Parameters

node

Reimplemented from PartModule.

override void ModuleGrappleNode.OnStart ( PartModule.StartState st )

inline

bool ModuleGrappleNode.OtherPartIsLost ( )

inline

void ModuleGrappleNode.Release ( )

inline

< switch focus to the undocked craft if we were focused on the previous vessel

void ModuleGrappleNode.ReleaseAction ( KSPActionParam param )

inline

void ModuleGrappleNode.ReleaseSameVessel ( )

inline

void ModuleGrappleNode.RemoveAdjusterBlockingGrappleNodeAbilityToRelease ( )

inline

Removes an adjuster blocking the grapple node ability to release.

void ModuleGrappleNode.SetLoose ( )

inline

void ModuleGrappleNode.SetUpAdjusterBlockingGrappleNodeAbilityToRelease ( )

inline

Sets up an adjuster blocking the grapple node ability to release.

Member Data Documentation

float ModuleGrappleNode.captureMaxRvel = 0.3f

float ModuleGrappleNode.captureMinFwdDot = 0.998f

float ModuleGrappleNode.captureRange = 0.06f

Transform ModuleGrappleNode.controlTransform

string ModuleGrappleNode.controlTransformName = ""

int ModuleGrappleNode.deployAnimationController = -1

float ModuleGrappleNode.deployAnimationTarget = 1f

uint ModuleGrappleNode.dockedPartUId

float ModuleGrappleNode.minDistanceToReEngage = 1f

Transform ModuleGrappleNode.nodeTransform

string ModuleGrappleNode.nodeTransformName = "grappleNode"

DockedVesselInfo ModuleGrappleNode.otherVesselInfo

float ModuleGrappleNode.pivotRange = 30f

string ModuleGrappleNode.state = "Ready"

float ModuleGrappleNode.undockEjectionForce = 5f

DockedVesselInfo ModuleGrappleNode.vesselInfo

Property Documentation

bool ModuleGrappleNode.IsDisabled

get

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Additional Inherited Members

Member Function Documentation

Member Data Documentation

Property Documentation