/[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 2971 by schoenebeck, Thu Jul 21 16:35:07 2016 UTC revision 3194 by schoenebeck, Sat May 20 13:37:20 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 103  Line 107 
107          <td>Changes the tuning of voices.</td>          <td>Changes the tuning of voices.</td>
108        </tr>        </tr>
109        <tr>        <tr>
110            <td><code>change_tune_time()</code></td>
111            <td>Changes the duration of tuning changes.</td>
112          </tr>
113          <tr>
114          <td><code>change_vol()</code></td>          <td><code>change_vol()</code></td>
115          <td>Changes the volume of voices.</td>          <td>Changes the volume of voices.</td>
116        </tr>        </tr>
117        <tr>        <tr>
118            <td><code>change_vol_time()</code></td>
119            <td>Changes the duration of volume changes.</td>
120          </tr>
121          <tr>
122          <td><code>change_cutoff()</code></td>          <td><code>change_cutoff()</code></td>
123          <td>Changes filter cutoff frequency of voices.</td>          <td>Changes filter cutoff frequency of voices.</td>
124        </tr>        </tr>
# Line 127  Line 139 
139          <td>Modifies the release time of voices.</td>          <td>Modifies the release time of voices.</td>
140        </tr>        </tr>
141        <tr>        <tr>
142            <td><code>change_amp_lfo_depth()</code></td>
143            <td>Modifies the amplitude LFO depth.</td>
144          </tr>
145          <tr>
146            <td><code>change_amp_lfo_freq()</code></td>
147            <td>Modifies the amplitude LFO frequency.</td>
148          </tr>
149          <tr>
150            <td><code>change_pitch_lfo_depth()</code></td>
151            <td>Modifies the pitch LFO depth.</td>
152          </tr>
153          <tr>
154            <td><code>change_pitch_lfo_freq()</code></td>
155            <td>Modifies the pitch LFO frequency.</td>
156          </tr>
157          <tr>
158          <td><code>event_status()</code></td>          <td><code>event_status()</code></td>
159          <td>Checks and returns whether a particular note is still alive.</td>          <td>Checks and returns whether a particular note is still alive.</td>
160        </tr>        </tr>
161        <tr>        <tr>
162            <td><code>fade_in()</code></td>
163            <td>Fade the requested note in.</td>
164          </tr>
165          <tr>
166            <td><code>fade_out()</code></td>
167            <td>Fade the requested note out.</td>
168          </tr>
169          <tr>
170            <td><code>get_event_par()</code></td>
171            <td>Get the current value of a specific note parameter.</td>
172          </tr>
173          <tr>
174            <td><code>set_event_par()</code></td>
175            <td>Change the value of a specific note parameter.</td>
176          </tr>
177          <tr>
178          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
179          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
180        </tr>        </tr>
# Line 315  Line 359 
359          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
360        </tr>        </tr>
361        <tr>        <tr>
362            <td><code>%ALL_EVENTS</code></td>
363            <td>
364              Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
365              This may be passed to many built-in functions like <code>note_off()</code>.
366              This array variable only contains IDs of notes which were launched due
367              to MIDI note-on events. This variable does not contain IDs of child notes
368              (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
369              <note>
370                In contrast to KSP this variable is an integer array type, whereas KSP's
371                pendent of this built-in variable is an integer constant (scalar) called
372                <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
373                parser warning, the behavior will be the same though.
374              </note>
375            </td>
376          </tr>
377          <tr>
378          <td><code>$CC_NUM</code></td>          <td><code>$CC_NUM</code></td>
379          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
380              handler to be executed (only useful in the context of a              handler to be executed (only useful in the context of a
# Line 360  Line 420 
420              note is still "alive".</td>              note is still "alive".</td>
421        </tr>        </tr>
422        <tr>        <tr>
423            <td><code>$EVENT_PAR_NOTE</code></td>
424            <td>Constant value symbolizing the "note number" parameter. See
425                <code>get_event_par()</code> and <code>set_event_par()</code>
426                for details.</td>
427          </tr>
428          <tr>
429            <td><code>$EVENT_PAR_TUNE</code></td>
430            <td>Constant value symbolizing the "tune" parameter. See
431                <code>get_event_par()</code> and <code>set_event_par()</code>
432                for details.</td>
433          </tr>
434          <tr>
435            <td><code>$EVENT_PAR_VELOCITY</code></td>
436            <td>Constant value symbolizing the "note velocity" parameter. See
437                <code>get_event_par()</code> and <code>set_event_par()</code>
438                for details.</td>
439          </tr>
440          <tr>
441            <td><code>$EVENT_PAR_VOLUME</code></td>
442            <td>Constant value symbolizing the "volume" parameter. See
443                <code>get_event_par()</code> and <code>set_event_par()</code>
444                for details.</td>
445          </tr>
446          <tr>
447            <td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td>
448            <td>Four constant values symbolizing the 4 possible user specific
449                parameters, which i.e. might be used to pass data from one script
450                (slot) to another script (slot). See  <code>get_event_par()</code>
451                and <code>set_event_par()</code> for details.</td>
452          </tr>
453          <tr>
454          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
455          <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
456              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.2971  
changed lines
  Added in v.3194
  ViewVC Help
Powered by ViewVC