--- doc/docbase/instrument_scripts/nksp/reference/functions/nksp_wait_function.html 2016/07/15 15:33:43 2949 +++ doc/docbase/instrument_scripts/nksp/reference/functions/nksp_wait_function.html 2019/09/16 16:03:36 3601 @@ -9,11 +9,17 @@

Suspends / pauses execution of the current event handler instance for the requested amount of microseconds. The paused event handler instance can also be resumed before - the requested amount times elapsed by calling stop_wait() from another + the requested amount times elapsed by calling stop_wait() from another event handler instance.

+

+ The ??duration-us?? argument must neither + be negative nor zero, otherwise script execution will be aborted, because this + is a common indication of bugs in scripts which could potentially lead to + real-time instability or worse scenarios otherwise. +

- If the even handler instance's built-in variable $NKSP_IGNORE_WAIT + If the event handler instance's built-in variable $NKSP_IGNORE_WAIT reflects 1 then all calls to wait() will be ignored. This might for example be the case when stop_wait() with 1 being passed to the 2nd argument of that function. @@ -32,17 +38,29 @@ ??duration-us?? - Integer Number - Amount of microseconds to pause execution.
+ Integer Number or
+ Real Number + Positive (non zero) amount of microseconds to pause execution.
[required] - +

Return Value

None.

- + +

Remarks

+

+ This functions optionally accepts s as standard unit + for its argument ??duration-us??. +

+

Examples

-

+

+ The following example resembles a simple delay effect. For each note + being triggered by the musician, the script launches additional notes, + each one of such additional successive notes with a more and more reduced + volume. +

on init { The amount of notes to play } @@ -94,5 +112,8 @@ miliseconds, no matter which function argument you provided.
+

See also

+

stop_wait()

+