Control Parameters

The ID of the instrument icon.

It's possible to hide the instrument icon:

set_control_par($INST_ICON_ID, $CONTROL_PAR_HIDE, $HIDE_WHOLE_CONTROL) 

It's also possible to load a different picture file for the instrument icon:

set_control_par_str($INST_ICON_ID, $CONTROL_PAR_PICTURE, <file-name>) 

The ID of the instrument wallpaper. It is used in a similar way as $INST_ICON_ID:

set_control_par_str($INST_WALLPAPER_ID, $CONTROL_PAR_PICTURE, <file_name>) 

This command can only be used in on init callback. Note that a wallpaper set via the script replaces the one set in Instrument Options dialog, and it will not be checked in the Content Missing dialog when loading the wallpaper from the resource container.

This command only supports wallpapers that are located within the Resource Container.

If you use it in different script slots, then the last script slot in which wallpaper was set will be the one that is loaded.

Sets or returns the basepath of ui_file_selector. This control parameter can be used in any callback.

Be careful with the number of subfolders in the basepath, as it might take too long to scan the filesystem.

Sets or returns the width of ui_file_selector columns. This control par can only be used in on init callback.

Sets or returns the actual path (full path of the file) currently selected in ui_file_selector. The file path must be a subpath of the instrument’s basepath. This control parameter is useful for recalling the prior state of the file selector upon loading the instrument. Can only be used in on init callback.

Sets or returns the file type for ui_file_selector. Can only be used in on init callback.

The following file types are available:

$NI_FILE_TYPE_MIDI 

$NI_FILE_TYPE_AUDIO 

$NI_FILE_TYPE_ARRAY 

Sets or returns the drag and drop behavior for ui_label. Using a value of 1 sets the label as a drag and drop area, allowing the user to export the MIDI object currently held in memory by a simple drag and drop action. For more information on MIDI handling in KSP, refer to MIDI Object Commands. 

Assigns one of 512 available MIDI object export areas to be drag and drop exported via a particular ui_label. For more information on MIDI handling in KSP, refer to MIDI Object Commands. 

Sets or returns the background color of ui_level_meter.

Sets the second background color of ui_level_meter.

Sets the main level meter color of ui_level_meter.

Sets the color of ui_level_meter overload section.

Sets the color of the little bar showing the current peak level.

Aligns ui_level_meter vertically (1) or horizontally (0, default).

Sets the minimum and maximum display range of ui_level_meter, with default range 0 ... 1000000.

If the maximum value is smaller than the minimum value (or vice versa), the display is inverted.

Returns the number of menu entries in a specific ui_menu.

Only works with get_control_par().

Returns the index of the currently selected menu entry.

Only works with get_control_par().

Enables ui_mouse_area to accept audio, MIDI or NKA array files.

These can be set to one of the following values:

$NI_DND_ACCEPT_NONE 

$NI_DND_ACCEPT_ONE 

$NI_DND_ACCEPT_MULTIPLE 

A value from -5000 to 5000, setting the move direction of ui_slider and its sensitivity.

Settings are relative to the size of the slider picture.

Negative values give a vertical slider behavior, positive values give a horizontal behavior.

Returns the index of the ui_table column that triggered the on ui_control callback.

Sets or returns the color of the step bar in ui_table.

Colors are set using a hex value in the following format:

0ff0000h { red } 

The 0 at the start is just to let Kontakt know the value is a number. The h or H at the end is to indicate that it is a hexadecimal value.

Sets or returns the color of the middle line in ui_table.

Hides the arrows of ui_value_edit.

0: Arrows are hidden

1: Arrows are shown

Changes the way the waveform is drawn. Valid values:

$NI_WF_VIS_MODE_1 (Default)

$NI_WF_VIS_MODE_2 (X-ray)

$NI_WF_VIS_MODE_3 (X-ray filled)

Sets or returns the background color of ui_waveform.

Sets or returns the color of the waveform drawn in ui_waveform.

