--- doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html 2016/07/15 15:33:43 2949
+++ doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html 2017/05/20 13:37:20 3194
@@ -36,6 +36,10 @@
| Increments the passed integer variable by one. |
+ in_range() |
+ Checks whether a value is between two other values. |
+
+
message() |
Prints text to the sampler's terminal. |
@@ -60,9 +64,25 @@
Random number generator. |
+ min() |
+ Calculates the minimum value of two given values. |
+
+
+ max() |
+ Calculates the maximum value of two given values. |
+
+
num_elements() |
Returns the size of the requested array variable. |
+
+ sh_left() |
+ Calculates a left bit shifted value. |
+
+
+ sh_right() |
+ Calculates a right bit shifted value. |
+
Common Sampler Functions
@@ -87,10 +107,18 @@
Changes the tuning of voices. |
+ change_tune_time() |
+ Changes the duration of tuning changes. |
+
+
change_vol() |
Changes the volume of voices. |
+ change_vol_time() |
+ Changes the duration of volume changes. |
+
+
change_cutoff() |
Changes filter cutoff frequency of voices. |
@@ -99,10 +127,54 @@
Changes filter resonance of voices. |
+ change_attack() |
+ Modifies the attack time of voices. |
+
+
+ change_decay() |
+ Modifies the decay time of voices. |
+
+
+ change_release() |
+ Modifies the release time of voices. |
+
+
+ change_amp_lfo_depth() |
+ Modifies the amplitude LFO depth. |
+
+
+ change_amp_lfo_freq() |
+ Modifies the amplitude LFO frequency. |
+
+
+ change_pitch_lfo_depth() |
+ Modifies the pitch LFO depth. |
+
+
+ change_pitch_lfo_freq() |
+ Modifies the pitch LFO frequency. |
+
+
event_status() |
Checks and returns whether a particular note is still alive. |
+ fade_in() |
+ Fade the requested note in. |
+
+
+ fade_out() |
+ Fade the requested note out. |
+
+
+ get_event_par() |
+ Get the current value of a specific note parameter. |
+
+
+ set_event_par() |
+ Change the value of a specific note parameter. |
+
+
set_controller() |
Creates a MIDI control change event. |
@@ -287,6 +359,22 @@
Variable | Description |
+ %ALL_EVENTS |
+
+ Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
+ This may be passed to many built-in functions like note_off().
+ This array variable only contains IDs of notes which were launched due
+ to MIDI note-on events. This variable does not contain IDs of child notes
+ (i.e. notes which were launched programmatically by calling play_note()).
+
+ In contrast to KSP this variable is an integer array type, whereas KSP's
+ pendent of this built-in variable is an integer constant (scalar) called
+ $ALL_EVENTS. Using the latter with NKSP will cause a
+ parser warning, the behavior will be the same though.
+
+ |
+
+
$CC_NUM |
MIDI controller number that caused the controller
handler to be executed (only useful in the context of a
@@ -332,6 +420,37 @@
note is still "alive". |
+ $EVENT_PAR_NOTE |
+ Constant value symbolizing the "note number" parameter. See
+ get_event_par() and set_event_par()
+ for details. |
+
+
+ $EVENT_PAR_TUNE |
+ Constant value symbolizing the "tune" parameter. See
+ get_event_par() and set_event_par()
+ for details. |
+
+
+ $EVENT_PAR_VELOCITY |
+ Constant value symbolizing the "note velocity" parameter. See
+ get_event_par() and set_event_par()
+ for details. |
+
+
+ $EVENT_PAR_VOLUME |
+ Constant value symbolizing the "volume" parameter. See
+ get_event_par() and set_event_par()
+ for details. |
+
+
+ $EVENT_PAR_0 to $EVENT_PAR_3 |
+ Four constant values symbolizing the 4 possible user specific
+ parameters, which i.e. might be used to pass data from one script
+ (slot) to another script (slot). See get_event_par()
+ and set_event_par() for details. |
+
+
%KEY_DOWN[] |
This can be used in any context to check whether a certain MIDI
key is currently pressed down. Use the respective MIDI note number
|