ILinkSource Interface

A generic source of a KAS link between two parts.

Namespace: KASAPIv2
Assembly: KAS-API-v2 (in KAS-API-v2.dll) Version: KAS API v2

Syntax

public interface ILinkSource : ILinkPeer

Request Example View Source

The ILinkSource type exposes the following members.

Properties

	Name	Description
	linkJoint	Joint module that manages a physical link.
	linkRenderer	Renderer of the link meshes.
	linkTarget	Target of the link.

Top

Methods

	Name	Description
	BreakCurrentLink	Breaks the link between the source and the target.
	CancelLinking	Cancels the linking mode without creating a link.
	CheckCanLinkTo	Verifies if a link between the parts can be successful.
	LinkToTarget(ILinkTarget)	Establishes a link between two parts.
	LinkToTarget(LinkActorType, ILinkTarget)	Establishes a link between two parts.
	StartLinking	Starts the linking mode of this source.

Top

Remarks

Source is the initiator of the link to the another part. It holds all the logic on making and maintaining the actual connection between the two parts. The other end of the connection must be ILinkTarget which implements its own piece of the logic.

The link source have a state that defines what it can do (linkState). Not all actions are allowed in any state. The following state diagram tells what the source can do and when:

Transition	Action
Available => Linking	This module has initiated a link via the StartLinking(GUILinkMode, LinkActorType) method call.
Available => RejectingLinks	Some other source module in the world has initiated a link.
Linking => Available	This module has cancelled the linking mode via the CancelLinking method call.
Linking => Linked	This module has established a link.
RejectingLinks => Available	Some other module, which initiated a link, has cancelled or completed the linking mode.
RejectingLinks => Locked	Some other module on the same part, which initiated a link, has established a link. I.e. this part cannot have more links.
Linked => Available	This module has broke its link via the BreakCurrentLink(LinkActorType) method call.
Locked => Available	Some other module on the same part, which was linked, has broke its link via the BreakCurrentLink(LinkActorType) method call.

Examples

Copy

// Connects two parts assuming the source and the target parts own exactly one link module. 
public static bool ConnectParts(Part srcPart, Part tgtPart) {
  var source = srcPart.FindModuleImplementing<ILinkSource>();
  var target = tgtPart.FindModuleImplementing<ILinkTarget>();
  if (source == null || target == null || source.cfgLinkType != target.cfgLinkType) {
    Debug.LogError("Source and target cannot link");
    return false;
  }
  // GUILinkMode.API mode tells the implementation to not execute any user facing effects on the
  // link. See GUILinkMode for more details. 
  if (!source.StartLinking(GUILinkMode.API, LinkActorType.API) || !source.LinkToTarget(target)) {
    // Here we can only fail due to the constraints. E.g. the link mode is not supported, or the
    // joint module doesn't give the green light.
    Debug.LogError("Linking failed");
    source.CancelLinking();
    return false;
  }
  Debug.LogFormat("Established link with part: id={0}", source.linkPartId);
  return true;
}

Examples

Copy

// Disconnects the source part from its target. Only once source can be connected on the part.
// And it can be connected to the exactly one target.
public static void DisconnectParts(Part srcPart) {
  var source = srcPart.FindModulesImplementing<ILinkSource>()
      .FirstOrDefault(s => s.linkTarget != null);
  if (source == null) {
    Debug.LogWarningFormat("Part is not connected to anything");
    return;
  }
  // LinkActorType.API tells the implementation to not execute any user facing effects on the
  // link. See LinkActorType for more details.
  source.BreakCurrentLink(LinkActorType.API);
}

Examples

Copy

// Returns the linked part of the source, if any. It assumes there is exactly one source module
// on the source part.
public static Part FindTargetFromSource(Part srcPart) {
  var source = srcPart.FindModulesImplementing<ILinkSource>()
      .FirstOrDefault(s => s.linkTarget != null);
  if (source == null) {
    Debug.Log("Source is not connected");
    return null;
  }
  return source.linkTarget.part;
}

Examples

Copy

// Checks if the two parts are connected via a KAS link. 
public static bool CheckIfConnected(Part srcPart, Part tgtPart) {
  return srcPart.FindModulesImplementing<ILinkSource>()
      .Any(s => s.linkTarget != null && s.linkTarget.part == tgtPart);
}

Examples

Copy

// Sets up a sample state machine for the source states.
public static void SetupSourceStateModel() {
  var linkStateMachine = new SimpleStateMachine<LinkState>(true /* strict */);
  linkStateMachine.SetTransitionConstraint(
      LinkState.Available,
      new[] {LinkState.Linking, LinkState.RejectingLinks});
  linkStateMachine.SetTransitionConstraint(
      LinkState.Linking,
      new[] {LinkState.Available, LinkState.Linked});
  linkStateMachine.SetTransitionConstraint(
      LinkState.Linked,
      new[] {LinkState.Available});
  linkStateMachine.SetTransitionConstraint(
      LinkState.Locked,
      new[] {LinkState.Available});
  linkStateMachine.SetTransitionConstraint(
      LinkState.RejectingLinks,
      new[] {LinkState.Available, LinkState.Locked});

  linkStateMachine.AddStateHandlers(
      LinkState.Available,
      enterHandler: x => Debug.Log("Source is available"),
      leaveHandler: x => Debug.Log("Source is NOT available"));
}

Reference

KASAPIv2 Namespace