Click or drag to resize

ILinkUtilsCoupleParts Method

Couples two parts together given they belong to the different vessels.

Namespace:  KASAPIv2
Assembly:  KAS-API-v2 (in KAS-API-v2.dll) Version: KAS API v2
Syntax
C#
Copy
Part CoupleParts(
	AttachNode sourceNode,
	AttachNode targetNode,
	bool toDominantVessel = false
)
Request Example View Source

Parameters

sourceNode
Type: (Default Namespace)AttachNode
The attach node at the source part that defines the source vessel. It must not be null.
targetNode
Type: (Default Namespace)AttachNode
The attach node at the target part that defines the target vessel. It must not be null.
toDominantVessel (Optional)
Type: SystemBoolean
If false, then the source vessel will get coupled with the target. As a result, the source vessel will be destroyed. If true, then the method will find the least significant vessel of the two, and couple it with the most significant one. The least significant vessel will be destroyed.

Return Value

Type: Part
The part that attached as a child into the new hierarchy.
Remarks

Once the coupling is done, one of the vessels will be destroyed. It will become a part of the other vessel. The new merged vessel will become active. Which vessel will be destroyed is determined by the toDominantVessel parameter.

This coupling requires the both attach nodes to be provided, and creates a "stack" nodes coupling.

IMPORTANT. The attach nodes must have a valid owner set.

See Also