note_off()

Releases a note by passing the note's event ID to this function. This is almost like sending a MIDI note off event programmatically, however a call to this function will only affect one single note instead.

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.

There is also an ignore_event() function. With NKSP the two functions are both doing the same thing though. The two exist merely due to compatibility reasons with KSP.

Function Prototype

note_off(??event-id??, [??velocity??])

Arguments

Argument Name Data Type Description
??event-id?? Event ID Number or Event ID Array Event ID(s) of the note(s) to be released.
[required]
??velocity?? Integer Number MIDI note off velocity value.
[optional, default: 127]

Return Value

None.

Examples

None yet.

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. The second argument of this function ??velocity?? is only supported by NKSP. If you want to keep compatibility with KSP, then you should only pass one argument to this function.