/[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 2948 by schoenebeck, Thu Jul 14 00:44:04 2016 UTC revision 2949 by schoenebeck, Fri Jul 15 15:33:43 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 232  Line 236 
236              </note>              </note>
237          </td>          </td>
238        </tr>        </tr>
239          <tr>
240            <td><code>$NI_CALLBACK_ID</code></td>
241            <td>Reflects the current event handler instance's unique callback ID.
242                For the same event type there may be more than
243                one event handler instances running. Each one of them has
244                its own callback ID. You can get the current event handler
245                instance's callback ID by reading this built-in variable.</td>
246          </tr>
247          <tr>
248            <td><code>$NI_CALLBACK_TYPE</code></td>
249            <td>Reflects the event type of the current event handler. This variable
250                may reflect one of the following built-in constants:
251                <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
252                <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
253          </tr>
254          <tr>
255            <td><code>$NI_CB_TYPE_INIT</code></td>
256            <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
257          </tr>
258          <tr>
259            <td><code>$NI_CB_TYPE_NOTE</code></td>
260            <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
261          </tr>
262          <tr>
263            <td><code>$NI_CB_TYPE_RELEASE</code></td>
264            <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
265          </tr>
266          <tr>
267            <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
268            <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
269          </tr>
270          <tr>
271            <td><code>$NKSP_IGNORE_WAIT</code></td>
272            <td>If this boolean built-in variable is <code>1</code> then all calls of your
273                event handler instance to function <code>wait()</code> will be ignored.
274                This may for example be the case if another event handler instance
275                resumed your paused script by calling <code>stop_wait()</code> and
276                passing <code>1</code> to the 2nd argument of that function.</td>
277          </tr>
278      </table>      </table>
279    
280      <h3>Common Sampler Variables</h3>      <h3>Common Sampler Variables</h3>

Legend:
Removed from v.2948  
changed lines
  Added in v.2949

  ViewVC Help
Powered by ViewVC