/[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 2944 by schoenebeck, Wed Jul 13 16:52:58 2016 UTC revision 3077 by schoenebeck, Thu Jan 5 18:02:08 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">dec()</code></td>
32            <td>Decrements the passed integer variable by one.</td>
33          </tr>
34          <tr>
35            <td><code>inc()</code></td>
36            <td>Increments the passed integer variable by one.</td>
37          </tr>
38          <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 40  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 48  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 87  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>event_status()</code></td>          <td><code>event_status()</code></td>
135          <td>Checks and returns whether a particular note is still alive.</td>          <td>Checks and returns whether a particular note is still alive.</td>
136        </tr>        </tr>
# Line 224  Line 268 
268              </note>              </note>
269          </td>          </td>
270        </tr>        </tr>
271          <tr>
272            <td><code>$NI_CALLBACK_ID</code></td>
273            <td>Reflects the current event handler instance's unique callback ID.
274                For the same event type there may be more than
275                one event handler instances running. Each one of them has
276                its own callback ID. You can get the current event handler
277                instance's callback ID by reading this built-in variable.</td>
278          </tr>
279          <tr>
280            <td><code>$NI_CALLBACK_TYPE</code></td>
281            <td>Reflects the event type of the current event handler. This variable
282                may reflect one of the following built-in constants:
283                <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
284                <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
285          </tr>
286          <tr>
287            <td><code>$NI_CB_TYPE_INIT</code></td>
288            <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
289          </tr>
290          <tr>
291            <td><code>$NI_CB_TYPE_NOTE</code></td>
292            <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
293          </tr>
294          <tr>
295            <td><code>$NI_CB_TYPE_RELEASE</code></td>
296            <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
297          </tr>
298          <tr>
299            <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
300            <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
301          </tr>
302          <tr>
303            <td><code>$NKSP_IGNORE_WAIT</code></td>
304            <td>If this boolean built-in variable is <code>1</code> then all calls of your
305                event handler instance to function <code>wait()</code> will be ignored.
306                This may for example be the case if another event handler instance
307                resumed your paused script by calling <code>stop_wait()</code> and
308                passing <code>1</code> to the 2nd argument of that function.</td>
309          </tr>
310      </table>      </table>
311    
312      <h3>Common Sampler Variables</h3>      <h3>Common Sampler Variables</h3>
# Line 236  Line 319 
319          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
320        </tr>        </tr>
321        <tr>        <tr>
322            <td><code>%ALL_EVENTS</code></td>
323            <td>
324              Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
325              This may be passed to many built-in functions like <code>note_off()</code>.
326              This array variable only contains IDs of notes which were launched due
327              to MIDI note-on events. This variable does not contain IDs of child notes
328              (i.e. notes which were launched programmatically by calling <code>note_on()</code>).
329              <note>
330                In contrast to KSP this variable is an integer array type, whereas KSP's
331                pendent of this built-in variable is an integer constant (scalar) called
332                <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
333                parser warning, the behavior will be the same though.
334              </note>
335            </td>
336          </tr>
337          <tr>
338          <td><code>$CC_NUM</code></td>          <td><code>$CC_NUM</code></td>
339          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
340              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.2944  
changed lines
  Added in v.3077
  ViewVC Help
Powered by ViewVC