Click or drag to resize

IKasEvents Interface

Defines global events that are triggered by KAS.

Namespace:  KASAPIv2
Assembly:  KAS-API-v2 (in KAS-API-v2.dll) Version: KAS API v2
Syntax
C#
Copy
public interface IKasEvents
Request Example View Source

The IKasEvents type exposes the following members.

Properties
  NameDescription
Public propertyCode exampleOnLinkBroken
Triggers when a link between two parts has been broken.
Public propertyCode exampleOnLinkCreated
Triggers when a link between two parts has been successfully established.
Public propertyCode exampleOnStartLinking
Triggers when a source has initiated linking mode.
Public propertyCode exampleOnStopLinking
Triggers when a source has stopped linking mode.
Top
Remarks
Each collection is a list of callbacks that are called when the triggering event has happen. The subscribers should add themselves into the appropriate list to get notified. If subscriber object is being destroyed, then it must remove itself from the lists! Otherwise, the NRE will be thrown and the subscribers downstream will not get the notification.
Examples
Copy
public class KasEventsExample1: PartModule {
  public override void OnAwake() {
    base.OnAwake();
    KASAPI.KasEvents.OnStartLinking.Add(LinkStarted);
    KASAPI.KasEvents.OnStopLinking.Add(LinkStopped);
    KASAPI.KasEvents.OnLinkCreated.Add(LinkCreated);
    KASAPI.KasEvents.OnLinkBroken.Add(LinkBroken);
  }

  void OnDestroy() {
    KASAPI.KasEvents.OnStartLinking.Remove(LinkStarted);
    KASAPI.KasEvents.OnStopLinking.Remove(LinkStopped);
    KASAPI.KasEvents.OnLinkCreated.Remove(LinkCreated);
    KASAPI.KasEvents.OnLinkBroken.Remove(LinkBroken);
  }

  void LinkStarted(ILinkSource source) {
    DebugEx.Info("Link started by: {0}", source);
  }

  void LinkStopped(ILinkSource source) {
    DebugEx.Info("Link stopepd by: {0}", source);
  }

  void LinkCreated(IKasLinkEvent ev) {
    DebugEx.Info("Link created: {0} <=> {1}", ev.source, ev.target);
  }

  void LinkBroken(IKasLinkEvent ev) {
    DebugEx.Info("Link broken: {0} <=> {1}", ev.source, ev.target);
  }
}
See Also