Skip to main content

KSPKnob

The KSPKnob class allows you to connect to a ui_knob in KSP.

class KSPKnob

Example​

import { KSPKnob } from kontakt

var knob = KSPKnob(id: "my_knob")

Constructor​

constructor(id: String)

Connects to a ui_knob in KSP with the given control ID.

Properties​

automate​

automate: Bool { get set }

Activate/Deactivate automation touch. Set this to true when interacting with a control to write automation. Set it back to false once the user interaction is finished.

connected​

connected: Bool { get }

Whether the control is connected. A control might not be connected if no corresponding control was found for the given id.

custom_id​

custom_id: Int { get }

The value of $CONTROL_PAR_CUSTOM_ID set on this control.

default_value​

default_value: Int { get }

The value of $CONTROL_PAR_DEFAULT_VALUE set on this control.

display_ratio​

display_ratio: Int { get }

The display ratio.

display_value​

display_value: Float { get }

The value scaled by the display-ratio.

id​

id: String { get }

The KSP control ID this knob is connected to.

label​

label: String { get }

The value of $CONTROL_PAR_LABEL set on this control.

max​

max: Int { get }

The maximum value.

min​

min: Int { get }

The minimum value.

normalized_value​

normalized_value: Float { get set }

The value normalized using min & max.

text (8.4)​

text: String { get }

The value of $CONTROL_PAR_TEXT set on this control.

value​

value: Int { get set }

The knob's value.