/[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 3194 by schoenebeck, Sat May 20 13:37:20 2017 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 44  Line 48 
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 99  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>
# Line 111  Line 131 
131          <td>Changes the duration of tuning changes.</td>          <td>Changes the duration of tuning changes.</td>
132        </tr>        </tr>
133        <tr>        <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>
# Line 119  Line 143 
143          <td>Changes the duration of volume changes.</td>          <td>Changes the duration of volume changes.</td>
144        </tr>        </tr>
145        <tr>        <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 155  Line 183 
183          <td>Modifies the pitch LFO frequency.</td>          <td>Modifies the pitch LFO frequency.</td>
184        </tr>        </tr>
185        <tr>        <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>
# Line 217  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 457  Line 493 
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 530  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.3194  
changed lines
  Added in v.3265
  ViewVC Help
Powered by ViewVC