Drops the given event and thus prevents the supplied event to be further processed by the sampler. You can use this function i.e. to filter out MIDI note on and MIDI note off events, before they are causing new notes to be triggered, or to drop certain MIDI control change events before they can cause any sound to be changed.
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
entering any loops that may execute your script for a very long time.
Because in both cases the sampler may suspend your script for a certain
amount of time and once your script got resumed, the respective event may
already have entered the sampler's regular event processing chain and
thus can no longer be dropped.
There is also an
intended for explicitly dropping control change events. With NKSP you
you can also use
ignore_event() though to
drop control change events. So
merely exists due to compatibility reasons with KSP.
|Argument Name||Data Type||Description|
||Event ID Number or Event ID Array||MIDI event(s) to be dropped.