Click or drag to resize

ILinkJointSetCoupleOnLinkMode Method

Changes the current parts couple mode.

Namespace:  KASAPIv2
Assembly:  KAS-API-v2 (in KAS-API-v2.dll) Version: KAS API v2
Syntax
C#
Copy
bool SetCoupleOnLinkMode(
	bool isCoupleOnLink
)
Request Example View Source

Parameters

isCoupleOnLink
Type: SystemBoolean
The new settings of the mode.

Return Value

Type: Boolean
true if the new mode has been accepted. The change may be refused for any reason by the implementation, and the caller must react accordingly.
Remarks

When both the source and the target peers support coupling, this mode can be arbitrary set or reset via the joint module. If the new mode is "coupling", and the source and the target vessels are different, then a coupling action will trigger. If the new mode is "don't couple", and the source and the target parts are coupled, then a decoupling event is triggered. In all the other cases it's just a boolean property change.

The modules must support the cycles and be ready to pick up the coupling role when the former part has gave up.

See Also