/[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 3075 by schoenebeck, Thu Jan 5 16:36:16 2017 UTC
# Line 48  Line 48 
48          <td>Pauses execution for a certain amount of time.</td>          <td>Pauses execution for a certain amount of time.</td>
49        </tr>        </tr>
50        <tr>        <tr>
51            <td><code>stop_wait()</code></td>
52            <td>Resumes execution of a suspended script callback.</td>
53          </tr>
54          <tr>
55          <td><code>abs()</code></td>          <td><code>abs()</code></td>
56          <td>Calculates the absolute value of a given value.</td>          <td>Calculates the absolute value of a given value.</td>
57        </tr>        </tr>
# Line 56  Line 60 
60          <td>Random number generator.</td>          <td>Random number generator.</td>
61        </tr>        </tr>
62        <tr>        <tr>
63            <td><code>min()</code></td>
64            <td>Calculates the minimum value of two given values.</td>
65          </tr>
66          <tr>
67            <td><code>max()</code></td>
68            <td>Calculates the maximum value of two given values.</td>
69          </tr>
70          <tr>
71          <td><code>num_elements()</code></td>          <td><code>num_elements()</code></td>
72          <td>Returns the size of the requested array variable.</td>          <td>Returns the size of the requested array variable.</td>
73        </tr>        </tr>
74          <tr>
75            <td><code>sh_left()</code></td>
76            <td>Calculates a left bit shifted value.</td>
77          </tr>
78          <tr>
79            <td><code>sh_right()</code></td>
80            <td>Calculates a right bit shifted value.</td>
81          </tr>
82      </table>      </table>
83            
84      <h3>Common Sampler Functions</h3>      <h3>Common Sampler Functions</h3>
# Line 95  Line 115 
115          <td>Changes filter resonance of voices.</td>          <td>Changes filter resonance of voices.</td>
116        </tr>        </tr>
117        <tr>        <tr>
118            <td><code>change_attack()</code></td>
119            <td>Modifies the attack time of voices.</td>
120          </tr>
121          <tr>
122            <td><code>change_decay()</code></td>
123            <td>Modifies the decay time of voices.</td>
124          </tr>
125          <tr>
126            <td><code>change_release()</code></td>
127            <td>Modifies the release time of voices.</td>
128          </tr>
129          <tr>
130          <td><code>event_status()</code></td>          <td><code>event_status()</code></td>
131          <td>Checks and returns whether a particular note is still alive.</td>          <td>Checks and returns whether a particular note is still alive.</td>
132        </tr>        </tr>
# Line 232  Line 264 
264              </note>              </note>
265          </td>          </td>
266        </tr>        </tr>
267          <tr>
268            <td><code>$NI_CALLBACK_ID</code></td>
269            <td>Reflects the current event handler instance's unique callback ID.
270                For the same event type there may be more than
271                one event handler instances running. Each one of them has
272                its own callback ID. You can get the current event handler
273                instance's callback ID by reading this built-in variable.</td>
274          </tr>
275          <tr>
276            <td><code>$NI_CALLBACK_TYPE</code></td>
277            <td>Reflects the event type of the current event handler. This variable
278                may reflect one of the following built-in constants:
279                <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
280                <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
281          </tr>
282          <tr>
283            <td><code>$NI_CB_TYPE_INIT</code></td>
284            <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
285          </tr>
286          <tr>
287            <td><code>$NI_CB_TYPE_NOTE</code></td>
288            <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
289          </tr>
290          <tr>
291            <td><code>$NI_CB_TYPE_RELEASE</code></td>
292            <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
293          </tr>
294          <tr>
295            <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
296            <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
297          </tr>
298          <tr>
299            <td><code>$NKSP_IGNORE_WAIT</code></td>
300            <td>If this boolean built-in variable is <code>1</code> then all calls of your
301                event handler instance to function <code>wait()</code> will be ignored.
302                This may for example be the case if another event handler instance
303                resumed your paused script by calling <code>stop_wait()</code> and
304                passing <code>1</code> to the 2nd argument of that function.</td>
305          </tr>
306      </table>      </table>
307    
308      <h3>Common Sampler Variables</h3>      <h3>Common Sampler Variables</h3>
# Line 244  Line 315 
315          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
316        </tr>        </tr>
317        <tr>        <tr>
318            <td><code>%ALL_EVENTS</code></td>
319            <td>
320              Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
321              This may be passed to many built-in functions like <code>note_off()</code>.
322              <note>
323                In contrast to KSP this variable is an integer array type, whereas KSP's
324                pendent of this built-in variable is an integer constant (scalar) called
325                <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
326                parser warning, the behavior will be the same though.
327              </note>
328            </td>
329          </tr>
330          <tr>
331          <td><code>$CC_NUM</code></td>          <td><code>$CC_NUM</code></td>
332          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
333              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.3075
  ViewVC Help
Powered by ViewVC