--- doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html 2017/06/27 23:29:31 3294 +++ doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html 2017/12/06 18:53:32 3396 @@ -11,6 +11,8 @@

This document gives you an overview of all built-in functions and built-in variables provided by the NKSP real-time instrument script language. + If you are new to NKSP, then you may want to read the + NKSP language tour first.

Built-In Functions

@@ -37,7 +39,11 @@ fork() - Creates new execution instances. + Creates new execution instances (threads). + + + callback_status() + Returns the current status of a callback (thread). dec() @@ -127,6 +133,14 @@ Changes panning of voices (stereo balance). + change_pan_time() + Changes the duration of panning (stereo balance) changes. + + + change_pan_curve() + Changes the curve type of panning (stereo balance) changes. + + change_play_pos() Change the sample playback position. @@ -164,17 +178,39 @@ change_attack() - Modifies the attack time of voices. + Modifies the amplitude attack time of voices. change_decay() - Modifies the decay time of voices. + Modifies the amplitude decay time of voices. + + + change_sustain() + Modifies the amplitude sustain level of voices. change_release() - Modifies the release time of voices. + Modifies the amplitude release time of voices. + + + + change_cutoff_attack() + Modifies the filter cutoff attack time of voices. + change_cutoff_decay() + Modifies the filter cutoff decay time of voices. + + + change_cutoff_sustain() + Modifies the filter cutoff sustain level of voices. + + + change_cutoff_release() + Modifies the filter cutoff release time of voices. + + + change_amp_lfo_depth() Modifies the amplitude LFO depth. @@ -182,6 +218,16 @@ change_amp_lfo_freq() Modifies the amplitude LFO frequency. + + + change_cutoff_lfo_depth() + Modifies the filter cutoff LFO depth. + + + change_cutoff_lfo_freq() + Modifies the filter cutoff LFO frequency. + + change_pitch_lfo_depth() Modifies the pitch LFO depth. @@ -279,6 +325,22 @@ Variable Description + $CALLBACK_STATUS_QUEUE + Built-in constant reflecting the status of a callback to be + alive but suspended. See callback_status() for details. + + + $CALLBACK_STATUS_RUNNING + Built-in constant reflecting the status of a callback to be + alive and currently executing. See callback_status() + for details. + + + $CALLBACK_STATUS_TERMINATED + Built-in constant reflecting the status of a callback to be + not alive. See callback_status() for details. + + $KSP_TIMER Preserved for compatiblity reasons with KSP, returns the same value as $NKSP_REAL_TIMER (refer to the latter for details). @@ -326,7 +388,7 @@ %NKSP_CALLBACK_CHILD_ID[] Reflects the callback IDs of all child threads which the current - script callback instance spawned by calling function fork(). + script callback instance spawned by having called fork() before. See the latter function for details about this array variable. @@ -335,8 +397,8 @@ If the current execution thread is a child thread spawned by a fork() call before, then this variable reflects the callback ID of the parent - thread which created this child thread. Otherwise this variable is zero. - See function fork() for more details about this variable. + thread which created this child thread. Otherwise this variable is 0. + See fork() for more details about this variable. @@ -707,6 +769,33 @@ Constant that identifies the general purpose 8 MIDI controller dimension. + +

Built-In Preprocessor Conditions

+

+ These are the built-in preprocessor conditions available with the NKSP realt-time + instrument script language. +

+

Core Language Preprocessor Conditions

+

+ Most fundamental NKSP built-in preprocessor conditions, independent from + any purpose of being used in a sampler. +

+ + + + + + + + +
Condition Description
NKSP_NO_MESSAGE + By default this condition is not set. By explicitly enabling this + condition with SET_CONDITION(NKSP_NO_MESSAGE) it + causes all subsequent message() calls to be ignored + and filtered out on preprocessor level. See function message() + for details. +
+