Drops the given MIDI control change 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 control change events, before they are causing any sound to be changed.
The argument this function takes is optional. If you omit passing an
argument to this function, then the controller event ID will be used that
caused this current controller
event handler to be executed.
Dropping control change events with this function only succeeds if the
event just "recently" occurred. That effectively means you should drop
the control change event in the controller
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 control change event may already
have entered the sampler's regular event processing chain and thus can no
longer be dropped.
With NKSP you can also use ignore_event()
to drop control
change events. So ignore_controller()
merely exists due to
compatibility reasons with KSP. However when you already know that the
event to be dropped is a control change event, then it is recommended to
actually call ignore_controller()
instead of
ignore_event()
.
ignore_controller([??event-id??])
Argument Name | Data Type | Description |
---|---|---|
??event-id?? |
Event ID Number | MIDI control change event to be dropped. [optional, default: ID of the event handler's event] |
None.
None yet.