/[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 2944 by schoenebeck, Wed Jul 13 16:52:58 2016 UTC revision 3215 by schoenebeck, Thu May 25 15:08:50 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">dec()</code></td>
32            <td>Decrements the passed integer variable by one.</td>
33          </tr>
34          <tr>
35            <td><code>inc()</code></td>
36            <td>Increments the passed integer variable by one.</td>
37          </tr>
38          <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 40  Line 52 
52          <td>Pauses execution for a certain amount of time.</td>          <td>Pauses execution for a certain amount of time.</td>
53        </tr>        </tr>
54        <tr>        <tr>
55            <td><code>stop_wait()</code></td>
56            <td>Resumes execution of a suspended script callback.</td>
57          </tr>
58          <tr>
59          <td><code>abs()</code></td>          <td><code>abs()</code></td>
60          <td>Calculates the absolute value of a given value.</td>          <td>Calculates the absolute value of a given value.</td>
61        </tr>        </tr>
# Line 48  Line 64 
64          <td>Random number generator.</td>          <td>Random number generator.</td>
65        </tr>        </tr>
66        <tr>        <tr>
67            <td><code>min()</code></td>
68            <td>Calculates the minimum value of two given values.</td>
69          </tr>
70          <tr>
71            <td><code>max()</code></td>
72            <td>Calculates the maximum value of two given values.</td>
73          </tr>
74          <tr>
75          <td><code>num_elements()</code></td>          <td><code>num_elements()</code></td>
76          <td>Returns the size of the requested array variable.</td>          <td>Returns the size of the requested array variable.</td>
77        </tr>        </tr>
78          <tr>
79            <td><code>sh_left()</code></td>
80            <td>Calculates a left bit shifted value.</td>
81          </tr>
82          <tr>
83            <td><code>sh_right()</code></td>
84            <td>Calculates a right bit shifted value.</td>
85          </tr>
86      </table>      </table>
87            
88      <h3>Common Sampler Functions</h3>      <h3>Common Sampler Functions</h3>
# Line 67  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 75  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 87  Line 131 
131          <td>Changes filter resonance of voices.</td>          <td>Changes filter resonance of voices.</td>
132        </tr>        </tr>
133        <tr>        <tr>
134            <td><code>change_attack()</code></td>
135            <td>Modifies the attack time of voices.</td>
136          </tr>
137          <tr>
138            <td><code>change_decay()</code></td>
139            <td>Modifies the decay time of voices.</td>
140          </tr>
141          <tr>
142            <td><code>change_release()</code></td>
143            <td>Modifies the release time of voices.</td>
144          </tr>
145          <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 224  Line 316 
316              </note>              </note>
317          </td>          </td>
318        </tr>        </tr>
319          <tr>
320            <td><code>$NI_CALLBACK_ID</code></td>
321            <td>Reflects the current event handler instance's unique callback ID.
322                For the same event type there may be more than
323                one event handler instances running. Each one of them has
324                its own callback ID. You can get the current event handler
325                instance's callback ID by reading this built-in variable.</td>
326          </tr>
327          <tr>
328            <td><code>$NI_CALLBACK_TYPE</code></td>
329            <td>Reflects the event type of the current event handler. This variable
330                may reflect one of the following built-in constants:
331                <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
332                <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
333          </tr>
334          <tr>
335            <td><code>$NI_CB_TYPE_INIT</code></td>
336            <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
337          </tr>
338          <tr>
339            <td><code>$NI_CB_TYPE_NOTE</code></td>
340            <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
341          </tr>
342          <tr>
343            <td><code>$NI_CB_TYPE_RELEASE</code></td>
344            <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
345          </tr>
346          <tr>
347            <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
348            <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
349          </tr>
350          <tr>
351            <td><code>$NKSP_IGNORE_WAIT</code></td>
352            <td>If this boolean built-in variable is <code>1</code> then all calls of your
353                event handler instance to function <code>wait()</code> will be ignored.
354                This may for example be the case if another event handler instance
355                resumed your paused script by calling <code>stop_wait()</code> and
356                passing <code>1</code> to the 2nd argument of that function.</td>
357          </tr>
358      </table>      </table>
359    
360      <h3>Common Sampler Variables</h3>      <h3>Common Sampler Variables</h3>
# Line 236  Line 367 
367          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
368        </tr>        </tr>
369        <tr>        <tr>
370            <td><code>%ALL_EVENTS</code></td>
371            <td>
372              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>.
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>
378                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
380                <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
381                parser warning, the behavior will be the same though.
382              </note>
383            </td>
384          </tr>
385          <tr>
386          <td><code>$CC_NUM</code></td>          <td><code>$CC_NUM</code></td>
387          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
388              handler to be executed (only useful in the context of a              handler to be executed (only useful in the context of a
# Line 281  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.2944  
changed lines
  Added in v.3215
  ViewVC Help
Powered by ViewVC