--- doc/docbase/instrument_scripts/nksp/reference/functions/nksp_ignore_event_function.html 2017/05/25 13:17:47 3212 +++ doc/docbase/instrument_scripts/nksp/reference/functions/nksp_ignore_event_function.html 2017/05/25 13:25:43 3213 @@ -14,6 +14,12 @@ they can cause any sound to be changed.

+ The argument this function takes is optional. If you omit passing an + argument to this function, then the event ID will be used that + caused this current event handler to be executed + (which is $EVENT_ID). +

+

Dropping events with this function only succeeds if the event just "recently" occurred. That effectively means you should drop the event in the respective event handler before any wait() calls, and before @@ -34,7 +40,7 @@

Function Prototype

-ignore_event(??event-id??) +ignore_event([??event-id??])

Arguments

@@ -46,7 +52,7 @@ ??event-id?? Event ID Number or Event ID Array Event ID(s) of the MIDI event(s) to be dropped.
- [required] + [optional, default: ID of the event handler's event] @@ -95,7 +101,11 @@ Passing an array of event IDs is only supported by NKSP. If you want to keep compatibility to KSP, then you should only pass a single - event ID to this function. + event ID to this function.
+
+ Same applies to the optional argument: Dynamic, optional arguments are + only supported by NKSP. If you want to retain compatibility to KSP, + then you should always pass a parameter to this function.