/[svn]/doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html
ViewVC logotype

Diff of /doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3075 by schoenebeck, Thu Jan 5 16:36:16 2017 UTC revision 3215 by schoenebeck, Thu May 25 15:08:50 2017 UTC
# Line 36  Line 36 
36          <td>Increments the passed integer variable by one.</td>          <td>Increments the passed integer variable by one.</td>
37        </tr>        </tr>
38        <tr>        <tr>
39            <td><code>in_range()</code></td>
40            <td>Checks whether a value is between two other values.</td>
41          </tr>
42          <tr>
43          <td><code lang="nksp">message()</code></td>          <td><code lang="nksp">message()</code></td>
44          <td>Prints text to the sampler's terminal.</td>          <td>Prints text to the sampler's terminal.</td>
45        </tr>        </tr>
# Line 95  Line 99 
99          <td>Triggers a new note.</td>          <td>Triggers a new note.</td>
100        </tr>        </tr>
101        <tr>        <tr>
102            <td><code>change_note()</code></td>
103            <td>Change MIDI note number of note.</td>
104          </tr>
105          <tr>
106          <td><code>change_pan()</code></td>          <td><code>change_pan()</code></td>
107          <td>Changes panning of voices (stereo balance).</td>          <td>Changes panning of voices (stereo balance).</td>
108        </tr>        </tr>
# Line 103  Line 111 
111          <td>Changes the tuning of voices.</td>          <td>Changes the tuning of voices.</td>
112        </tr>        </tr>
113        <tr>        <tr>
114            <td><code>change_tune_time()</code></td>
115            <td>Changes the duration of tuning changes.</td>
116          </tr>
117          <tr>
118          <td><code>change_vol()</code></td>          <td><code>change_vol()</code></td>
119          <td>Changes the volume of voices.</td>          <td>Changes the volume of voices.</td>
120        </tr>        </tr>
121        <tr>        <tr>
122            <td><code>change_vol_time()</code></td>
123            <td>Changes the duration of volume changes.</td>
124          </tr>
125          <tr>
126          <td><code>change_cutoff()</code></td>          <td><code>change_cutoff()</code></td>
127          <td>Changes filter cutoff frequency of voices.</td>          <td>Changes filter cutoff frequency of voices.</td>
128        </tr>        </tr>
# Line 127  Line 143 
143          <td>Modifies the release time of voices.</td>          <td>Modifies the release time of voices.</td>
144        </tr>        </tr>
145        <tr>        <tr>
146            <td><code>change_amp_lfo_depth()</code></td>
147            <td>Modifies the amplitude LFO depth.</td>
148          </tr>
149          <tr>
150            <td><code>change_amp_lfo_freq()</code></td>
151            <td>Modifies the amplitude LFO frequency.</td>
152          </tr>
153          <tr>
154            <td><code>change_pitch_lfo_depth()</code></td>
155            <td>Modifies the pitch LFO depth.</td>
156          </tr>
157          <tr>
158            <td><code>change_pitch_lfo_freq()</code></td>
159            <td>Modifies the pitch LFO frequency.</td>
160          </tr>
161          <tr>
162            <td><code>change_velo()</code></td>
163            <td>Change MIDI velocity of note.</td>
164          </tr>
165          <tr>
166          <td><code>event_status()</code></td>          <td><code>event_status()</code></td>
167          <td>Checks and returns whether a particular note is still alive.</td>          <td>Checks and returns whether a particular note is still alive.</td>
168        </tr>        </tr>
169        <tr>        <tr>
170            <td><code>fade_in()</code></td>
171            <td>Fade the requested note in.</td>
172          </tr>
173          <tr>
174            <td><code>fade_out()</code></td>
175            <td>Fade the requested note out.</td>
176          </tr>
177          <tr>
178            <td><code>get_event_par()</code></td>
179            <td>Get the current value of a specific note parameter.</td>
180          </tr>
181          <tr>
182            <td><code>set_event_par()</code></td>
183            <td>Change the value of a specific note parameter.</td>
184          </tr>
185          <tr>
186          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
187          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
188        </tr>        </tr>
# Line 319  Line 371 
371          <td>          <td>
372            Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).            Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
373            This may be passed to many built-in functions like <code>note_off()</code>.            This may be passed to many built-in functions like <code>note_off()</code>.
374              This array variable only contains IDs of notes which were launched due
375              to MIDI note-on events. This variable does not contain IDs of child notes
376              (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
377            <note>            <note>
378              In contrast to KSP this variable is an integer array type, whereas KSP's              In contrast to KSP this variable is an integer array type, whereas KSP's
379              pendent of this built-in variable is an integer constant (scalar) called              pendent of this built-in variable is an integer constant (scalar) called
# Line 373  Line 428 
428              note is still "alive".</td>              note is still "alive".</td>
429        </tr>        </tr>
430        <tr>        <tr>
431            <td><code>$EVENT_PAR_NOTE</code></td>
432            <td>Constant value symbolizing the "note number" parameter. See
433                <code>get_event_par()</code> and <code>set_event_par()</code>
434                for details.</td>
435          </tr>
436          <tr>
437            <td><code>$EVENT_PAR_TUNE</code></td>
438            <td>Constant value symbolizing the "tune" parameter. See
439                <code>get_event_par()</code> and <code>set_event_par()</code>
440                for details.</td>
441          </tr>
442          <tr>
443            <td><code>$EVENT_PAR_VELOCITY</code></td>
444            <td>Constant value symbolizing the "note velocity" parameter. See
445                <code>get_event_par()</code> and <code>set_event_par()</code>
446                for details.</td>
447          </tr>
448          <tr>
449            <td><code>$EVENT_PAR_VOLUME</code></td>
450            <td>Constant value symbolizing the "volume" parameter. See
451                <code>get_event_par()</code> and <code>set_event_par()</code>
452                for details.</td>
453          </tr>
454          <tr>
455            <td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td>
456            <td>Four constant values symbolizing the 4 possible user specific
457                parameters, which i.e. might be used to pass data from one script
458                (slot) to another script (slot). See  <code>get_event_par()</code>
459                and <code>set_event_par()</code> for details.</td>
460          </tr>
461          <tr>
462          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
463          <td>This can be used in any context to check whether a certain MIDI          <td>This can be used in any context to check whether a certain MIDI
464              key is currently pressed down. Use the respective MIDI note number              key is currently pressed down. Use the respective MIDI note number
Legend:
Removed from v.3075  
changed lines
  Added in v.3215
  ViewVC Help
Powered by ViewVC