/[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 2949 by schoenebeck, Fri Jul 15 15:33:43 2016 UTC revision 3247 by schoenebeck, Sun May 28 22:28:23 2017 UTC
# 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>
90          <tr>
91            <td><code>sh_left()</code></td>
92            <td>Calculates a left bit shifted value.</td>
93          </tr>
94          <tr>
95            <td><code>sh_right()</code></td>
96            <td>Calculates a right bit shifted value.</td>
97          </tr>
98      </table>      </table>
99            
100      <h3>Common Sampler Functions</h3>      <h3>Common Sampler Functions</h3>
# Line 79  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>
# Line 87  Line 123 
123          <td>Changes the tuning of voices.</td>          <td>Changes the tuning of voices.</td>
124        </tr>        </tr>
125        <tr>        <tr>
126            <td><code>change_tune_time()</code></td>
127            <td>Changes the duration of tuning changes.</td>
128          </tr>
129          <tr>
130            <td><code>change_tune_curve()</code></td>
131            <td>Changes the curve type of tuning changes.</td>
132          </tr>
133          <tr>
134          <td><code>change_vol()</code></td>          <td><code>change_vol()</code></td>
135          <td>Changes the volume of voices.</td>          <td>Changes the volume of voices.</td>
136        </tr>        </tr>
137        <tr>        <tr>
138            <td><code>change_vol_time()</code></td>
139            <td>Changes the duration of volume changes.</td>
140          </tr>
141          <tr>
142            <td><code>change_vol_curve()</code></td>
143            <td>Changes the curve type of volume changes.</td>
144          </tr>
145          <tr>
146          <td><code>change_cutoff()</code></td>          <td><code>change_cutoff()</code></td>
147          <td>Changes filter cutoff frequency of voices.</td>          <td>Changes filter cutoff frequency of voices.</td>
148        </tr>        </tr>
# Line 99  Line 151 
151          <td>Changes filter resonance of voices.</td>          <td>Changes filter resonance of voices.</td>
152        </tr>        </tr>
153        <tr>        <tr>
154            <td><code>change_attack()</code></td>
155            <td>Modifies the attack time of voices.</td>
156          </tr>
157          <tr>
158            <td><code>change_decay()</code></td>
159            <td>Modifies the decay time of voices.</td>
160          </tr>
161          <tr>
162            <td><code>change_release()</code></td>
163            <td>Modifies the release time of voices.</td>
164          </tr>
165          <tr>
166            <td><code>change_amp_lfo_depth()</code></td>
167            <td>Modifies the amplitude LFO depth.</td>
168          </tr>
169          <tr>
170            <td><code>change_amp_lfo_freq()</code></td>
171            <td>Modifies the amplitude LFO frequency.</td>
172          </tr>
173          <tr>
174            <td><code>change_pitch_lfo_depth()</code></td>
175            <td>Modifies the pitch LFO depth.</td>
176          </tr>
177          <tr>
178            <td><code>change_pitch_lfo_freq()</code></td>
179            <td>Modifies the pitch LFO frequency.</td>
180          </tr>
181          <tr>
182            <td><code>change_velo()</code></td>
183            <td>Change MIDI velocity of note.</td>
184          </tr>
185          <tr>
186          <td><code>event_status()</code></td>          <td><code>event_status()</code></td>
187          <td>Checks and returns whether a particular note is still alive.</td>          <td>Checks and returns whether a particular note is still alive.</td>
188        </tr>        </tr>
189        <tr>        <tr>
190            <td><code>fade_in()</code></td>
191            <td>Fade the requested note in.</td>
192          </tr>
193          <tr>
194            <td><code>fade_out()</code></td>
195            <td>Fade the requested note out.</td>
196          </tr>
197          <tr>
198            <td><code>get_event_par()</code></td>
199            <td>Get the current value of a specific note parameter.</td>
200          </tr>
201          <tr>
202            <td><code>set_event_par()</code></td>
203            <td>Change the value of a specific note parameter.</td>
204          </tr>
205          <tr>
206          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
207          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
208        </tr>        </tr>
# Line 145  Line 245 
245          <td><code>gig_set_dim_zone()</code></td>          <td><code>gig_set_dim_zone()</code></td>
246          <td>Changes the currently active dimension zone.</td>          <td>Changes the currently active dimension zone.</td>
247        </tr>        </tr>
248          <tr>
249            <td><code>same_region()</code></td>
250            <td>Check whether two keys are mapped to the same region.</td>
251          </tr>
252      </table>      </table>
253    
254      <h2>Built-In Variables</h2>      <h2>Built-In Variables</h2>
# Line 237  Line 341 
341          </td>          </td>
342        </tr>        </tr>
343        <tr>        <tr>
344            <td><code>$NKSP_EASE_IN_EASE_OUT</code></td>
345            <td>Used to select a fade curve with "ease in and ease out" shape.</td>
346          </tr>
347          <tr>
348            <td><code>$NKSP_LINEAR</code></td>
349            <td>Used to select a fade curve with linear shape.</td>
350          </tr>
351          <tr>
352          <td><code>$NI_CALLBACK_ID</code></td>          <td><code>$NI_CALLBACK_ID</code></td>
353          <td>Reflects the current event handler instance's unique callback ID.          <td>Reflects the current event handler instance's unique callback ID.
354              For the same event type there may be more than              For the same event type there may be more than
# Line 287  Line 399 
399          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
400        </tr>        </tr>
401        <tr>        <tr>
402            <td><code>%ALL_EVENTS</code></td>
403            <td>
404              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>.
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>
410                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
412                <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
413                parser warning, the behavior will be the same though.
414              </note>
415            </td>
416          </tr>
417          <tr>
418          <td><code>$CC_NUM</code></td>          <td><code>$CC_NUM</code></td>
419          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
420              handler to be executed (only useful in the context of a              handler to be executed (only useful in the context of a
# Line 332  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
# Line 411  Line 570 
570          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>
571        </tr>        </tr>
572        <tr>        <tr>
573          <td><code>$GIG_DIM_ROUNDROBIN"</code></td>          <td><code>$GIG_DIM_ROUNDROBIN</code></td>
574          <td>Constant that identifies the <i>round robin dimension</i>.</td>          <td>Constant that identifies the <i>round robin dimension</i>.</td>
575        </tr>        </tr>
576        <tr>        <tr>
Legend:
Removed from v.2949  
changed lines
  Added in v.3247
  ViewVC Help
Powered by ViewVC