/[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 3121 by schoenebeck, Fri Apr 21 19:45:29 2017 UTC
# Line 36  Line 36 
36          <td>Increments the passed integer variable by one.</td>          <td>Increments the passed integer variable by one.</td>
37        </tr>        </tr>
38        <tr>        <tr>
39            <td><code>in_range()</code></td>
40            <td>Checks whether a value is between two other values.</td>
41          </tr>
42          <tr>
43          <td><code lang="nksp">message()</code></td>          <td><code lang="nksp">message()</code></td>
44          <td>Prints text to the sampler's terminal.</td>          <td>Prints text to the sampler's terminal.</td>
45        </tr>        </tr>
# Line 48  Line 52 
52          <td>Pauses execution for a certain amount of time.</td>          <td>Pauses execution for a certain amount of time.</td>
53        </tr>        </tr>
54        <tr>        <tr>
55            <td><code>stop_wait()</code></td>
56            <td>Resumes execution of a suspended script callback.</td>
57          </tr>
58          <tr>
59          <td><code>abs()</code></td>          <td><code>abs()</code></td>
60          <td>Calculates the absolute value of a given value.</td>          <td>Calculates the absolute value of a given value.</td>
61        </tr>        </tr>
# Line 56  Line 64 
64          <td>Random number generator.</td>          <td>Random number generator.</td>
65        </tr>        </tr>
66        <tr>        <tr>
67            <td><code>min()</code></td>
68            <td>Calculates the minimum value of two given values.</td>
69          </tr>
70          <tr>
71            <td><code>max()</code></td>
72            <td>Calculates the maximum value of two given values.</td>
73          </tr>
74          <tr>
75          <td><code>num_elements()</code></td>          <td><code>num_elements()</code></td>
76          <td>Returns the size of the requested array variable.</td>          <td>Returns the size of the requested array variable.</td>
77        </tr>        </tr>
78          <tr>
79            <td><code>sh_left()</code></td>
80            <td>Calculates a left bit shifted value.</td>
81          </tr>
82          <tr>
83            <td><code>sh_right()</code></td>
84            <td>Calculates a right bit shifted value.</td>
85          </tr>
86      </table>      </table>
87            
88      <h3>Common Sampler Functions</h3>      <h3>Common Sampler Functions</h3>
# Line 95  Line 119 
119          <td>Changes filter resonance of voices.</td>          <td>Changes filter resonance of voices.</td>
120        </tr>        </tr>
121        <tr>        <tr>
122            <td><code>change_attack()</code></td>
123            <td>Modifies the attack time of voices.</td>
124          </tr>
125          <tr>
126            <td><code>change_decay()</code></td>
127            <td>Modifies the decay time of voices.</td>
128          </tr>
129          <tr>
130            <td><code>change_release()</code></td>
131            <td>Modifies the release time of voices.</td>
132          </tr>
133          <tr>
134            <td><code>change_amp_lfo_depth()</code></td>
135            <td>Modifies the amplitude LFO depth.</td>
136          </tr>
137          <tr>
138            <td><code>change_amp_lfo_freq()</code></td>
139            <td>Modifies the amplitude LFO frequency.</td>
140          </tr>
141          <tr>
142            <td><code>change_pitch_lfo_depth()</code></td>
143            <td>Modifies the pitch LFO depth.</td>
144          </tr>
145          <tr>
146            <td><code>change_pitch_lfo_freq()</code></td>
147            <td>Modifies the pitch LFO frequency.</td>
148          </tr>
149          <tr>
150          <td><code>event_status()</code></td>          <td><code>event_status()</code></td>
151          <td>Checks and returns whether a particular note is still alive.</td>          <td>Checks and returns whether a particular note is still alive.</td>
152        </tr>        </tr>
# Line 232  Line 284 
284              </note>              </note>
285          </td>          </td>
286        </tr>        </tr>
287          <tr>
288            <td><code>$NI_CALLBACK_ID</code></td>
289            <td>Reflects the current event handler instance's unique callback ID.
290                For the same event type there may be more than
291                one event handler instances running. Each one of them has
292                its own callback ID. You can get the current event handler
293                instance's callback ID by reading this built-in variable.</td>
294          </tr>
295          <tr>
296            <td><code>$NI_CALLBACK_TYPE</code></td>
297            <td>Reflects the event type of the current event handler. This variable
298                may reflect one of the following built-in constants:
299                <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
300                <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
301          </tr>
302          <tr>
303            <td><code>$NI_CB_TYPE_INIT</code></td>
304            <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
305          </tr>
306          <tr>
307            <td><code>$NI_CB_TYPE_NOTE</code></td>
308            <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
309          </tr>
310          <tr>
311            <td><code>$NI_CB_TYPE_RELEASE</code></td>
312            <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
313          </tr>
314          <tr>
315            <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
316            <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
317          </tr>
318          <tr>
319            <td><code>$NKSP_IGNORE_WAIT</code></td>
320            <td>If this boolean built-in variable is <code>1</code> then all calls of your
321                event handler instance to function <code>wait()</code> will be ignored.
322                This may for example be the case if another event handler instance
323                resumed your paused script by calling <code>stop_wait()</code> and
324                passing <code>1</code> to the 2nd argument of that function.</td>
325          </tr>
326      </table>      </table>
327    
328      <h3>Common Sampler Variables</h3>      <h3>Common Sampler Variables</h3>
# Line 244  Line 335 
335          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
336        </tr>        </tr>
337        <tr>        <tr>
338            <td><code>%ALL_EVENTS</code></td>
339            <td>
340              Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
341              This may be passed to many built-in functions like <code>note_off()</code>.
342              This array variable only contains IDs of notes which were launched due
343              to MIDI note-on events. This variable does not contain IDs of child notes
344              (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
345              <note>
346                In contrast to KSP this variable is an integer array type, whereas KSP's
347                pendent of this built-in variable is an integer constant (scalar) called
348                <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
349                parser warning, the behavior will be the same though.
350              </note>
351            </td>
352          </tr>
353          <tr>
354          <td><code>$CC_NUM</code></td>          <td><code>$CC_NUM</code></td>
355          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
356              handler to be executed (only useful in the context of a              handler to be executed (only useful in the context of a
Legend:
Removed from v.2946  
changed lines
  Added in v.3121
  ViewVC Help
Powered by ViewVC