28 |
<th>Function</th> <th>Description</th> |
<th>Function</th> <th>Description</th> |
29 |
</tr> |
</tr> |
30 |
<tr> |
<tr> |
31 |
|
<td><code lang="nksp">dec()</code></td> |
32 |
|
<td>Decrements the passed integer variable by one.</td> |
33 |
|
</tr> |
34 |
|
<tr> |
35 |
|
<td><code>inc()</code></td> |
36 |
|
<td>Increments the passed integer variable by one.</td> |
37 |
|
</tr> |
38 |
|
<tr> |
39 |
|
<td><code>in_range()</code></td> |
40 |
|
<td>Checks whether a value is between two other values.</td> |
41 |
|
</tr> |
42 |
|
<tr> |
43 |
<td><code lang="nksp">message()</code></td> |
<td><code lang="nksp">message()</code></td> |
44 |
<td>Prints text to the sampler's terminal.</td> |
<td>Prints text to the sampler's terminal.</td> |
45 |
</tr> |
</tr> |
52 |
<td>Pauses execution for a certain amount of time.</td> |
<td>Pauses execution for a certain amount of time.</td> |
53 |
</tr> |
</tr> |
54 |
<tr> |
<tr> |
55 |
|
<td><code>stop_wait()</code></td> |
56 |
|
<td>Resumes execution of a suspended script callback.</td> |
57 |
|
</tr> |
58 |
|
<tr> |
59 |
<td><code>abs()</code></td> |
<td><code>abs()</code></td> |
60 |
<td>Calculates the absolute value of a given value.</td> |
<td>Calculates the absolute value of a given value.</td> |
61 |
</tr> |
</tr> |
64 |
<td>Random number generator.</td> |
<td>Random number generator.</td> |
65 |
</tr> |
</tr> |
66 |
<tr> |
<tr> |
67 |
|
<td><code>min()</code></td> |
68 |
|
<td>Calculates the minimum value of two given values.</td> |
69 |
|
</tr> |
70 |
|
<tr> |
71 |
|
<td><code>max()</code></td> |
72 |
|
<td>Calculates the maximum value of two given values.</td> |
73 |
|
</tr> |
74 |
|
<tr> |
75 |
<td><code>num_elements()</code></td> |
<td><code>num_elements()</code></td> |
76 |
<td>Returns the size of the requested array variable.</td> |
<td>Returns the size of the requested array variable.</td> |
77 |
</tr> |
</tr> |
78 |
|
<tr> |
79 |
|
<td><code>sh_left()</code></td> |
80 |
|
<td>Calculates a left bit shifted value.</td> |
81 |
|
</tr> |
82 |
|
<tr> |
83 |
|
<td><code>sh_right()</code></td> |
84 |
|
<td>Calculates a right bit shifted value.</td> |
85 |
|
</tr> |
86 |
</table> |
</table> |
87 |
|
|
88 |
<h3>Common Sampler Functions</h3> |
<h3>Common Sampler Functions</h3> |
107 |
<td>Changes the tuning of voices.</td> |
<td>Changes the tuning of voices.</td> |
108 |
</tr> |
</tr> |
109 |
<tr> |
<tr> |
110 |
|
<td><code>change_tune_time()</code></td> |
111 |
|
<td>Changes the duration of tuning changes.</td> |
112 |
|
</tr> |
113 |
|
<tr> |
114 |
<td><code>change_vol()</code></td> |
<td><code>change_vol()</code></td> |
115 |
<td>Changes the volume of voices.</td> |
<td>Changes the volume of voices.</td> |
116 |
</tr> |
</tr> |
117 |
<tr> |
<tr> |
118 |
|
<td><code>change_vol_time()</code></td> |
119 |
|
<td>Changes the duration of volume changes.</td> |
120 |
|
</tr> |
121 |
|
<tr> |
122 |
<td><code>change_cutoff()</code></td> |
<td><code>change_cutoff()</code></td> |
123 |
<td>Changes filter cutoff frequency of voices.</td> |
<td>Changes filter cutoff frequency of voices.</td> |
124 |
</tr> |
</tr> |
127 |
<td>Changes filter resonance of voices.</td> |
<td>Changes filter resonance of voices.</td> |
128 |
</tr> |
</tr> |
129 |
<tr> |
<tr> |
130 |
|
<td><code>change_attack()</code></td> |
131 |
|
<td>Modifies the attack time of voices.</td> |
132 |
|
</tr> |
133 |
|
<tr> |
134 |
|
<td><code>change_decay()</code></td> |
135 |
|
<td>Modifies the decay time of voices.</td> |
136 |
|
</tr> |
137 |
|
<tr> |
138 |
|
<td><code>change_release()</code></td> |
139 |
|
<td>Modifies the release time of voices.</td> |
140 |
|
</tr> |
141 |
|
<tr> |
142 |
|
<td><code>change_amp_lfo_depth()</code></td> |
143 |
|
<td>Modifies the amplitude LFO depth.</td> |
144 |
|
</tr> |
145 |
|
<tr> |
146 |
|
<td><code>change_amp_lfo_freq()</code></td> |
147 |
|
<td>Modifies the amplitude LFO frequency.</td> |
148 |
|
</tr> |
149 |
|
<tr> |
150 |
|
<td><code>change_pitch_lfo_depth()</code></td> |
151 |
|
<td>Modifies the pitch LFO depth.</td> |
152 |
|
</tr> |
153 |
|
<tr> |
154 |
|
<td><code>change_pitch_lfo_freq()</code></td> |
155 |
|
<td>Modifies the pitch LFO frequency.</td> |
156 |
|
</tr> |
157 |
|
<tr> |
158 |
<td><code>event_status()</code></td> |
<td><code>event_status()</code></td> |
159 |
<td>Checks and returns whether a particular note is still alive.</td> |
<td>Checks and returns whether a particular note is still alive.</td> |
160 |
</tr> |
</tr> |
161 |
<tr> |
<tr> |
162 |
|
<td><code>fade_in()</code></td> |
163 |
|
<td>Fade the requested note in.</td> |
164 |
|
</tr> |
165 |
|
<tr> |
166 |
|
<td><code>fade_out()</code></td> |
167 |
|
<td>Fade the requested note out.</td> |
168 |
|
</tr> |
169 |
|
<tr> |
170 |
|
<td><code>get_event_par()</code></td> |
171 |
|
<td>Get the current value of a specific note parameter.</td> |
172 |
|
</tr> |
173 |
|
<tr> |
174 |
|
<td><code>set_event_par()</code></td> |
175 |
|
<td>Change the value of a specific note parameter.</td> |
176 |
|
</tr> |
177 |
|
<tr> |
178 |
<td><code>set_controller()</code></td> |
<td><code>set_controller()</code></td> |
179 |
<td>Creates a MIDI control change event.</td> |
<td>Creates a MIDI control change event.</td> |
180 |
</tr> |
</tr> |
308 |
</note> |
</note> |
309 |
</td> |
</td> |
310 |
</tr> |
</tr> |
311 |
|
<tr> |
312 |
|
<td><code>$NI_CALLBACK_ID</code></td> |
313 |
|
<td>Reflects the current event handler instance's unique callback ID. |
314 |
|
For the same event type there may be more than |
315 |
|
one event handler instances running. Each one of them has |
316 |
|
its own callback ID. You can get the current event handler |
317 |
|
instance's callback ID by reading this built-in variable.</td> |
318 |
|
</tr> |
319 |
|
<tr> |
320 |
|
<td><code>$NI_CALLBACK_TYPE</code></td> |
321 |
|
<td>Reflects the event type of the current event handler. This variable |
322 |
|
may reflect one of the following built-in constants: |
323 |
|
<code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>, |
324 |
|
<code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td> |
325 |
|
</tr> |
326 |
|
<tr> |
327 |
|
<td><code>$NI_CB_TYPE_INIT</code></td> |
328 |
|
<td>Built-in constant reflecting an <code>init</code> event handler type.</td> |
329 |
|
</tr> |
330 |
|
<tr> |
331 |
|
<td><code>$NI_CB_TYPE_NOTE</code></td> |
332 |
|
<td>Built-in constant reflecting a <code>note</code> event handler type.</td> |
333 |
|
</tr> |
334 |
|
<tr> |
335 |
|
<td><code>$NI_CB_TYPE_RELEASE</code></td> |
336 |
|
<td>Built-in constant reflecting a <code>release</code> event handler type.</td> |
337 |
|
</tr> |
338 |
|
<tr> |
339 |
|
<td><code>$NI_CB_TYPE_CONTROLLER</code></td> |
340 |
|
<td>Built-in constant reflecting a <code>controller</code> event handler type.</td> |
341 |
|
</tr> |
342 |
|
<tr> |
343 |
|
<td><code>$NKSP_IGNORE_WAIT</code></td> |
344 |
|
<td>If this boolean built-in variable is <code>1</code> then all calls of your |
345 |
|
event handler instance to function <code>wait()</code> will be ignored. |
346 |
|
This may for example be the case if another event handler instance |
347 |
|
resumed your paused script by calling <code>stop_wait()</code> and |
348 |
|
passing <code>1</code> to the 2nd argument of that function.</td> |
349 |
|
</tr> |
350 |
</table> |
</table> |
351 |
|
|
352 |
<h3>Common Sampler Variables</h3> |
<h3>Common Sampler Variables</h3> |
359 |
<th>Variable</th> <th>Description</th> |
<th>Variable</th> <th>Description</th> |
360 |
</tr> |
</tr> |
361 |
<tr> |
<tr> |
362 |
|
<td><code>%ALL_EVENTS</code></td> |
363 |
|
<td> |
364 |
|
Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel). |
365 |
|
This may be passed to many built-in functions like <code>note_off()</code>. |
366 |
|
This array variable only contains IDs of notes which were launched due |
367 |
|
to MIDI note-on events. This variable does not contain IDs of child notes |
368 |
|
(i.e. notes which were launched programmatically by calling <code>play_note()</code>). |
369 |
|
<note> |
370 |
|
In contrast to KSP this variable is an integer array type, whereas KSP's |
371 |
|
pendent of this built-in variable is an integer constant (scalar) called |
372 |
|
<code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a |
373 |
|
parser warning, the behavior will be the same though. |
374 |
|
</note> |
375 |
|
</td> |
376 |
|
</tr> |
377 |
|
<tr> |
378 |
<td><code>$CC_NUM</code></td> |
<td><code>$CC_NUM</code></td> |
379 |
<td>MIDI controller number that caused the <code>controller</code> |
<td>MIDI controller number that caused the <code>controller</code> |
380 |
handler to be executed (only useful in the context of a |
handler to be executed (only useful in the context of a |
420 |
note is still "alive".</td> |
note is still "alive".</td> |
421 |
</tr> |
</tr> |
422 |
<tr> |
<tr> |
423 |
|
<td><code>$EVENT_PAR_NOTE</code></td> |
424 |
|
<td>Constant value symbolizing the "note number" parameter. See |
425 |
|
<code>get_event_par()</code> and <code>set_event_par()</code> |
426 |
|
for details.</td> |
427 |
|
</tr> |
428 |
|
<tr> |
429 |
|
<td><code>$EVENT_PAR_TUNE</code></td> |
430 |
|
<td>Constant value symbolizing the "tune" parameter. See |
431 |
|
<code>get_event_par()</code> and <code>set_event_par()</code> |
432 |
|
for details.</td> |
433 |
|
</tr> |
434 |
|
<tr> |
435 |
|
<td><code>$EVENT_PAR_VELOCITY</code></td> |
436 |
|
<td>Constant value symbolizing the "note velocity" parameter. See |
437 |
|
<code>get_event_par()</code> and <code>set_event_par()</code> |
438 |
|
for details.</td> |
439 |
|
</tr> |
440 |
|
<tr> |
441 |
|
<td><code>$EVENT_PAR_VOLUME</code></td> |
442 |
|
<td>Constant value symbolizing the "volume" parameter. See |
443 |
|
<code>get_event_par()</code> and <code>set_event_par()</code> |
444 |
|
for details.</td> |
445 |
|
</tr> |
446 |
|
<tr> |
447 |
|
<td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td> |
448 |
|
<td>Four constant values symbolizing the 4 possible user specific |
449 |
|
parameters, which i.e. might be used to pass data from one script |
450 |
|
(slot) to another script (slot). See <code>get_event_par()</code> |
451 |
|
and <code>set_event_par()</code> for details.</td> |
452 |
|
</tr> |
453 |
|
<tr> |
454 |
<td><code>%KEY_DOWN[]</code></td> |
<td><code>%KEY_DOWN[]</code></td> |
455 |
<td>This can be used in any context to check whether a certain MIDI |
<td>This can be used in any context to check whether a certain MIDI |
456 |
key is currently pressed down. Use the respective MIDI note number |
key is currently pressed down. Use the respective MIDI note number |