/[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 2966 by schoenebeck, Mon Jul 18 09:56:23 2016 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 59  Line 63 
63          <td><code>num_elements()</code></td>          <td><code>num_elements()</code></td>
64          <td>Returns the size of the requested array variable.</td>          <td>Returns the size of the requested array variable.</td>
65        </tr>        </tr>
66          <tr>
67            <td><code>sh_left()</code></td>
68            <td>Calculates a left bit shifted value.</td>
69          </tr>
70          <tr>
71            <td><code>sh_right()</code></td>
72            <td>Calculates a right bit shifted value.</td>
73          </tr>
74      </table>      </table>
75            
76      <h3>Common Sampler Functions</h3>      <h3>Common Sampler Functions</h3>
# Line 95  Line 107 
107          <td>Changes filter resonance of voices.</td>          <td>Changes filter resonance of voices.</td>
108        </tr>        </tr>
109        <tr>        <tr>
110            <td><code>change_attack()</code></td>
111            <td>Modifies the attack time of voices.</td>
112          </tr>
113          <tr>
114            <td><code>change_decay()</code></td>
115            <td>Modifies the decay time of voices.</td>
116          </tr>
117          <tr>
118            <td><code>change_release()</code></td>
119            <td>Modifies the release time of voices.</td>
120          </tr>
121          <tr>
122          <td><code>event_status()</code></td>          <td><code>event_status()</code></td>
123          <td>Checks and returns whether a particular note is still alive.</td>          <td>Checks and returns whether a particular note is still alive.</td>
124        </tr>        </tr>
# Line 232  Line 256 
256              </note>              </note>
257          </td>          </td>
258        </tr>        </tr>
259          <tr>
260            <td><code>$NI_CALLBACK_ID</code></td>
261            <td>Reflects the current event handler instance's unique callback ID.
262                For the same event type there may be more than
263                one event handler instances running. Each one of them has
264                its own callback ID. You can get the current event handler
265                instance's callback ID by reading this built-in variable.</td>
266          </tr>
267          <tr>
268            <td><code>$NI_CALLBACK_TYPE</code></td>
269            <td>Reflects the event type of the current event handler. This variable
270                may reflect one of the following built-in constants:
271                <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
272                <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
273          </tr>
274          <tr>
275            <td><code>$NI_CB_TYPE_INIT</code></td>
276            <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
277          </tr>
278          <tr>
279            <td><code>$NI_CB_TYPE_NOTE</code></td>
280            <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
281          </tr>
282          <tr>
283            <td><code>$NI_CB_TYPE_RELEASE</code></td>
284            <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
285          </tr>
286          <tr>
287            <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
288            <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
289          </tr>
290          <tr>
291            <td><code>$NKSP_IGNORE_WAIT</code></td>
292            <td>If this boolean built-in variable is <code>1</code> then all calls of your
293                event handler instance to function <code>wait()</code> will be ignored.
294                This may for example be the case if another event handler instance
295                resumed your paused script by calling <code>stop_wait()</code> and
296                passing <code>1</code> to the 2nd argument of that function.</td>
297          </tr>
298      </table>      </table>
299    
300      <h3>Common Sampler Variables</h3>      <h3>Common Sampler Variables</h3>
Legend:
Removed from v.2946  
changed lines
  Added in v.2966
  ViewVC Help
Powered by ViewVC