/[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 2946 by schoenebeck, Thu Jul 14 00:44:04 2016 UTC revision 3229 by schoenebeck, Sun May 28 15:22:55 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 48  Line 64 
64          <td>Pauses execution for a certain amount of time.</td>          <td>Pauses execution for a certain amount of time.</td>
65        </tr>        </tr>
66        <tr>        <tr>
67            <td><code>stop_wait()</code></td>
68            <td>Resumes execution of a suspended script callback.</td>
69          </tr>
70          <tr>
71          <td><code>abs()</code></td>          <td><code>abs()</code></td>
72          <td>Calculates the absolute value of a given value.</td>          <td>Calculates the absolute value of a given value.</td>
73        </tr>        </tr>
# Line 56  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 75  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 83  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_vol()</code></td>          <td><code>change_vol()</code></td>
131          <td>Changes the volume of voices.</td>          <td>Changes the volume of voices.</td>
132        </tr>        </tr>
133        <tr>        <tr>
134            <td><code>change_vol_time()</code></td>
135            <td>Changes the duration of volume changes.</td>
136          </tr>
137          <tr>
138          <td><code>change_cutoff()</code></td>          <td><code>change_cutoff()</code></td>
139          <td>Changes filter cutoff frequency of voices.</td>          <td>Changes filter cutoff frequency of voices.</td>
140        </tr>        </tr>
# Line 95  Line 143 
143          <td>Changes filter resonance of voices.</td>          <td>Changes filter resonance of voices.</td>
144        </tr>        </tr>
145        <tr>        <tr>
146            <td><code>change_attack()</code></td>
147            <td>Modifies the attack time of voices.</td>
148          </tr>
149          <tr>
150            <td><code>change_decay()</code></td>
151            <td>Modifies the decay time of voices.</td>
152          </tr>
153          <tr>
154            <td><code>change_release()</code></td>
155            <td>Modifies the release time of voices.</td>
156          </tr>
157          <tr>
158            <td><code>change_amp_lfo_depth()</code></td>
159            <td>Modifies the amplitude LFO depth.</td>
160          </tr>
161          <tr>
162            <td><code>change_amp_lfo_freq()</code></td>
163            <td>Modifies the amplitude LFO frequency.</td>
164          </tr>
165          <tr>
166            <td><code>change_pitch_lfo_depth()</code></td>
167            <td>Modifies the pitch LFO depth.</td>
168          </tr>
169          <tr>
170            <td><code>change_pitch_lfo_freq()</code></td>
171            <td>Modifies the pitch LFO frequency.</td>
172          </tr>
173          <tr>
174            <td><code>change_velo()</code></td>
175            <td>Change MIDI velocity of note.</td>
176          </tr>
177          <tr>
178          <td><code>event_status()</code></td>          <td><code>event_status()</code></td>
179          <td>Checks and returns whether a particular note is still alive.</td>          <td>Checks and returns whether a particular note is still alive.</td>
180        </tr>        </tr>
181        <tr>        <tr>
182            <td><code>fade_in()</code></td>
183            <td>Fade the requested note in.</td>
184          </tr>
185          <tr>
186            <td><code>fade_out()</code></td>
187            <td>Fade the requested note out.</td>
188          </tr>
189          <tr>
190            <td><code>get_event_par()</code></td>
191            <td>Get the current value of a specific note parameter.</td>
192          </tr>
193          <tr>
194            <td><code>set_event_par()</code></td>
195            <td>Change the value of a specific note parameter.</td>
196          </tr>
197          <tr>
198          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
199          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
200        </tr>        </tr>
# Line 141  Line 237 
237          <td><code>gig_set_dim_zone()</code></td>          <td><code>gig_set_dim_zone()</code></td>
238          <td>Changes the currently active dimension zone.</td>          <td>Changes the currently active dimension zone.</td>
239        </tr>        </tr>
240          <tr>
241            <td><code>same_region()</code></td>
242            <td>Check whether two keys are mapped to the same region.</td>
243          </tr>
244      </table>      </table>
245    
246      <h2>Built-In Variables</h2>      <h2>Built-In Variables</h2>
# Line 232  Line 332 
332              </note>              </note>
333          </td>          </td>
334        </tr>        </tr>
335          <tr>
336            <td><code>$NI_CALLBACK_ID</code></td>
337            <td>Reflects the current event handler instance's unique callback ID.
338                For the same event type there may be more than
339                one event handler instances running. Each one of them has
340                its own callback ID. You can get the current event handler
341                instance's callback ID by reading this built-in variable.</td>
342          </tr>
343          <tr>
344            <td><code>$NI_CALLBACK_TYPE</code></td>
345            <td>Reflects the event type of the current event handler. This variable
346                may reflect one of the following built-in constants:
347                <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
348                <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
349          </tr>
350          <tr>
351            <td><code>$NI_CB_TYPE_INIT</code></td>
352            <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
353          </tr>
354          <tr>
355            <td><code>$NI_CB_TYPE_NOTE</code></td>
356            <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
357          </tr>
358          <tr>
359            <td><code>$NI_CB_TYPE_RELEASE</code></td>
360            <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
361          </tr>
362          <tr>
363            <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
364            <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
365          </tr>
366          <tr>
367            <td><code>$NKSP_IGNORE_WAIT</code></td>
368            <td>If this boolean built-in variable is <code>1</code> then all calls of your
369                event handler instance to function <code>wait()</code> will be ignored.
370                This may for example be the case if another event handler instance
371                resumed your paused script by calling <code>stop_wait()</code> and
372                passing <code>1</code> to the 2nd argument of that function.</td>
373          </tr>
374      </table>      </table>
375    
376      <h3>Common Sampler Variables</h3>      <h3>Common Sampler Variables</h3>
# Line 244  Line 383 
383          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
384        </tr>        </tr>
385        <tr>        <tr>
386            <td><code>%ALL_EVENTS</code></td>
387            <td>
388              Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
389              This may be passed to many built-in functions like <code>note_off()</code>.
390              This array variable only contains IDs of notes which were launched due
391              to MIDI note-on events. This variable does not contain IDs of child notes
392              (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
393              <note>
394                In contrast to KSP this variable is an integer array type, whereas KSP's
395                pendent of this built-in variable is an integer constant (scalar) called
396                <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
397                parser warning, the behavior will be the same though.
398              </note>
399            </td>
400          </tr>
401          <tr>
402          <td><code>$CC_NUM</code></td>          <td><code>$CC_NUM</code></td>
403          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
404              handler to be executed (only useful in the context of a              handler to be executed (only useful in the context of a
# Line 289  Line 444 
444              note is still "alive".</td>              note is still "alive".</td>
445        </tr>        </tr>
446        <tr>        <tr>
447            <td><code>$EVENT_PAR_NOTE</code></td>
448            <td>Constant value symbolizing the "note number" parameter. See
449                <code>get_event_par()</code> and <code>set_event_par()</code>
450                for details.</td>
451          </tr>
452          <tr>
453            <td><code>$EVENT_PAR_TUNE</code></td>
454            <td>Constant value symbolizing the "tune" parameter. See
455                <code>get_event_par()</code> and <code>set_event_par()</code>
456                for details.</td>
457          </tr>
458          <tr>
459            <td><code>$EVENT_PAR_VELOCITY</code></td>
460            <td>Constant value symbolizing the "note velocity" 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_VOLUME</code></td>
466            <td>Constant value symbolizing the "volume" 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_0</code> to <code>$EVENT_PAR_3</code></td>
472            <td>Four constant values symbolizing the 4 possible user specific
473                parameters, which i.e. might be used to pass data from one script
474                (slot) to another script (slot). See  <code>get_event_par()</code>
475                and <code>set_event_par()</code> for details.</td>
476          </tr>
477          <tr>
478          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
479          <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
480              key is currently pressed down. Use the respective MIDI note number              key is currently pressed down. Use the respective MIDI note number
# Line 368  Line 554 
554          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>
555        </tr>        </tr>
556        <tr>        <tr>
557          <td><code>$GIG_DIM_ROUNDROBIN"</code></td>          <td><code>$GIG_DIM_ROUNDROBIN</code></td>
558          <td>Constant that identifies the <i>round robin dimension</i>.</td>          <td>Constant that identifies the <i>round robin dimension</i>.</td>
559        </tr>        </tr>
560        <tr>        <tr>
Legend:
Removed from v.2946  
changed lines
  Added in v.3229
  ViewVC Help
Powered by ViewVC