/[svn]/doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html
ViewVC logotype

Diff of /doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2966 by schoenebeck, Mon Jul 18 09:56:23 2016 UTC revision 3265 by schoenebeck, Thu Jun 1 00:31:12 2017 UTC
# Line 15  Line 15 
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    
# Line 28  Line 28 
28          <th>Function</th> <th>Description</th>          <th>Function</th> <th>Description</th>
29        </tr>        </tr>
30        <tr>        <tr>
31            <td><code lang="nksp">array_equal()</code></td>
32            <td>Check whether two arrays are equal.</td>
33          </tr>
34          <tr>
35          <td><code lang="nksp">dec()</code></td>          <td><code lang="nksp">dec()</code></td>
36          <td>Decrements the passed integer variable by one.</td>          <td>Decrements the passed integer variable by one.</td>
37        </tr>        </tr>
# Line 36  Line 40 
40          <td>Increments the passed integer variable by one.</td>          <td>Increments the passed integer variable by one.</td>
41        </tr>        </tr>
42        <tr>        <tr>
43            <td><code>in_range()</code></td>
44            <td>Checks whether a value is between two other values.</td>
45          </tr>
46          <tr>
47          <td><code lang="nksp">message()</code></td>          <td><code lang="nksp">message()</code></td>
48          <td>Prints text to the sampler's terminal.</td>          <td>Prints text to the sampler's terminal.</td>
49        </tr>        </tr>
50        <tr>        <tr>
51            <td><code>search()</code></td>
52            <td>Search for a certain value within an array.</td>
53          </tr>
54          <tr>
55            <td><code>sort()</code></td>
56            <td>Sort the given array.</td>
57          </tr>
58          <tr>
59          <td><code>exit()</code></td>          <td><code>exit()</code></td>
60          <td>Stops execution of the current event handler instance.</td>          <td>Stops execution of the current event handler instance.</td>
61        </tr>        </tr>
# Line 60  Line 76 
76          <td>Random number generator.</td>          <td>Random number generator.</td>
77        </tr>        </tr>
78        <tr>        <tr>
79            <td><code>min()</code></td>
80            <td>Calculates the minimum value of two given values.</td>
81          </tr>
82          <tr>
83            <td><code>max()</code></td>
84            <td>Calculates the maximum value of two given values.</td>
85          </tr>
86          <tr>
87          <td><code>num_elements()</code></td>          <td><code>num_elements()</code></td>
88          <td>Returns the size of the requested array variable.</td>          <td>Returns the size of the requested array variable.</td>
89        </tr>        </tr>
# Line 87  Line 111 
111          <td>Triggers a new note.</td>          <td>Triggers a new note.</td>
112        </tr>        </tr>
113        <tr>        <tr>
114            <td><code>change_note()</code></td>
115            <td>Change MIDI note number of note.</td>
116          </tr>
117          <tr>
118          <td><code>change_pan()</code></td>          <td><code>change_pan()</code></td>
119          <td>Changes panning of voices (stereo balance).</td>          <td>Changes panning of voices (stereo balance).</td>
120        </tr>        </tr>
121        <tr>        <tr>
122            <td><code>change_play_pos()</code></td>
123            <td>Change the sample playback position.</td>
124          </tr>
125          <tr>
126          <td><code>change_tune()</code></td>          <td><code>change_tune()</code></td>
127          <td>Changes the tuning of voices.</td>          <td>Changes the tuning of voices.</td>
128        </tr>        </tr>
129        <tr>        <tr>
130            <td><code>change_tune_time()</code></td>
131            <td>Changes the duration of tuning changes.</td>
132          </tr>
133          <tr>
134            <td><code>change_tune_curve()</code></td>
135            <td>Changes the curve type of tuning changes.</td>
136          </tr>
137          <tr>
138          <td><code>change_vol()</code></td>          <td><code>change_vol()</code></td>
139          <td>Changes the volume of voices.</td>          <td>Changes the volume of voices.</td>
140        </tr>        </tr>
141        <tr>        <tr>
142            <td><code>change_vol_time()</code></td>
143            <td>Changes the duration of volume changes.</td>
144          </tr>
145          <tr>
146            <td><code>change_vol_curve()</code></td>
147            <td>Changes the curve type of volume changes.</td>
148          </tr>
149          <tr>
150          <td><code>change_cutoff()</code></td>          <td><code>change_cutoff()</code></td>
151          <td>Changes filter cutoff frequency of voices.</td>          <td>Changes filter cutoff frequency of voices.</td>
152        </tr>        </tr>
# Line 119  Line 167 
167          <td>Modifies the release time of voices.</td>          <td>Modifies the release time of voices.</td>
168        </tr>        </tr>
169        <tr>        <tr>
170            <td><code>change_amp_lfo_depth()</code></td>
171            <td>Modifies the amplitude LFO depth.</td>
172          </tr>
173          <tr>
174            <td><code>change_amp_lfo_freq()</code></td>
175            <td>Modifies the amplitude LFO frequency.</td>
176          </tr>
177          <tr>
178            <td><code>change_pitch_lfo_depth()</code></td>
179            <td>Modifies the pitch LFO depth.</td>
180          </tr>
181          <tr>
182            <td><code>change_pitch_lfo_freq()</code></td>
183            <td>Modifies the pitch LFO frequency.</td>
184          </tr>
185          <tr>
186            <td><code>change_velo()</code></td>
187            <td>Change MIDI velocity of note.</td>
188          </tr>
189          <tr>
190          <td><code>event_status()</code></td>          <td><code>event_status()</code></td>
191          <td>Checks and returns whether a particular note is still alive.</td>          <td>Checks and returns whether a particular note is still alive.</td>
192        </tr>        </tr>
193        <tr>        <tr>
194            <td><code>fade_in()</code></td>
195            <td>Fade the requested note in.</td>
196          </tr>
197          <tr>
198            <td><code>fade_out()</code></td>
199            <td>Fade the requested note out.</td>
200          </tr>
201          <tr>
202            <td><code>get_event_par()</code></td>
203            <td>Get the current value of a specific note parameter.</td>
204          </tr>
205          <tr>
206            <td><code>set_event_par()</code></td>
207            <td>Change the value of a specific note parameter.</td>
208          </tr>
209          <tr>
210          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
211          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
212        </tr>        </tr>
# Line 165  Line 249 
249          <td><code>gig_set_dim_zone()</code></td>          <td><code>gig_set_dim_zone()</code></td>
250          <td>Changes the currently active dimension zone.</td>          <td>Changes the currently active dimension zone.</td>
251        </tr>        </tr>
252          <tr>
253            <td><code>same_region()</code></td>
254            <td>Check whether two keys are mapped to the same region.</td>
255          </tr>
256      </table>      </table>
257    
258      <h2>Built-In Variables</h2>      <h2>Built-In Variables</h2>
# Line 307  Line 395 
395          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
396        </tr>        </tr>
397        <tr>        <tr>
398            <td><code>%ALL_EVENTS</code></td>
399            <td>
400              Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
401              This may be passed to many built-in functions like <code>note_off()</code>.
402              This array variable only contains IDs of notes which were launched due
403              to MIDI note-on events. This variable does not contain IDs of child notes
404              (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
405              <note>
406                In contrast to KSP this variable is an integer array type, whereas KSP's
407                pendent of this built-in variable is an integer constant (scalar) called
408                <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
409                parser warning, the behavior will be the same though.
410              </note>
411            </td>
412          </tr>
413          <tr>
414          <td><code>$CC_NUM</code></td>          <td><code>$CC_NUM</code></td>
415          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
416              handler to be executed (only useful in the context of a              handler to be executed (only useful in the context of a
# Line 352  Line 456 
456              note is still "alive".</td>              note is still "alive".</td>
457        </tr>        </tr>
458        <tr>        <tr>
459            <td><code>$EVENT_PAR_NOTE</code></td>
460            <td>Constant value symbolizing the "note number" parameter. See
461                <code>get_event_par()</code> and <code>set_event_par()</code>
462                for details.</td>
463          </tr>
464          <tr>
465            <td><code>$EVENT_PAR_TUNE</code></td>
466            <td>Constant value symbolizing the "tune" parameter. See
467                <code>get_event_par()</code> and <code>set_event_par()</code>
468                for details.</td>
469          </tr>
470          <tr>
471            <td><code>$EVENT_PAR_VELOCITY</code></td>
472            <td>Constant value symbolizing the "note velocity" parameter. See
473                <code>get_event_par()</code> and <code>set_event_par()</code>
474                for details.</td>
475          </tr>
476          <tr>
477            <td><code>$EVENT_PAR_VOLUME</code></td>
478            <td>Constant value symbolizing the "volume" parameter. See
479                <code>get_event_par()</code> and <code>set_event_par()</code>
480                for details.</td>
481          </tr>
482          <tr>
483            <td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td>
484            <td>Four constant values symbolizing the 4 possible user specific
485                parameters, which i.e. might be used to pass data from one script
486                (slot) to another script (slot). See  <code>get_event_par()</code>
487                and <code>set_event_par()</code> for details.</td>
488          </tr>
489          <tr>
490          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
491          <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
492              key is currently pressed down. Use the respective MIDI note number              key is currently pressed down. Use the respective MIDI note number
493              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>
494        </tr>        </tr>
495        <tr>        <tr>
496            <td><code>$NKSP_EASE_IN_EASE_OUT</code></td>
497            <td>Used to select a fade curve with "ease in and ease out" shape.</td>
498          </tr>
499          <tr>
500            <td><code>$NKSP_LINEAR</code></td>
501            <td>Used to select a fade curve with linear shape.</td>
502          </tr>
503          <tr>
504          <td><code>$VCC_MONO_AT</code></td>          <td><code>$VCC_MONO_AT</code></td>
505          <td>Constant identifying the MIDI monophonic aftertouch controller (also          <td>Constant identifying the MIDI monophonic aftertouch controller (also
506              called <i title="Amount of force on held-down key.">              called <i title="Amount of force on held-down key.">
# Line 431  Line 574 
574          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>
575        </tr>        </tr>
576        <tr>        <tr>
577          <td><code>$GIG_DIM_ROUNDROBIN"</code></td>          <td><code>$GIG_DIM_ROUNDROBIN</code></td>
578          <td>Constant that identifies the <i>round robin dimension</i>.</td>          <td>Constant that identifies the <i>round robin dimension</i>.</td>
579        </tr>        </tr>
580        <tr>        <tr>
Legend:
Removed from v.2966  
changed lines
  Added in v.3265
  ViewVC Help
Powered by ViewVC