/[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 3075 by schoenebeck, Thu Jan 5 16:36:16 2017 UTC revision 3278 by schoenebeck, Mon Jun 5 19:02:59 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">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>
# Line 36  Line 44 
44          <td>Increments the passed integer variable by one.</td>          <td>Increments the passed integer variable by one.</td>
45        </tr>        </tr>
46        <tr>        <tr>
47            <td><code>in_range()</code></td>
48            <td>Checks whether a value is between two other values.</td>
49          </tr>
50          <tr>
51          <td><code lang="nksp">message()</code></td>          <td><code lang="nksp">message()</code></td>
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>
# Line 95  Line 115 
115          <td>Triggers a new note.</td>          <td>Triggers a new note.</td>
116        </tr>        </tr>
117        <tr>        <tr>
118            <td><code>change_note()</code></td>
119            <td>Change MIDI note number of note.</td>
120          </tr>
121          <tr>
122          <td><code>change_pan()</code></td>          <td><code>change_pan()</code></td>
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>
133        <tr>        <tr>
134            <td><code>change_tune_time()</code></td>
135            <td>Changes the duration of tuning changes.</td>
136          </tr>
137          <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>
145        <tr>        <tr>
146            <td><code>change_vol_time()</code></td>
147            <td>Changes the duration of volume changes.</td>
148          </tr>
149          <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>
# Line 127  Line 171 
171          <td>Modifies the release time of voices.</td>          <td>Modifies the release time of voices.</td>
172        </tr>        </tr>
173        <tr>        <tr>
174            <td><code>change_amp_lfo_depth()</code></td>
175            <td>Modifies the amplitude LFO depth.</td>
176          </tr>
177          <tr>
178            <td><code>change_amp_lfo_freq()</code></td>
179            <td>Modifies the amplitude LFO frequency.</td>
180          </tr>
181          <tr>
182            <td><code>change_pitch_lfo_depth()</code></td>
183            <td>Modifies the pitch LFO depth.</td>
184          </tr>
185          <tr>
186            <td><code>change_pitch_lfo_freq()</code></td>
187            <td>Modifies the pitch LFO frequency.</td>
188          </tr>
189          <tr>
190            <td><code>change_velo()</code></td>
191            <td>Change MIDI velocity of note.</td>
192          </tr>
193          <tr>
194          <td><code>event_status()</code></td>          <td><code>event_status()</code></td>
195          <td>Checks and returns whether a particular note is still alive.</td>          <td>Checks and returns whether a particular note is still alive.</td>
196        </tr>        </tr>
197        <tr>        <tr>
198            <td><code>fade_in()</code></td>
199            <td>Fade the requested note in.</td>
200          </tr>
201          <tr>
202            <td><code>fade_out()</code></td>
203            <td>Fade the requested note out.</td>
204          </tr>
205          <tr>
206            <td><code>get_event_par()</code></td>
207            <td>Get the current value of a specific note parameter.</td>
208          </tr>
209          <tr>
210            <td><code>set_event_par()</code></td>
211            <td>Change the value of a specific note parameter.</td>
212          </tr>
213          <tr>
214          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
215          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
216        </tr>        </tr>
# Line 173  Line 253 
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>
# Line 319  Line 403 
403          <td>          <td>
404            Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).            Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
405            This may be passed to many built-in functions like <code>note_off()</code>.            This may be passed to many built-in functions like <code>note_off()</code>.
406              This array variable only contains IDs of notes which were launched due
407              to MIDI note-on events. This variable does not contain IDs of child notes
408              (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
409            <note>            <note>
410              In contrast to KSP this variable is an integer array type, whereas KSP's              In contrast to KSP this variable is an integer array type, whereas KSP's
411              pendent of this built-in variable is an integer constant (scalar) called              pendent of this built-in variable is an integer constant (scalar) called
# Line 373  Line 460 
460              note is still "alive".</td>              note is still "alive".</td>
461        </tr>        </tr>
462        <tr>        <tr>
463            <td><code>$EVENT_PAR_NOTE</code></td>
464            <td>Constant value symbolizing the "note number" parameter. See
465                <code>get_event_par()</code> and <code>set_event_par()</code>
466                for details.</td>
467          </tr>
468          <tr>
469            <td><code>$EVENT_PAR_TUNE</code></td>
470            <td>Constant value symbolizing the "tune" parameter. See
471                <code>get_event_par()</code> and <code>set_event_par()</code>
472                for details.</td>
473          </tr>
474          <tr>
475            <td><code>$EVENT_PAR_VELOCITY</code></td>
476            <td>Constant value symbolizing the "note velocity" parameter. See
477                <code>get_event_par()</code> and <code>set_event_par()</code>
478                for details.</td>
479          </tr>
480          <tr>
481            <td><code>$EVENT_PAR_VOLUME</code></td>
482            <td>Constant value symbolizing the "volume" parameter. See
483                <code>get_event_par()</code> and <code>set_event_par()</code>
484                for details.</td>
485          </tr>
486          <tr>
487            <td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td>
488            <td>Four constant values symbolizing the 4 possible user specific
489                parameters, which i.e. might be used to pass data from one script
490                (slot) to another script (slot). See  <code>get_event_par()</code>
491                and <code>set_event_par()</code> for details.</td>
492          </tr>
493          <tr>
494          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
495          <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
496              key is currently pressed down. Use the respective MIDI note number              key is currently pressed down. Use the respective MIDI note number
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.">
# Line 452  Line 578 
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>
Legend:
Removed from v.3075  
changed lines
  Added in v.3278
  ViewVC Help
Powered by ViewVC