Sets or returns the color of the playback cursor in ui_waveform.

Sets or returns the color of the slice markers in ui_waveform.

Sets or returns the alpha channel (opacity) of the background of ui_waveform.

Range: 0 (fully transparent) to 255 (fully opaque).

Attaches a zone to ui_wavetable, taking the zone ID as the argument.

Sets or returns the X-axis parallax of ui_wavetable (only applicable to 3D mode).

Range: -1000000 ... 1000000

Sets or returns the Y-axis parallax of ui_wavetable (only applicable to 3D mode).

Range: -1000000 ... 1000000

Sets or returns the color of the background waveforms in 3D visualization mode of ui_wavetable.

Sets or returns the alpha channel (opacity) of the background waveforms in 3D visualization mode of ui_wavetable.

Range: 0 (fully transparent) to 255 (fully opaque).

Sets or returns the background color of ui_wavetable.

Sets or returns the alpha channel (opacity) of ui_wavetable.

Range: 0 (fully transparent) to 255 (fully opaque).

Mouse behavior, i.e. the drag scale, of the X axis of all ui_xy cursors.

Mouse behavior, i.e. the drag scale, of the Y axis of all ui_xy cursors.

Sets the way ui_xy responds to mouse clicks and drags.

0: Clicks anywhere other than on a cursor are ignored. Clicking on a cursor and dragging, sets new values respecting the usual $CONTROL_PAR_MOUSE_BEHAVIOUR settings.

1: Clicks anywhere on the XY pad are registered but don't change the values. Clicking anywhere and dragging, sets new values; the cursor moves parallel to the mouse cursor with distances scaled based on the $CONTROL_PAR_MOUSE_BEHAVIOUR settings.

2: Clicks anywhere on the XY pad are registered and immediately change the values, with the cursor immediately matching the mouse cursor. Clicking anywhere and dragging has a similar effect; the $CONTROL_PAR_MOUSE_BEHAVIOUR settings are ignored; cursor always follows mouse cursor one-to-one.

Sets and gets the index of the active ui_xy cursor. Only relevant in multi-cursor setups. The $CONTROL_PAR_MOUSE_MODE setting will influence how this parameter behaves:

0 and 1: The active cursor can only be changed manually by setting this control parameter. Inactive cursors don't receive any clicks.

2: Active cursor is set automatically based on the last clicked cursor. Setting it manually within on ui_control callback of ui_xy can result in unexpected results, but using it in other callbacks is fully encouraged and makes sense in many scenarios. The returned value is -1 when not clicking on any cursor.

The index can only ever be an even number (with the exception of the -1 value) that matches the index of the X axis of the cursor in the main array representing the XY control, e.g. the first cursor has an index of 0, the second one has an index of 2, etc.

Sets the cursor image. Each cursor can have its own image set using the set_control_par_str_arr() command.

Using $CONTROL_PAR_PICTURE on ui_xy UI ID itself will set the background image of the control.

The cursor images can have up to 6 frames, corresponding to the following states. Frame selection is automatic, exactly like with ui_button and ui_switch.

1: Inactive

2: Active

3: Inactive pressed

4: Active pressed

5: Inactive mouse over

6: Active mouse over

When used with set_control_par_arr(), this can be used to hide specific ui_xy cursors. Below is a simple example:

if ($hide = 1)
    set_control_par_arr($id, $CONTROL_PAR_HIDE, $HIDE_PART_CURSOR, $index)
else
    set_control_par_arr($id, $CONTROL_PAR_HIDE, $HIDE_PART_NOTHING, $index)
end if

The index should be an even number that matches the index of the X axis of the cursor in the main array representing the XY control, so the first cursor has an index of 0, the second has an index of 2, and so on.

Returns the index of the cursor that triggered the on ui_control callback of a ui_xy widget. Note that indices are always even numbers starting from 0, so the first cursor has an index of 0, the second has an index of 2, and so on.