/[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 3223 by schoenebeck, Fri May 26 19:14:44 2017 UTC
# Line 28  Line 28 
28          <th>Function</th> <th>Description</th>          <th>Function</th> <th>Description</th>
29        </tr>        </tr>
30        <tr>        <tr>
31            <td><code lang="nksp">array_equal()</code></td>
32            <td>Check whether two arrays are equal.</td>
33          </tr>
34          <tr>
35          <td><code lang="nksp">dec()</code></td>          <td><code lang="nksp">dec()</code></td>
36          <td>Decrements the passed integer variable by one.</td>          <td>Decrements the passed integer variable by one.</td>
37        </tr>        </tr>
# Line 36  Line 40 
40          <td>Increments the passed integer variable by one.</td>          <td>Increments the passed integer variable by one.</td>
41        </tr>        </tr>
42        <tr>        <tr>
43            <td><code>in_range()</code></td>
44            <td>Checks whether a value is between two other values.</td>
45          </tr>
46          <tr>
47          <td><code lang="nksp">message()</code></td>          <td><code lang="nksp">message()</code></td>
48          <td>Prints text to the sampler's terminal.</td>          <td>Prints text to the sampler's terminal.</td>
49        </tr>        </tr>
50        <tr>        <tr>
51            <td><code>search()</code></td>
52            <td>Search for a certain value within an array.</td>
53          </tr>
54          <tr>
55            <td><code>sort()</code></td>
56            <td>Sort the given array.</td>
57          </tr>
58          <tr>
59          <td><code>exit()</code></td>          <td><code>exit()</code></td>
60          <td>Stops execution of the current event handler instance.</td>          <td>Stops execution of the current event handler instance.</td>
61        </tr>        </tr>
# Line 95  Line 111 
111          <td>Triggers a new note.</td>          <td>Triggers a new note.</td>
112        </tr>        </tr>
113        <tr>        <tr>
114            <td><code>change_note()</code></td>
115            <td>Change MIDI note number of note.</td>
116          </tr>
117          <tr>
118          <td><code>change_pan()</code></td>          <td><code>change_pan()</code></td>
119          <td>Changes panning of voices (stereo balance).</td>          <td>Changes panning of voices (stereo balance).</td>
120        </tr>        </tr>
# Line 103  Line 123 
123          <td>Changes the tuning of voices.</td>          <td>Changes the tuning of voices.</td>
124        </tr>        </tr>
125        <tr>        <tr>
126            <td><code>change_tune_time()</code></td>
127            <td>Changes the duration of tuning changes.</td>
128          </tr>
129          <tr>
130          <td><code>change_vol()</code></td>          <td><code>change_vol()</code></td>
131          <td>Changes the volume of voices.</td>          <td>Changes the volume of voices.</td>
132        </tr>        </tr>
133        <tr>        <tr>
134            <td><code>change_vol_time()</code></td>
135            <td>Changes the duration of volume changes.</td>
136          </tr>
137          <tr>
138          <td><code>change_cutoff()</code></td>          <td><code>change_cutoff()</code></td>
139          <td>Changes filter cutoff frequency of voices.</td>          <td>Changes filter cutoff frequency of voices.</td>
140        </tr>        </tr>
# Line 127  Line 155 
155          <td>Modifies the release time of voices.</td>          <td>Modifies the release time of voices.</td>
156        </tr>        </tr>
157        <tr>        <tr>
158            <td><code>change_amp_lfo_depth()</code></td>
159            <td>Modifies the amplitude LFO depth.</td>
160          </tr>
161          <tr>
162            <td><code>change_amp_lfo_freq()</code></td>
163            <td>Modifies the amplitude LFO frequency.</td>
164          </tr>
165          <tr>
166            <td><code>change_pitch_lfo_depth()</code></td>
167            <td>Modifies the pitch LFO depth.</td>
168          </tr>
169          <tr>
170            <td><code>change_pitch_lfo_freq()</code></td>
171            <td>Modifies the pitch LFO frequency.</td>
172          </tr>
173          <tr>
174            <td><code>change_velo()</code></td>
175            <td>Change MIDI velocity of note.</td>
176          </tr>
177          <tr>
178          <td><code>event_status()</code></td>          <td><code>event_status()</code></td>
179          <td>Checks and returns whether a particular note is still alive.</td>          <td>Checks and returns whether a particular note is still alive.</td>
180        </tr>        </tr>
181        <tr>        <tr>
182            <td><code>fade_in()</code></td>
183            <td>Fade the requested note in.</td>
184          </tr>
185          <tr>
186            <td><code>fade_out()</code></td>
187            <td>Fade the requested note out.</td>
188          </tr>
189          <tr>
190            <td><code>get_event_par()</code></td>
191            <td>Get the current value of a specific note parameter.</td>
192          </tr>
193          <tr>
194            <td><code>set_event_par()</code></td>
195            <td>Change the value of a specific note parameter.</td>
196          </tr>
197          <tr>
198          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
199          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
200        </tr>        </tr>
# Line 315  Line 379 
379          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
380        </tr>        </tr>
381        <tr>        <tr>
382            <td><code>%ALL_EVENTS</code></td>
383            <td>
384              Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
385              This may be passed to many built-in functions like <code>note_off()</code>.
386              This array variable only contains IDs of notes which were launched due
387              to MIDI note-on events. This variable does not contain IDs of child notes
388              (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
389              <note>
390                In contrast to KSP this variable is an integer array type, whereas KSP's
391                pendent of this built-in variable is an integer constant (scalar) called
392                <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
393                parser warning, the behavior will be the same though.
394              </note>
395            </td>
396          </tr>
397          <tr>
398          <td><code>$CC_NUM</code></td>          <td><code>$CC_NUM</code></td>
399          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
400              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 440 
440              note is still "alive".</td>              note is still "alive".</td>
441        </tr>        </tr>
442        <tr>        <tr>
443            <td><code>$EVENT_PAR_NOTE</code></td>
444            <td>Constant value symbolizing the "note number" 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_TUNE</code></td>
450            <td>Constant value symbolizing the "tune" 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_VELOCITY</code></td>
456            <td>Constant value symbolizing the "note velocity" parameter. See
457                <code>get_event_par()</code> and <code>set_event_par()</code>
458                for details.</td>
459          </tr>
460          <tr>
461            <td><code>$EVENT_PAR_VOLUME</code></td>
462            <td>Constant value symbolizing the "volume" parameter. See
463                <code>get_event_par()</code> and <code>set_event_par()</code>
464                for details.</td>
465          </tr>
466          <tr>
467            <td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td>
468            <td>Four constant values symbolizing the 4 possible user specific
469                parameters, which i.e. might be used to pass data from one script
470                (slot) to another script (slot). See  <code>get_event_par()</code>
471                and <code>set_event_par()</code> for details.</td>
472          </tr>
473          <tr>
474          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
475          <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
476              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.3223
  ViewVC Help
Powered by ViewVC