Click or drag to resize

LinkActorType Enumeration

Defines an actor that changes KAS link.

Namespace:  KASAPIv2
Assembly:  KAS-API-v2 (in KAS-API-v2.dll) Version: KAS API v2
Syntax
C#
Copy
public enum LinkActorType
Request Example View Source
Members
  Member nameValueDescription
None0Actor is unspecified.
API1Third-party code has affected the link during its normal workflow.
Physics2Link has changed as a result of physics effect.
Player3Player input has affected the link state.
Remarks
The implementations of ILinkSource and ILinkTarget may check the type to determine how the action needs to be presented to the player. The type API must never be presented to the player, it's used by the internal logic to manage the sate of the links. For all the other types it's up to the implementation how to present it.
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);
}
See Also