Writing Docs Gigedit SFZ Instrument Scripts NKSP Language NKSP Reference


This function can be used to change the current value of a certain parameter of the requested note. If the passed note ID is invalid or if the requested note is no longer alive, then this function does nothing.

You might use function get_event_par() to retrieve the current value of those parameters.

Function Prototype

set_event_par(note, parameter, value)


Argument Name Data Type Description
note Note ID Number or Note ID Array The note whose current parameter shall be changed.
parameter Integer Number The actual parameter whose value should be modified. This must be one of the following built-in constants:
$EVENT_PAR_NOTE: Change the note's MIDI note number (only possible when note is new; equivalent to change_note()).
$EVENT_PAR_TUNE: Change the note's tuning in milli cents (currently ignored, use change_tune() instead).
$EVENT_PAR_VELOCITY: Change the note's MIDI note velocity (only possible when note is new; equivalent to change_velo()).
$EVENT_PAR_VOLUME: Change the note's volume (currently ignored, use change_vol() instead).
$EVENT_PAR_0 to $EVENT_PAR_3: To change the current value of one of the 4 available user specific parameters. Those user parameters are not used by the sampler itself, they can be used by the script author to pass data from one script (slot) to another script (slot) for example, or as an alternative to polyphonic variables.
value Integer Number The new value to set for the selected parameter. The precise value range and meaning differs and depends on the respective parameter (see description of argument parameter above).

Return Value



None yet.

See also

get_event_par(), change_vol(), change_tune(), change_note(), change_velo()


Since LinuxSampler 2.0.0.svn46.

Document Updated:  2017-05-25  |  Author:  Christian Schoenebeck