15 |
|
|
16 |
<h2>Built-In Functions</h2> |
<h2>Built-In Functions</h2> |
17 |
<p> |
<p> |
18 |
These are the built-in functions available with the NKSP realt-time |
These are the built-in functions available with the NKSP real-time |
19 |
instrument script language. |
instrument script language. |
20 |
</p> |
</p> |
21 |
|
|
28 |
<th>Function</th> <th>Description</th> |
<th>Function</th> <th>Description</th> |
29 |
</tr> |
</tr> |
30 |
<tr> |
<tr> |
31 |
|
<td><code lang="nksp">abort()</code></td> |
32 |
|
<td>Stops execution of a script callback.</td> |
33 |
|
</tr> |
34 |
|
<tr> |
35 |
|
<td><code lang="nksp">array_equal()</code></td> |
36 |
|
<td>Check whether two arrays are equal.</td> |
37 |
|
</tr> |
38 |
|
<tr> |
39 |
<td><code lang="nksp">dec()</code></td> |
<td><code lang="nksp">dec()</code></td> |
40 |
<td>Decrements the passed integer variable by one.</td> |
<td>Decrements the passed integer variable by one.</td> |
41 |
</tr> |
</tr> |
52 |
<td>Prints text to the sampler's terminal.</td> |
<td>Prints text to the sampler's terminal.</td> |
53 |
</tr> |
</tr> |
54 |
<tr> |
<tr> |
55 |
|
<td><code>search()</code></td> |
56 |
|
<td>Search for a certain value within an array.</td> |
57 |
|
</tr> |
58 |
|
<tr> |
59 |
|
<td><code>sort()</code></td> |
60 |
|
<td>Sort the given array.</td> |
61 |
|
</tr> |
62 |
|
<tr> |
63 |
<td><code>exit()</code></td> |
<td><code>exit()</code></td> |
64 |
<td>Stops execution of the current event handler instance.</td> |
<td>Stops execution of the current event handler instance.</td> |
65 |
</tr> |
</tr> |
123 |
<td>Changes panning of voices (stereo balance).</td> |
<td>Changes panning of voices (stereo balance).</td> |
124 |
</tr> |
</tr> |
125 |
<tr> |
<tr> |
126 |
|
<td><code>change_play_pos()</code></td> |
127 |
|
<td>Change the sample playback position.</td> |
128 |
|
</tr> |
129 |
|
<tr> |
130 |
<td><code>change_tune()</code></td> |
<td><code>change_tune()</code></td> |
131 |
<td>Changes the tuning of voices.</td> |
<td>Changes the tuning of voices.</td> |
132 |
</tr> |
</tr> |
135 |
<td>Changes the duration of tuning changes.</td> |
<td>Changes the duration of tuning changes.</td> |
136 |
</tr> |
</tr> |
137 |
<tr> |
<tr> |
138 |
|
<td><code>change_tune_curve()</code></td> |
139 |
|
<td>Changes the curve type of tuning changes.</td> |
140 |
|
</tr> |
141 |
|
<tr> |
142 |
<td><code>change_vol()</code></td> |
<td><code>change_vol()</code></td> |
143 |
<td>Changes the volume of voices.</td> |
<td>Changes the volume of voices.</td> |
144 |
</tr> |
</tr> |
147 |
<td>Changes the duration of volume changes.</td> |
<td>Changes the duration of volume changes.</td> |
148 |
</tr> |
</tr> |
149 |
<tr> |
<tr> |
150 |
|
<td><code>change_vol_curve()</code></td> |
151 |
|
<td>Changes the curve type of volume changes.</td> |
152 |
|
</tr> |
153 |
|
<tr> |
154 |
<td><code>change_cutoff()</code></td> |
<td><code>change_cutoff()</code></td> |
155 |
<td>Changes filter cutoff frequency of voices.</td> |
<td>Changes filter cutoff frequency of voices.</td> |
156 |
</tr> |
</tr> |
253 |
<td><code>gig_set_dim_zone()</code></td> |
<td><code>gig_set_dim_zone()</code></td> |
254 |
<td>Changes the currently active dimension zone.</td> |
<td>Changes the currently active dimension zone.</td> |
255 |
</tr> |
</tr> |
256 |
|
<tr> |
257 |
|
<td><code>same_region()</code></td> |
258 |
|
<td>Check whether two keys are mapped to the same region.</td> |
259 |
|
</tr> |
260 |
</table> |
</table> |
261 |
|
|
262 |
<h2>Built-In Variables</h2> |
<h2>Built-In Variables</h2> |
497 |
as index to this array variable (see also <code>event_status()</code>).</td> |
as index to this array variable (see also <code>event_status()</code>).</td> |
498 |
</tr> |
</tr> |
499 |
<tr> |
<tr> |
500 |
|
<td><code>$NKSP_EASE_IN_EASE_OUT</code></td> |
501 |
|
<td>Used to select a fade curve with "ease in and ease out" shape.</td> |
502 |
|
</tr> |
503 |
|
<tr> |
504 |
|
<td><code>$NKSP_LINEAR</code></td> |
505 |
|
<td>Used to select a fade curve with linear shape.</td> |
506 |
|
</tr> |
507 |
|
<tr> |
508 |
<td><code>$VCC_MONO_AT</code></td> |
<td><code>$VCC_MONO_AT</code></td> |
509 |
<td>Constant identifying the MIDI monophonic aftertouch controller (also |
<td>Constant identifying the MIDI monophonic aftertouch controller (also |
510 |
called <i title="Amount of force on held-down key."> |
called <i title="Amount of force on held-down key."> |
578 |
<td>Constant that identifies the <i>keyboard position dimension</i>.</td> |
<td>Constant that identifies the <i>keyboard position dimension</i>.</td> |
579 |
</tr> |
</tr> |
580 |
<tr> |
<tr> |
581 |
<td><code>$GIG_DIM_ROUNDROBIN"</code></td> |
<td><code>$GIG_DIM_ROUNDROBIN</code></td> |
582 |
<td>Constant that identifies the <i>round robin dimension</i>.</td> |
<td>Constant that identifies the <i>round robin dimension</i>.</td> |
583 |
</tr> |
</tr> |
584 |
<tr> |
<tr> |